sp_help_jobstep (Transact-SQL)

  • Article

S’applique à :SQL Server

Retourne des informations sur les étapes d’un travail utilisé par SQL Server Agent service pour effectuer des activités automatisées.

Conventions de la syntaxe Transact-SQL

Syntaxe

  
sp_help_jobstep { [ @job_id = ] 'job_id' | [ @job_name = ] 'job_name' }  
     [ , [ @step_id = ] step_id ]   
     [ , [ @step_name = ] 'step_name' ]   
     [ , [ @suffix = ] suffix ]

Arguments

[ @job_id = ] 'job_id' Numéro d’identification du travail pour lequel retourner les informations de travail. job_id est uniqueidentifier, avec une valeur par défaut NULL.

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

Notes

Les job_id ou les job_name doivent être spécifiés, mais les deux ne peuvent pas être spécifiés.

[ @step_id = ] step_id Numéro d’identification de l’étape du travail. S'il n'est pas inclus, toutes les étapes du travail sont englobées. step_id est int, avec la valeur par défaut NULL.

[ @step_name = ] 'step_name' Nom de l’étape du travail. step_name est sysname, avec la valeur null par défaut.

[ @suffix = ] suffix Indicateur indiquant si une description de texte est ajoutée à la colonne indicateurs dans la sortie. Le suffixeest bit, avec la valeur par défaut 0. Si le suffixe est 1, une description est ajoutée.

Codet de retour

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

Jeux de résultats

Nom de la colonne Type de données Description
step_id int Identificateur unique de l'étape.
step_name sysname Nom de l’étape du travail.
Sous-système nvarchar(40) Sous-système dans lequel la commande d'étape doit être exécutée.
command nvarchar(max) Commande exécutée dans l'étape.
flags int Masque de bits des valeurs qui contrôle le comportement de l'étape.
cmdexec_success_code int Pour une étape CmdExec , il s’agit du code de sortie du processus d’une commande réussie.
on_success_action tinyint Action à effectuer si l'étape est exécutée correctement :

1 = Quitter le travail signalant la réussite.

2 = Quittez le travail signalant l’échec.

3 = Passez à l’étape suivante.

4 = Accéder à l’étape.
on_success_step_id int Si on_success_action est 4, cela indique l’étape suivante à exécuter.
on_fail_action tinyint Action à exécuter si l'étape échoue. Les valeurs sont identiques à on_success_action.
on_fail_step_id int Si on_fail_action est 4, cela indique l’étape suivante à exécuter.
server sysname Réservé.
database_name sysname Pour une étape Transact-SQL, il s’agit de la base de données dans laquelle la commande s’exécute.
database_user_name sysname Pour une étape Transact-SQL, il s’agit du contexte utilisateur de la base de données dans lequel la commande s’exécute.
retry_attempts int Nombre maximum de tentatives de la commande (en cas d'échecs).
retry_interval int Intervalle (en minutes) entre les tentatives.
os_run_priority int Réservé.
output_file_name nvarchar(200) Fichier dans lequel la sortie de commande doit être écrite (étapes Transact-SQL, CmdExec et PowerShell uniquement).
last_run_outcome int Résultat de l'étape lors de sa dernière exécution.

0 = Échec

1 = Réussi

2 = Réessayer

3 = Annulé

5 = Inconnu
last_run_duration int Durée (hhmmss) de l'étape lors de sa dernière exécution.
last_run_retries int Nombre de tentatives de la commande lors de la dernière exécution de l'étape.
last_run_date int Date de début de la dernière exécution de l'étape.
last_run_time int Heure de début de la dernière exécution de l'étape.
proxy_id int Proxy pour les étapes du travail.

Remarques

sp_help_jobstep se trouve dans la base de données msdb .

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.

Les membres de SQLAgentUserRole peuvent uniquement afficher les étapes de travail pour les travaux dont ils sont propriétaires.

Exemples

R. Renvoi d'informations sur toutes les étapes d'un travail spécifique

L'exemple suivant renvoie toutes les étapes du travail intitulé Weekly Sales Data Backup.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_jobstep  
    @job_name = N'Weekly Sales Data Backup' ;  
GO

B. Renvoi d'informations sur une étape spécifique d'un travail

Cet exemple renvoie des informations sur la première étape du travail Weekly Sales Data Backup.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_jobstep  
    @job_name = N'Weekly Sales Data Backup',  
    @step_id = 1 ;  
GO

Voir aussi

sp_add_jobstep (Transact-SQL)
sp_delete_jobstep (Transact-SQL)
sp_help_job (Transact-SQL)
sp_update_jobstep (Transact-SQL)
Procédures stockées système (Transact-SQL)