sp_help_jobstep (Transact-SQL)
Gilt für: SQL Server
Gibt Informationen zu den Schritten in einem Auftrag zurück, der von SQL Server-Agent Dienst zum Ausführen automatisierter Aktivitäten verwendet wird.
Transact-SQL-Syntaxkonventionen
Syntax
sp_help_jobstep
[ [ @job_id = ] 'job_id' ]
[ , [ @job_name = ] N'job_name' ]
[ , [ @step_id = ] step_id ]
[ , [ @step_name = ] N'step_name' ]
[ , [ @suffix = ] suffix ]
[ ; ]
Argumente
[ @job_id = ] 'job_id'
Die ID des Auftrags, zu dem Auftragsinformationen zurückgegeben werden sollen. @job_id ist eindeutiger Bezeichner mit einem Standardwert von NULL
.
Entweder @job_id oder @job_name müssen angegeben werden, beide können jedoch nicht angegeben werden.
[ @job_name = ] N'job_name'
Der Name des Auftrags. @job_name ist "sysname" mit der Standardeinstellung "NULL
.
Entweder @job_id oder @job_name müssen angegeben werden, beide können jedoch nicht angegeben werden.
[ @step_id = ] step_id
Die ID des Auftragsschritts. Wenn diese nicht angegeben wird, sind alle Schritte im Auftrag eingeschlossen. @step_id ist int mit einem Standardwert von NULL
.
[ @step_name = ] N'step_name'
Der Name des Schritts im Auftrag. @step_name ist "sysname" mit der Standardeinstellung "NULL
.
[ @suffix = Suffix
Ein Kennzeichen, das angibt, ob eine Textbeschreibung an die Flags-Spalte in der Ausgabe angefügt wird. @suffix ist bit, mit einem Standardwert von 0
. Wenn @Suffix lautet 1
, wird eine Beschreibung angefügt.
Rückgabecodewerte
0
(erfolgreich) oder 1
Fehler.
Resultset
Spaltenname | Datentyp | BESCHREIBUNG |
---|---|---|
step_id |
int | Eindeutiger Bezeichner für den Schritt. |
step_name |
sysname | Name des Auftragsschritts. |
subsystem |
nvarchar(40) | Subsystem, in dem der Schrittbefehl ausgeführt werden soll |
command |
nvarchar(max) | Befehl, der in dem Schritt ausgeführt wird. |
flags |
int | Bitmaske der Werte, die das Schrittverhalten steuern. |
cmdexec_success_code |
int | Bei einem CmdExec-Schritt ist dieser Wert der Prozessendecode eines erfolgreichen Befehls. |
on_success_action |
tinyint | Auszuführende Aktion, wenn der Schritt erfolgreich ist:1 = Beenden Sie den Erfolg der Auftragsberichterstattung.2 = Beenden des Auftragsberichtsfehlers.3 = Zum nächsten Schritt wechseln.4 = Gehe zu Schritt. |
on_success_step_id |
int | Wenn on_success_action 4 ist, gibt dieser Wert den nächsten auszuführenden Schritt an. |
on_fail_action |
tinyint | Was zu tun ist, wenn der Schritt fehlschlägt. Werte sind identisch mit on_success_action . |
on_fail_step_id |
int | Ist on_fail_action dies 4 der Fall, gibt dieser Wert den nächsten auszuführenden Schritt an. |
server |
sysname | Reserviert. |
database_name |
sysname | Bei einem Transact-SQL-Schritt ist dieser Wert die Datenbank, in der der Befehl ausgeführt wird. |
database_user_name |
sysname | Bei einem Transact-SQL-Schritt ist dieser Wert der Datenbankbenutzerkontext, in dem der Befehl ausgeführt wird. |
retry_attempts |
int | Maximale Anzahl der Wiederholungsversuche für den Befehl (wenn er nicht erfolgreich ist). |
retry_interval |
int | Das Intervall (in Minuten) zwischen den Wiederholungsversuchen. |
os_run_priority |
int | Reserviert. |
output_file_name |
nvarchar(200) | Datei, in die die Befehlsausgabe geschrieben werden soll (nur Transact-SQL-, CmdExec- und PowerShell-Schritte ). |
last_run_outcome |
int | Ergebnis der letzten Ausführung des Schritts:0 = Fehlgeschlagen1 = Erfolgreich2 = Wiederholen3 = Abgebrochen5 = Unbekannt |
last_run_duration |
int | Dauer (hhmmss ) des Schritts beim letzten Ausführen. |
last_run_retries |
int | Anzahl der Wiederholungsversuche für den Befehl bei der letzten Ausführung des Schritts |
last_run_date |
int | Datum, an dem die Ausführung des Schritts zuletzt gestartet wurde |
last_run_time |
int | Uhrzeit, zu der die Ausführung des Schritts zuletzt gestartet wurde |
proxy_id |
int | Proxy für den Auftragsschritt. |
Hinweise
sp_help_jobstep
befindet sich in der msdb
Datenbank.
Berechtigungen
Diese gespeicherte Prozedur gehört der db_owner Rolle. Sie können berechtigungen für jeden Benutzer erteilen EXECUTE
, diese Berechtigungen können jedoch während eines SQL Server-Upgrades außer Kraft gesetzt werden.
Anderen Benutzern muss eine der folgenden SQL Server-Agent festen Datenbankrollen in der msdb
Datenbank gewährt werden:
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
Weitere Informationen zu den Berechtigungen dieser Rollen finden Sie unter Feste Datenbankrollen des SQL Server-Agents.
Mitglieder von SQLAgentUserRole können nur Auftragsschritte für Aufträge anzeigen, die sie besitzen.
Beispiele
A. Zurückgeben von Informationen für alle Schritte in einem bestimmten Auftrag
Im folgenden Beispiel werden alle Auftragsschritte für den Auftrag Weekly Sales Data Backup
zurückgegeben.
USE msdb;
GO
EXEC dbo.sp_help_jobstep
@job_name = N'Weekly Sales Data Backup';
GO
B. Zurückgeben von Informationen zu einem bestimmten Auftragsschritt
Im folgenden Beispiel werden Informationen zum ersten Auftragsschritt des Auftrags Weekly Sales Data Backup
zurückgegeben.
USE msdb;
GO
EXEC dbo.sp_help_jobstep
@job_name = N'Weekly Sales Data Backup',
@step_id = 1;
GO