sp_syscollector_update_collector_type (Transact-SQL)

適用対象:SQL Server

コレクション項目のコレクター型を更新します。 コレクター型の名前と GUID を指定すると、コレクションとアップロード パッケージ、パラメーター スキーマ、パラメーター フォーマッタ スキーマなど、コレクター型の構成が更新されます。

Transact-SQL 構文表記規則

構文

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コレクター型で必要になる場合があります。 必要でない場合は、この引数を 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 (失敗)。

アクセス許可

(EXECUTE 権限を持つ) dc_admin固定データベース ロールのメンバーシップが必要です。

次の例では、ジェネリック T-SQL Query コレクター型を更新します (この例では、ジェネリック T-SQL Query コレクター型の既定のスキーマを使用しています)。

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