sp_syscollector_create_collection_item (Transact-SQL)

Aplica-se a: SQL Server

Cria um item de coleção num conjunto de coleções definido pelo utilizador. Um item de recolha define os dados a recolher e a frequência com que os dados são recolhidos.

Transact-SQL convenções de sintaxe

Syntax

dbo.sp_syscollector_create_collection_item
    [ @collection_set_id = ] collection_set_id
    , [ @collector_type_uid = ] 'collector_type_uid'
    , [ @name = ] N'name'
    [ , [ @frequency = ] frequency ]
    [ , [ @parameters = ] N'parameters' ]
    , [ @collection_item_id = ] collection_item_id OUTPUT
[ ; ]

Arguments

[ @collection_set_id = ] collection_set_id

O identificador local único para o conjunto de coleções. @collection_set_id é int, sem padrão.

[ @collector_type_uid = ] 'collector_type_uid'

O GUID que identifica o tipo de colecionador a usar para este item. @collector_type_uid é um identificador único, sem padrão. Para uma lista de tipos de colecionadores, consulte a vista do syscollector_collector_types sistema.

[ @name = ] N'nome'

O nome do item da coleção. @name é sysname e não pode ser uma string vazia ou NULL.

@name deve ser único. Para uma lista dos nomes atuais dos itens da coleção, consulte a vista do syscollector_collection_items sistema.

[ @frequency = ] frequência

Usado para especificar (em segundos) com que frequência este item de recolha recolhe dados. @frequency é int, com um padrão de 5. O valor mínimo que pode ser especificado é de 5 segundos.

Se o conjunto de recolha estiver definido para modo não armazenado em cache, a frequência é ignorada, pois este modo faz com que tanto a recolha como o carregamento de dados ocorram no calendário especificado para o conjunto de recolha. Para visualizar o modo de coleção do conjunto de coleções, consulte a vista do sistema syscollector_collection_sets .

[ @parameters = ] N'parâmetros'

Os parâmetros de entrada para o tipo de coletor. @parameters é xml, com um padrão de NULL. O esquema @parameters deve corresponder ao esquema de parâmetros do tipo de coletor.

[ @collection_item_id = ] collection_item_id SAÍDA

O identificador único que identifica o item do conjunto de coleções. @collection_item_id é um OUTPUT parâmetro do tipo int.

Valores de código de retorno

0 (sucesso) ou 1 (fracasso).

Remarks

sp_syscollector_create_collection_item deve ser executado no contexto da msdb base de dados do sistema.

O conjunto de coleção ao qual o item de coleção está a ser adicionado deve ser parado antes de ser criado o item de coleção. Itens de coleção não podem ser adicionados a conjuntos de coleção do sistema.

Permissions

Requer a pertença ao papel fixo de base de dados dc_admin (com permissão EXECUTAR) para executar este procedimento.

Examples

O exemplo seguinte cria um item de coleção com base no tipo Generic T-SQL Query Collector Type de coleção e adiciona-o ao conjunto de coleções chamado Simple collection set test 2. Para criar o conjunto de colecções especificado, execute o exemplo B em sp_syscollector_create_collection_set.

USE msdb;
GO

DECLARE @collection_item_id AS INT;

DECLARE @collection_set_id AS INT = (SELECT collection_set_id
                                     FROM syscollector_collection_sets
                                     WHERE name = N'Simple collection set test 2');

DECLARE @collector_type_uid AS UNIQUEIDENTIFIER = (SELECT collector_type_uid
                                                   FROM syscollector_collector_types
                                                   WHERE name = N'Generic T-SQL Query Collector Type');

DECLARE @params AS XML = CONVERT (XML, N'\<ns:TSQLQueryCollector xmlns:ns="DataCollectorType">
            <Query>
                <Value>SELECT * FROM sys.objects</Value>
                <OutputTable>MyOutputTable</OutputTable>
            </Query>
            <Databases>
                <Database> UseSystemDatabases = "true"
                           UseUserDatabases = "true"
                </Database>
            </Databases>
         \</ns:TSQLQueryCollector>');

EXECUTE sp_syscollector_create_collection_item
    @collection_set_id = @collection_set_id,
    @collector_type_uid = @collector_type_uid,
    @name = 'My custom T-SQL query collector item',
    @frequency = 6000,
    @parameters = @params,
    @collection_item_id = @collection_item_id OUTPUT;