sp_syscollector_create_collection_set (Transact-SQL)

Article
07/07/2023

S’applique à :SQL Server

Crée un jeu d'éléments de collecte. Vous pouvez utiliser cette procédure stockée afin de créer un jeu d'éléments de collecte personnalisé pour la collecte de données.

Avertissement

Dans les cas où le compte Windows configuré en tant que proxy est non interactif ou correspond à un utilisateur interactif qui ne s'est pas encore connecté, le répertoire de profils n'existera pas et la création du répertoire intermédiaire échouera. Par conséquent, si vous utilisez un compte proxy sur un contrôleur de domaine, vous devez spécifier un compte interactif qui a été utilisé au moins une fois afin de garantir que le répertoire de profils a été créé.

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_syscollector_create_collection_set
    [ @name = ] N'name'
    [ , [ @target = ] N'target' ]
    [ , [ @collection_mode = ] collection_mode ]
    [ , [ @days_until_expiration = ] days_until_expiration ]
    [ , [ @proxy_id = ] proxy_id ]
    [ , [ @proxy_name = ] N'proxy_name' ]
    [ , [ @schedule_uid = ] 'schedule_uid' ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @logging_level = ] logging_level ]
    [ , [ @description = ] N'description' ]
    , [ @collection_set_id = ] collection_set_id OUTPUT
    [ , [ @collection_set_uid = ] 'collection_set_uid' OUTPUT ]
[ ; ]

Arguments

[ @name = ] N’name'

Nom du jeu d'éléments de collecte. @name est sysname et ne peut pas être une chaîne vide ou NULL.

@name doit être unique. Pour obtenir la liste des noms des ensembles de collections actuels, interrogez la syscollector_collection_sets vue système.

[ @target = ] N’target'

Réservé pour un usage futur. @target est nvarchar(128), avec la valeur par défaut .NULL

[ @collection_mode = ] collection_mode

@collection_mode est smallint, avec la valeur par défaut .0

Spécifie la manière dont les données sont recueillies et stockées. @collection_mode est smallint, avec la valeur par défaut 0, et peut avoir l’une des valeurs suivantes :

0: mode mis en cache. La collecte et le téléchargement de données sont sur des planifications séparées. Spécifiez le mode mis en cache pour la collecte continue.
1: mode non mis en cache. La collecte et le chargement des données sont planifiés de la même manière. Spécifiez le mode non mis en cache pour une collecte ad hoc ou par instantané.

Lorsque @collection_mode est 0, @schedule_uid ou @schedule_name doivent être spécifiés.

[ @days_until_expiration = ] days_until_expiration

Nombre de jours pendant lesquels les données collectées sont enregistrées dans l'entrepôt de données de gestion. @days_until_expiration est smallint, avec une valeur par défaut de 730 (deux ans). @days_until_expiration doit être 0 ou un entier positif.

[ @proxy_id = ] proxy_id

Identificateur unique d’un compte proxy SQL Server Agent. @proxy_id est int, avec la valeur par défaut .NULL Si elle est spécifiée, @proxy_name doit être NULL. Pour obtenir @proxy_id, interrogez la sysproxies table système. Le rôle de base de données fixe dc_admin doit avoir l’autorisation d’accéder au proxy. Pour plus d’informations, consultez Créer un proxy SQL Server Agent.

[ @proxy_name = ] N’proxy_name'

Nom du compte proxy. @proxy_name est sysname, avec la valeur par défaut .NULL S’il est spécifié, @proxy_id doit être NULL. Pour obtenir @proxy_name, interrogez la sysproxies table système.

[ @schedule_uid = ] 'schedule_uid'

GUID qui pointe vers une planification. @schedule_uid est uniqueidentifier, avec la valeur par défaut .NULL Si elle est spécifiée, @schedule_name doit être NULL. Pour obtenir @schedule_uid, interrogez la sysschedules table système.

Lorsque @collection_mode a la 0valeur , @schedule_uid ou @schedule_name doivent être spécifiés. Lorsque @collection_mode est défini sur 1, @schedule_uid ou @schedule_name est ignoré si spécifié.

[ @schedule_name = ] N’schedule_name'

Nom de la planification. @schedule_name est sysname, avec la valeur par défaut .NULL S’il est spécifié, @schedule_uid doit être NULL. Pour obtenir @schedule_name, interrogez la sysschedules table système.

[ @logging_level = ] logging_level

Niveau de journalisation. @logging_level est smallint, avec la valeur par défaut 1, avec l’une des valeurs suivantes :

0: informations d’exécution du journal et événements SSIS qui effectuent le suivi :
- Démarrage/arrêt de jeux d'éléments de collecte
- Démarrage/arrêt de packages
- Informations sur l'erreur
1: journalisation de niveau 0 et :
- Statistiques d'exécution
- Progression de la collecte continuellement en cours d'exécution
- Événements d’avertissement de SSIS
2: journalisation de niveau 1 et informations détaillées sur les événements de SSIS.

[ @description = ] N’description'

Description du jeu de collection. @description est nvarchar(4000), avec la valeur par défaut .NULL

[ @collection_set_id = ] collection_set_id OUTPUT

Identificateur local unique pour le jeu de collection. @collection_set_id est un paramètre OUTPUT de type int.

[ @collection_set_uid = ] 'collection_set_uid' OUTPUT

GUID du jeu d'éléments de collecte. @collection_set_uid est un paramètre OUTPUT de type uniqueidentifier.

Valeurs des codes de retour

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

Notes

sp_syscollector_create_collection_set doit être exécuté dans le contexte de la msdb base de données système.

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

R. Créer un jeu de collection à l’aide de valeurs par défaut

L'exemple suivant crée un jeu d'éléments de collecte en spécifiant uniquement les paramètres requis. @collection_mode n’est pas obligatoire, mais le mode de collecte par défaut (mis en cache) nécessite de spécifier un ID de planification ou un nom de planification.

USE msdb;
GO

DECLARE @collection_set_id INT;

EXECUTE dbo.sp_syscollector_create_collection_set
    @name = N'Simple collection set test 1',
    @description = N'This is a test collection set that runs in non-cached mode.',
    @collection_mode = 1,
    @collection_set_id = @collection_set_id OUTPUT;
GO

B. Créer un jeu de collection à l’aide de valeurs spécifiées

L'exemple suivant crée un jeu d'éléments de collecte en spécifiant des valeurs pour un grand nombre des paramètres.

USE msdb;
GO

DECLARE @collection_set_id INT;
DECLARE @collection_set_uid UNIQUEIDENTIFIER;

SET @collection_set_uid = NEWID();

EXEC dbo.sp_syscollector_create_collection_set
    @name = N'Simple collection set test 2',
    @collection_mode = 0,
    @days_until_expiration = 365,
    @description = N'This is a test collection set that runs in cached mode.',
    @logging_level = 2,
    @schedule_name = N'CollectorSchedule_Every_30min',
    @collection_set_id = @collection_set_id OUTPUT,
    @collection_set_uid = @collection_set_uid OUTPUT;
GO