sp_syscollector_update_collector_type (Transact-SQL)

项目
12/22/2023

为收集项更新收集器类型。给定收集器类型的名称和 GUID，更新收集器类型配置，包括集合和上传包、参数架构和参数格式化程序架构。

语法

sp_syscollector_update_collector_type
    [ [ @collector_type_uid = ] 'collector_type_uid' ]
    [ , [ @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'

收集器类型的 GUID。 @collector_type_uid是 uniqueidentifier，如果是NULL，则会自动创建@collector_type_uid并将其作为 OUTPUT 返回。

[ @name = ] N'name'

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

[ @parameter_schema = ] N'parameter_schema'

此收集器类型的 XML 架构。 @parameter_schema为 xml，默认值NULL为 xml，并且某些收集器类型可能是必需的。如果不需要此参数，则此参数可以是 NULL。

[ @parameter_formatter = ] N'parameter_formatter'

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

[ @collection_package_id = ] 'collection_package_id'

指向集合集使用的 SSIS 集合包的本地唯一标识符。 @collection_package_id 是 uniqueidentifier，没有默认值，并且是必需的。若要获取@collection_package_id的值，请查询数据库中的dbo.syscollector_collector_types系统视图msdb。

[ @upload_package_id = ] 'upload_package_id'

指向集合集使用的 SSIS 上传包的本地唯一标识符。 @upload_package_id 是 uniqueidentifier，没有默认值，并且是必需的。若要获取@upload_package_id的值，请查询数据库中dbo.syscollector_collector_types系统视图msdb。

返回代码值

0（成功）或 1（失败）。

权限

要求dc_admin（具有 EXECUTE 权限）固定数据库角色的成员身份。

示例

此示例更新一般 T-SQL 查询收集器类型。（在此示例中，使用一般 T-SQL 查询收集器类型的默认架构。）

USE msdb;
GO

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