sp_syscollector_create_collector_type (Transact-SQL)

适用于:SQL Server

为数据收集器创建收集器类型。 收集器类型是 SSIS 包的逻辑包装器,它提供用于收集数据并将其上传到管理数据仓库的实际机制。

Transact-SQL 语法约定

语法

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

参数

[ @collector_type_uid = ] 'collector_type_uid' OUTPUT

收集器类型的 GUID。 @collector_type_uid是 uniqueidentifier 类型的 OUTPUT 参数。 如果@collector_type_uidNULL,它将自动创建并作为 OUTPUT 返回。

[ @name = ] N'name'

收集器类型的名称。 @name为 sysname,必须指定。

[ @parameter_schema = ] N'parameter_schema'

此收集器类型的 XML 架构。 @parameter_schema为 xml,默认值为 NULL.

[ @parameter_formatter = ] N'parameter_formatter'

用于转换 XML 的模板,以便在集合集属性页中使用。 @parameter_formatter为 xml,默认值为 NULL.

[ @collection_package_id = ] 'collection_package_id'

指向集合集使用的 SSIS 集合包的本地唯一标识符。 @collection_package_id是 uniqueidentifier,并且是必需的。

[ @upload_package_id = ] 'upload_package_id'

指向集合集使用的 SSIS 上传包的本地唯一标识符。 @upload_package_id是 uniqueidentifier,并且是必需的。

返回代码值

0(成功)或 1(失败)。

权限

要求dc_admin(具有 EXECUTE 权限)固定数据库角色的成员身份才能执行此过程。

示例

此示例创建泛型 T-SQL 查询收集器类型。

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:complexType>
        <xs:sequence>
          <xs:element name="Query" minOccurs="1" maxOccurs="unbounded">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Value" type="xs:string" />
                <xs:element name="OutputTable" type="xs:string" />
              </xs:sequence>
            </xs:complexType>
          </xs:element>
          <xs:element name="Databases" minOccurs="0" maxOccurs="1">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Database" minOccurs="0" maxOccurs="unbounded" type="xs:string" />
              </xs:sequence>
              <xs:attribute name="UseSystemDatabases" type="xs:boolean" use="optional" />
              <xs:attribute name="UseUserDatabases" type="xs:boolean" use="optional" />
            </xs:complexType>
          </xs:element>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:schema>',
    @collection_package_id = '292B1476-0F46-4490-A9B7-6DB724DE3C0B',
    @upload_package_id = '6EB73801-39CF-489C-B682-497350C939F0';
GO