sp_syscollector_create_collector_type (Transact-SQL)

データ コレクターのコレクター型を作成します。 コレクター型は、データの収集および管理データ ウェアハウスへのアップロード用の実際のメカニズムを提供する、SSIS パッケージの論理ラッパーです。

トピック リンク アイコン Transact-SQL 構文表記規則

構文

sp_syscollector_create_collector_type 
    [ [@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'
    コレクター型の GUID を指定します。 collector_type_uid のデータ型は uniqueidentifier で、NULL の場合に自動的に作成され、OUTPUT として返されます。

  • [ @name = ] 'name'
    コレクター型の名前を指定します。 name のデータ型は sysname で、指定する必要があります。

  • [ @parameter\_schema = ] 'parameter_schema'
    このコレクター型の XML スキーマを指定します。 parameter_schema のデータ型は xml で、既定値は NULL です。

  • [ @parameter\_formatter = ] 'parameter_formatter'
    コレクション セットのプロパティ ページで使用するために XML を変換するときのテンプレートです。 parameter_formatter のデータ型は xml で、既定値は NULL です。

  • [@collection_package_id = ] collection_package_id
    コレクション セットで使用される SSIS コレクション パッケージを参照する一意なローカル識別子を指定します。 collection_package_id のデータ型は uniqueidentifer で、必ず指定する必要があります。

  • [@upload_package_id = ] upload_package_id
    コレクション セットで使用される SSIS アップロード パッケージを参照する一意なローカル識別子を指定します。 upload_package_id のデータ型は uniqueidentifier で、必ず指定する必要があります。

リターン コード値

0 (成功) または 1 (失敗)

権限

このプロシージャを実行するには、(EXECUTE 権限を持つ) dc_admin 固定データベース ロールのメンバーシップが必要です。

使用例

ジェネリック T-SQL Query コレクター型を作成します。

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

関連項目

参照

システム ストアド プロシージャ (Transact-SQL)

概念

データ コレクション

変更履歴

変更内容

@collector_type_uid 引数がオプションであることを明記しました。

@parameter_formatter 引数を追加しました。

「例」セクションのコードを更新しました。