sp_help_category (Transact-SQL)

Article
05/23/2023

S’applique à :SQL Server

Fournit des informations sur les classes de travaux, d'alertes ou d'opérateurs spécifiées.

Syntaxe

  
sp_help_category [ [ @class = ] 'class' ]   
     [ , [ @type = ] 'type' ]   
     [ , [ @name = ] 'name' ]   
     [ , [ @suffix = ] suffix ]

Arguments

[ @class = ] 'class' Classe sur laquelle les informations sont demandées. la classe est varchar(8), avec la valeur par défaut JOB. class peut être l’une de ces valeurs.

Valeur	Description
TRAVAIL	Fournit des informations sur une catégorie de travaux.
ALERTE	Fournit des informations sur une catégorie d'alertes.
OPÉRATEUR	Fournit des informations sur une catégorie d'opérateurs.

[ @type = ] 'type' Type de catégorie pour laquelle des informations sont demandées. type est varchar(12), avec une valeur par défaut NULL, et peut être l’une de ces valeurs.

Valeur	Description
LOCAL	Catégorie de travaux locale.
MULTISERVER	Catégorie de travaux multiserveur.
NONE	Catégorie pour une classe autre que JOB.

[ @name = ] 'name' Nom de la catégorie pour laquelle des informations sont demandées. name est sysname, avec une valeur par défaut NULL.

[ @suffix = ] suffix Spécifie si la colonne category_type dans le jeu de résultats est un ID ou un nom. Le suffixe est bit, avec la valeur par défaut 0. 1 affiche le category_type en tant que nom et 0 en tant qu’ID.

Codet de retour

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

Jeux de résultats

Lorsque @suffix est 0, sp_help_category retourne le jeu de résultats suivant :

Nom de la colonne	Type de données	Description
category_id	int	ID de la catégorie
category_type	tinyint	Type de catégorie : 1 = Local 2 = Multiserveur 3 = Aucun
name	sysname	Nom de la catégorie

Lorsque @suffix a la valeur 1, sp_help_category retourne le jeu de résultats suivant :

Nom de la colonne	Type de données	Description
category_id	int	ID de la catégorie
category_type	sysname	Type de catégorie : L’un des paramètres LOCAL, MULTI-SERVER ou NONE
name	sysname	Nom de la catégorie

Remarques

sp_help_category doivent être exécutés à partir de la base de données msdb .

Si aucun paramètre n'est spécifié, le jeu de résultats fournit des informations sur toutes les catégories de travaux.

Autorisations

Par défaut, les membres du rôle serveur fixe sysadmin peuvent exécuter cette procédure stockée. Les autres utilisateurs doivent disposer de l'un des rôles de base de données fixes suivants de SQL Server Agent dans la base de données msdb :

SQLAgentUserRole
SQLAgentReaderRole
SQLAgentOperatorRole

Pour en savoir plus sur les autorisations de ces rôles, consultez Rôles de base de données fixes de l'Agent SQL Server.

Exemples

R. Renvoi d'informations sur les travaux en local

L'exemple suivant renvoie des informations sur les travaux qui sont administrés localement.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_category  
    @type = N'LOCAL' ;  
GO

B. Renvoi d'informations sur les alertes

L'exemple suivant renvoie des informations sur la catégorie d'alerte de Replication.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_category  
    @class = N'ALERT',  
    @name = N'Replication' ;  
GO

Voir aussi

sp_add_category (Transact-SQL)
sp_delete_category (Transact-SQL)
sp_update_category (Transact-SQL)
Procédures stockées système (Transact-SQL)