Поделиться через

sp_help_jobstep (Transact-SQL)

  • Статья

Область применения: SQL Server

Возвращает сведения о шагах в задании, используемом службой агент SQL Server для выполнения автоматизированных действий.

Соглашения о синтаксисе Transact-SQL

Синтаксис

sp_help_jobstep
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @step_id = ] step_id ]
    [ , [ @step_name = ] N'step_name' ]
    [ , [ @suffix = ] suffix ]
[ ; ]

Аргументы

[ @job_id = ] 'job_id'

Идентификационный номер задачи, для которого возвращаются сведения о задании. @job_id является уникальным идентификатором по умолчаниюNULL.

Необходимо указать @job_id или @job_name, но их нельзя указать.

[ @job_name = ] N'job_name'

Имя задания. @job_name — sysname с значением по умолчаниюNULL.

Необходимо указать @job_id или @job_name, но их нельзя указать.

[ @step_id = ] step_id

Идентификатор этапа задания. Если не указан, включаются все этапы задания. @step_id имеет значение int с значением по умолчаниюNULL.

[ @step_name = ] N'step_name'

Имя шага задания. @step_name — sysname, значение по умолчанию NULL— sysname.

[ @suffix = ] суффикс

Флаг, указывающий, добавляется ли текстовое описание к столбцу флагов в выходных данных. @suffix бит с значением по умолчанию0. Если задано 1значение @suffix, добавляется описание.

Значения кода возврата

0 (успешно) или 1 (сбой).

Результирующий набор

Имя столбца Тип данных Description
step_id int Уникальный идентификатор шага.
step_name sysname Имя шага задания.
subsystem nvarchar(40) Подсистема, в которой выполняется команда этапа.
command nvarchar(max) Выполняемая на шаге команда.
flags int Битовая маска значений, управляющая режимом шага.
cmdexec_success_code int Для шага CmdExec это значение является кодом завершения процесса успешной команды.
on_success_action tinyint Операция, выполняемая в случае успешного завершении шага:

1 = выход из отчета об успешном выполнении задания.
2 = завершите сбой отчетов о задании.
3 = Перейти к следующему шагу.
4 = Перейти к шагу.
on_success_step_id int Если on_success_action равно 4, это значение указывает на следующий шаг для выполнения.
on_fail_action tinyint Операция, совершаемая в случае сбоя при выполнении шага. Значения совпадают с on_success_actionзначениями.
on_fail_step_id int В on_fail_action противном 4случае это значение указывает на следующий шаг для выполнения.
server sysname Зарезервировано.
database_name sysname Для шага Transact-SQL это значение является базой данных, в которой выполняется команда.
database_user_name sysname Для шага Transact-SQL это значение является контекстом пользователя базы данных, в котором выполняется команда.
retry_attempts int Максимальное количество попыток выполнения команды (если это не удалось).
retry_interval int Интервал (в минутах) между повторными попытками.
os_run_priority int Зарезервировано.
output_file_name nvarchar(200) Файл, в который должны записываться выходные данные команды (только шаги Transact-SQL, CmdExec и PowerShell ).
last_run_outcome int Результат последнего запуска этапа:

0 = сбой
1 = успешно выполнено
2 = повторная попытка
3 = отменено
5 = неизвестно
last_run_duration int Длительность (hhmmss) шага при последнем запуске.
last_run_retries int Число повторов команды при последнем запуске этапа.
last_run_date int Дата начала последнего выполнения этапа.
last_run_time int Время начала последнего выполнения этапа.
proxy_id int Учетная запись-посредник для шага задания.

Замечания

sp_help_jobstep находится в msdb базе данных.

Разрешения

Вы можете предоставить EXECUTE разрешения для этой процедуры, но эти разрешения могут быть переопределены во время обновления SQL Server.

Другим пользователям необходимо предоставить одну из следующих агент SQL Server предопределенных ролей базы данных в msdb базе данных:

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

Дополнительные сведения о разрешениях этих ролей см. в разделе Предопределенные роли базы данных агента SQL Server.

Члены SQLAgentUserRole могут просматривать только шаги задания для заданий, принадлежащих им.

Примеры

А. Возврат сведений обо всех шагах указанного задания

В следующем примере возвращаются все шаги задания с именем Weekly Sales Data Backup.

USE msdb;
GO

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

B. Возврат сведений об указанном шаге задания

В следующем примере возвращаются сведения о первом шаге задания с именем Weekly Sales Data Backup.

USE msdb;
GO

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

Связанный контент