sp_help_category (Transact-SQL)

S’applique à : ouiSQL Server (toutes les versions prises en charge)

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

Icône Lien de rubrique Conventions de la syntaxe Transact-SQL

Syntaxe

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

Arguments

[ @class = ] 'class' Classe sur laquelle des informations sont demandées. la classe est de type varchar (8), avec Job comme valeur par défaut. la classe peut prendre l’une des valeurs suivantes.

Valeur Description
ATTENTE Fournit des informations sur une catégorie de travaux.
NOTIFICATION Fournit des informations sur une catégorie d'alertes.
AND Fournit des informations sur une catégorie d'opérateurs.

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

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 les informations sont demandées. Name est de type sysname, avec NULL comme valeur par défaut.

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

Codet de retour

0 (succès) ou 1 (échec)

Jeux de résultats

Lorsque le @ suffixe 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 le @ suffixe est 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 : Un serveur local, plusieurs serveurs ou aucun
name sysname Nom de la catégorie

Notes

sp_help_category doit être exécuté à 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)