sp_help_category (Transact-SQL)

S'applique à : SQL Server

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

Conventions de la syntaxe Transact-SQL

Syntaxe

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

Arguments

[ @class = ] 'class'

Spécifie la classe sur laquelle les informations sont demandées. @class est varchar(8) et peut être l’une de ces valeurs.

Valeur Description
JOB (valeur par défaut) Fournit des informations sur une catégorie de travaux.
ALERT Fournit des informations sur une catégorie d'alertes.
OPERATOR Fournit des informations sur une catégorie d'opérateurs.

[ @type = ] 'type'

Type de catégorie faisant l'objet d'une demande d'informations. @type est varchar(12) et peut être l’une de ces valeurs.

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

[ @name = ] N’name'

Nom de la catégorie faisant l'objet d'une demande d'informations. @name est sysname, avec la valeur par défaut NULL.

[ @suffix = ] suffixe

Spécifie si la category_type colonne du jeu de résultats est un ID ou un nom. @suffix est bit, avec la valeur par défaut 0.

  • 1 affiche le category_type nom.
  • 0 affiche l’ID category_type .

Valeurs des codes de retour

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

Jeu 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 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 : Valeurs possibles : LOCAL, MULTI-SERVER ou NONE
name sysname Nom de la catégorie

Notes

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

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

autorisations

Cette procédure stockée appartient au rôle db_owner . Vous pouvez accorder EXECUTE des autorisations pour n’importe quel utilisateur, mais ces autorisations peuvent être remplacées lors d’une mise à niveau de SQL Server.

D’autres utilisateurs doivent disposer de l’un des rôles de base de données fixes SQL Server Agent suivants dans la msdb base de données :

  • 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. Retourner les informations relatives au travail 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. Retourner des informations d’alerte

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