Partager via

sp_help_jobstep (Transact-SQL)

  • Article

S'applique à : SQL Server

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

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_help_jobstep
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @step_id = ] step_id ]
    [ , [ @step_name = ] N'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 la valeur par défaut NULL.

Vous devez spécifier @job_id ou @job_name , mais les deux ne peuvent pas être spécifiées.

[ @job_name = ] N’job_name'

Nom du travail. @job_name est sysname, avec la valeur par défaut NULL.

Vous devez spécifier @job_id ou @job_name , mais les deux ne peuvent pas être spécifiées.

[ @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 = ] N’step_name'

Nom de l'étape du travail. @step_name est sysname, avec la valeur par défaut NULL.

[ @suffix = ] suffixe

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

Valeurs des codes de retour

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

Jeu 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.
subsystem 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 , cette valeur est le 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 = Quitter le travail signalant l’échec.
3 = Passez à l’étape suivante.
4 = Passer à l’étape.
on_success_step_id int Si on_success_action est 4, cette valeur 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 c’est 4le cas, cette valeur indique l’étape suivante à exécuter.
server sysname Réservé.
database_name sysname Pour une étape Transact-SQL, cette valeur est la base de données dans laquelle la commande s’exécute.
database_user_name sysname Pour une étape Transact-SQL, cette valeur est le contexte utilisateur de base de données dans lequel la commande s’exécute.
retry_attempts int Nombre maximal de fois où la commande doit être retentée (si elle échoue).
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éussite
2 = Nouvelle tentative
3 = Annulé
5 = Inconnu
last_run_duration int Durée (hhmmss) de l’étape la dernière fois qu’elle a été exécutée.
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.

Notes

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

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.

Les membres de SQLAgentUserRole peuvent uniquement afficher les étapes de travail pour les travaux qu’ils possèdent.

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

Contenu connexe