sp_syscollector_create_collector_type (Transact-SQL)

Article
12/22/2023

S’applique à :SQL Server

Crée un type de collecteur pour le collecteur de données. Un type de collecteur est un wrapper logique autour des packages SSIS qui fournissent le mécanisme réel permettant de collecter des données et de les charger dans l’entrepôt de données de gestion.

Conventions de la syntaxe Transact-SQL

Syntaxe

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'
[ ; ]

Arguments

[ @collector_type_uid = ] SORTIE 'collector_type_uid'

GUID pour le type de collecteur. @collector_type_uid est un paramètre OUTPUT de type uniqueidentifier. Si @collector_type_uid’ilNULL est automatiquement créé et retourné en tant que OUTPUT.

[ @name = ] N’name'

Nom du type de collecteur. @name est sysname et doit être spécifié.

[ @parameter_schema = ] N’parameter_schema'

Schéma XML pour ce type de collecteur. @parameter_schema est xml, avec la valeur par défaut NULL.

[ @parameter_formatter = ] N’parameter_formatter'

Modèle à utiliser pour transformer le code XML à utiliser dans la page de propriétés du jeu de collections. @parameter_formatter est xml, avec la valeur par défaut NULL.

[ @collection_package_id = ] 'collection_package_id'

Identificateur unique local qui pointe vers le package de collection SSIS utilisé par le jeu de collections. @collection_package_id est uniqueidentifier et est obligatoire.

[ @upload_package_id = ] 'upload_package_id'

Identificateur unique local qui pointe vers le package de chargement SSIS utilisé par le jeu de collections. @upload_package_id est uniqueidentifier et est obligatoire.

Valeurs des codes de retour

0 (réussite) ou 1 (échec).

Autorisations

Nécessite l’appartenance au rôle de base de données fixe dc_admin (avec l’autorisation EXECUTE) pour exécuter cette procédure.

Exemples

Cet exemple crée le type de collecteur de requêtes T-SQL générique.

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