Bewerken

Delen via

sp_syscollector_create_collection_item (Transact-SQL)

  • Artikel

Applies to: SQL Server

Creates a collection item in a user-defined collection set. A collection item defines the data to be collected and the frequency with which the data is collected.

Transact-SQL syntax conventions

Syntax

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

The unique local identifier for the collection set. @collection_set_id is int, with no default.

[ @collector_type_uid = ] 'collector_type_uid'

The GUID that identifies the collector type to use for this item. @collector_type_uid is uniqueidentifier, with no default. For a list of collector types, query the syscollector_collector_types system view.

[ @name = ] N'name'

The name of the collection item. @name is sysname and can't be an empty string or NULL.

@name must be unique. For a list of current collection item names, query the syscollector_collection_items system view.

[ @frequency = ] frequency

Used to specify (in seconds) how frequently this collection item collects data. @frequency is int, with a default of 5. The minimum value that can be specified is 5 seconds.

If the collection set is set to non-cached mode, the frequency is ignored, because this mode causes both data collection and upload to occur at the schedule specified for the collection set. To view the collection mode of the collection set, query the syscollector_collection_sets system view.

[ @parameters = ] N'parameters'

The input parameters for the collector type. @parameters is xml, with a default of NULL. The @parameters schema must match the parameters schema of the collector type.

[ @collection_item_id = ] collection_item_id OUTPUT

The unique identifier that identifies the collection set item. @collection_item_id is an OUTPUT parameter of type int.

Return code values

0 (success) or 1 (failure).

Remarks

sp_syscollector_create_collection_item must be run in the context of the msdb system database.

The collection set to which the collection item is being added must be stopped before creating the collection item. Collection items can't be added to system collection sets.

Permissions

Requires membership in the dc_admin (with EXECUTE permission) fixed database role to execute this procedure.

Examples

The following example creates a collection item based on the collection type Generic T-SQL Query Collector Type and adds it to the collection set named Simple collection set test 2. To create the specified collection set, run example B in sp_syscollector_create_collection_set.

USE msdb;
GO

DECLARE @collection_item_id INT;
DECLARE @collection_set_id INT = (
        SELECT collection_set_id
        FROM syscollector_collection_sets
        WHERE name = N'Simple collection set test 2');
DECLARE @collector_type_uid UNIQUEIDENTIFIER = (
        SELECT collector_type_uid
        FROM syscollector_collector_types
        WHERE name = N'Generic T-SQL Query Collector Type');
DECLARE @params 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>');

EXEC 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;

Related content