sp_help_category (Transact-SQL)

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

Icône Lien de rubriqueConventions de la syntaxe de Transact-SQL

Syntaxe

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

Arguments

  • [ @class=] 'class'
    Classe faisant l'objet d'une demande d'informations. class est de type varchar(8) et sa valeur par défaut est JOB. class peut prendre les valeurs suivantes :

    Valeur

    Description

    JOB

    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 de type varchar(12) et sa valeur par défaut est NULL. Cet argument peut prendre les valeurs suivantes :

    Valeur

    Description

    LOCAL

    Catégorie de travaux locale.

    MULTISERVER

    Catégorie de travaux multiserveur.

    NONE

    Catégorie ne correspondant pas à la classe JOB.

  • [ @name= ] 'name'
    Nom de la catégorie sur laquelle des informations sont demandées. L'argument name est de type sysname et sa valeur par défaut est NULL.

  • [ @suffix= ] suffix
    Spécifie si la colonne category_type du jeu de résultats est de type ID ou name. L'argument suffix est de type bit, avec une valeur par défaut de 0. 1 indique category_type en tant que type name et 0 en tant que type ID.

Valeurs des codes renvoyés

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

Jeux de résultats

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

Nom de 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 = Aucune

name

sysname

Nom de la catégorie

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

Nom de colonne

Type de données

Description

category_id

int

ID de la catégorie

category_type

sysname

Type de catégorie : LOCAL, MULTI-SERVER ou NONE

name

sysname

Nom de la catégorie

Notes

La procédure sp_help_category doit être exécutée à 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

Seuls les membres du rôle de 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 SQL Server Agent suivants dans la base de données msdb.

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

Pour plus de détails sur les autorisations relatives à ces rôles, consultez Rôles de base de données fixes de l'Agent SQL Server.

Exemple

A. 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