sp_help_job (Transact-SQL)

Retourne des informations sur les travaux utilisés par l'Agent SQL Server pour effectuer des opérations automatisées dans SQL Server. 

Conventions de la syntaxe de Transact-SQL

Syntaxe

sp_help_job { [ @job_id = ] job_id
[ @job_name = ] 'job_name' } 
     [ , [ @job_aspect = ] 'job_aspect' ] 
     [ , [ @job_type = ] 'job_type' ] 
     [ , [ @owner_login_name = ] 'login_name' ] 
     [ , [ @subsystem = ] 'subsystem' ] 
     [ , [ @category_name = ] 'category' ] 
     [ , [ @enabled = ] enabled ] 
     [ , [ @execution_status = ] status ] 
     [ , [ @date_comparator = ] 'date_comparison' ] 
     [ , [ @date_created = ] date_created ] 
     [ , [ @date_last_modified = ] date_modified ] 
     [ , [ @description = ] 'description_pattern' ]

Arguments

• [ @job_id =] job_id
  Numéro d'identification du travail. job_id est de type uniqueidentifier, avec NULL comme valeur par défaut.

• [ @job_name =] 'job_name'
  Nom du travail. job_name est de type sysname, avec NULL comme valeur par défaut.

  [!REMARQUE]

  Vous devez définir la valeur de job_id ou de job_name, mais pas les deux valeurs à la fois.

• [ @job_aspect =] 'job_aspect'
  Attribut du travail à afficher. job_aspect est de type varchar(9), avec NULL comme valeur par défaut et peut prendre l'une de ces valeurs.

  Valeur	Description
  ALL	Informations sur l'aspect du travail.
  JOB	Informations sur le travail.
  SCHEDULES	Informations sur la planification.
  STEPS	Informations sur l'étape du travail
  TARGETS	Informations sur la cible

• [ @job_type =] 'job_type'
  Type des travaux à inclure dans le rapport. job_type est de type varchar(12), avec NULL comme valeur par défaut. job_type peut être LOCAL ou MULTI-SERVER.

• [ @owner_login_name =] 'login_name'
  Nom de la connexion du propriétaire du travail. login_name est de type sysname, avec NULL comme valeur par défaut.

• [ @subsystem =] 'subsystem'
  Nom du sous-système. subsystem est de type nvarchar(40), avec NULL comme valeur par défaut.

• [ @category_name =] 'category'
  Nom de la catégorie. category est de type sysname, avec NULL comme valeur par défaut.

• [ @enabled =] enabled
  Nombre qui indique si les informations sont affichées pour les travaux activés ou les travaux désactivés. enabled est de type tinyint, avec NULL comme valeur par défaut. 1 indique que les travaux sont activés tandis que 0 indique que les travaux sont désactivés.

• [ @execution_status =] status
  État de l'exécution des travaux. status est de type int, avec NULL comme valeur par défaut et peut prendre l'une de ces valeurs.

  Valeur	Description
  0	Renvoie uniquement les travaux qui ne sont ni inactifs ni suspendus.
  1	En cours d'exécution.
  2	Attente du thread.
  3	Entre deux reprises.
  4	Inactif
  5	Suspendu.
  7	Effectue le travail.

• [ @date_comparator =] 'date_comparison'
  Opérateur de comparaison à utiliser pour comparer date_created et date_modified. date_comparison est de type char(1) et peut être =, < ou >.

• [ @date_created =] date_created
  Date de création du travail. date_createdest de type datetime, avec NULL comme valeur par défaut.

• [ @date_last_modified =] date_modified
  Date de la dernière modification du travail. date_modified est de type datetime, avec NULL comme valeur par défaut.

• [ @description =] 'description_pattern'
  Description du travail. description_pattern est de type nvarchar(512), avec NULL comme valeur par défaut. description_pattern peut comporter des caractères génériques de SQL Server pour permettre des correspondances entre modèles.

Valeurs des codes renvoyés

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

Jeux de résultats

Si aucun argument n'est spécifié, sp_help_job retourne ce jeu de résultats :

Si job_id ou job_name est précisé, sp_help_job retourne ces jeux de résultats supplémentaires pour les étapes, les planifications et les serveurs cibles des travaux.

Voici le jeu de résultats des étapes de travail :

Voici le jeu de résultats des planifications de travail.

Jeu de résultats pour les serveurs cibles 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 en savoir plus sur les autorisations de ces rôles, consultez Rôles de base de données fixes de l'Agent SQL Server.

Les membres du rôle SQLAgentUserRole peuvent consulter uniquement les travaux dont ils sont propriétaires. Les membres de sysadmin, de SQLAgentReaderRole et de SQLAgentOperatorRole peuvent consulter tous les travaux locaux et multiserveurs.

Exemple

A.Création de la liste des informations sur tous les travaux

L'exemple suivant exécute la procédure sp_help_job sans aucun paramètre afin que des informations sur tous les travaux définis dans la base de données msdb soient retournées.

USE msdb ;
GO

EXEC dbo.sp_help_job ;
GO

B.Création de la liste des informations pour les travaux correspondant à un critère spécifique

L'exemple suivant répertorie les informations sur les travaux multiserveurs détenus par françoisa lorsque les travaux sont activés et exécutés.

USE msdb ;
GO

EXEC dbo.sp_help_job 
   @job_type = N'MULTI-SERVER',
   @owner_login_name = N'françoisa',
   @enabled = 1,
   @execution_status = 1 ;
GO

C.Création de la liste de tous les aspects des informations pour un travail

L'exemple suivant répertorie tous les aspects des informations pour le travail NightlyBackups.

USE msdb ;
GO

EXEC dbo.sp_help_job
    @job_name = N'NightlyBackups',
    @job_aspect = N'ALL' ;
GO

Voir aussi

Référence

sp_add_job (Transact-SQL)

sp_delete_job (Transact-SQL)

sp_update_job (Transact-SQL)

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