sp_syscollector_create_collector_type (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Creates a collector type for the data collector. A collector type is a logical wrapper around the SSIS packages that provide the actual mechanism for collecting data and uploading it to the management data warehouse.

Topic link icon Transact-SQL Syntax Conventions


    [ [@collector_type_uid = ] 'collector_type_uid' OUTPUT ]  
    , [ @name = ] 'name'  
    , [ [ @parameter_schema = ] 'parameter_schema' ]  
    , [ [ @parameter_formatter = ] 'parameter_formatter' ]  
    , [ @collection_package_id = ] 'collection_package_id'  
    , [ @upload_package_id = ] 'upload_package_id'  


[ @collector_type_uid = ] 'collector_type_uid'
Is the GUID for the collector type. collector_type_uid is uniqueidentifier and if it is NULL it will be automatically created and returned as OUTPUT.

[ @name = ] 'name'
Is the name of the collector type. name is sysname and must be specified.

[ @parameter_schema = ] 'parameter_schema'
Is the XML schema for this collector type. parameter_schema is xml with a default of NULL.

[ @parameter_formatter = ] 'parameter_formatter'
Is the template to use to transform the XML for use in the collection set property page. parameter_formatter is xml with a default of NULL.

[@collection_package_id = ] collection_package_id
Is a local unique identifier that points to the SSIS collection package used by the collection set. collection_package_id is uniqueidentifer and is required.

[@upload_package_id = ] upload_package_id
Is a local unique identifier that points to the SSIS upload package used by the collection set. upload_package_id is uniqueidentifier and is required.

Return Code Values

0 (success) or 1 (failure)


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


This creates the Generic T-SQL Query collector type.

EXEC sp_syscollector_create_collector_type  
@collector_type_uid = '302E93D1-3424-4be7-AA8E-84813ECF2419',  
@name = 'Generic T-SQL Query Collector Type',  
@parameter_schema = '<?xml version="1.0" encoding="utf-8"?>  
  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="DataCollectorType">  
    <xs:element name="TSQLQueryCollector">  
          <xs:element name="Query" minOccurs="1" maxOccurs="unbounded">  
                <xs:element name="Value" type="xs:string" />  
                <xs:element name="OutputTable" type="xs:string" />  
          <xs:element name="Databases" minOccurs="0" maxOccurs="1">  
                <xs:element name="Database" minOccurs="0" maxOccurs="unbounded" type="xs:string" />  
              <xs:attribute name="UseSystemDatabases" type="xs:boolean" use="optional" />  
              <xs:attribute name="UseUserDatabases" type="xs:boolean" use="optional" />  
@collection_package_id = '292B1476-0F46-4490-A9B7-6DB724DE3C0B',  
@upload_package_id = '6EB73801-39CF-489C-B682-497350C939F0';  

See Also

System Stored Procedures (Transact-SQL)
Data Collection