sp_help_jobstep (Transact-SQL)

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

Синтаксис

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

Аргументы

• [ @job_id =] 'job_id'
  Идентификатор задания, о котором возвращаются сведения. Аргумент job_id имеет тип uniqueidentifier и значение по умолчанию NULL.

• [ @job_name = ] 'job_name'
  Имя задания. Аргумент job_name имеет тип sysname и значение по умолчанию NULL.

  Примечание.
  Необходимо указать либо аргумент job_id, либо аргумент job_name, но не оба аргумента одновременно.

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

• [ @step_name =] 'step_name'
  Имя этапа задания. Аргумент step_name имеет тип sysname и значение по умолчанию NULL.

• [ @suffix =] suffix
  Флаг, указывающий на то, что к выходному столбцу flags добавлено текстовое описание. Аргумент suffixимеет тип bit и значение по умолчанию 0. Если аргумент suffix имеет значение 1, то добавляется описание.

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

0 (успешное завершение) или 1 (неуспешное завершение)

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

Имя столбца	Тип данных	Описание
step_id	int	Уникальный идентификатор этапа.
step_name	sysname	Имя этапа задания.
subsystem	nvarchar(40)	Подсистема, в которой выполняется команда этапа.
command	nvarchar(3200)	Выполняемая на этапе команда.
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).
last_run_outcome	int	Результат последнего выполнения этапа: 0 = сбой 1 = выполнено 2 = повтор 3 = отменено 5 = неизвестное состояние
last_run_duration	int	Продолжительность (в секундах) последнего выполнения этапа.
last_run_retries	int	Количество повторений команды во время последнего выполнения этапа.
last_run_date	int	Дата начала последнего выполнения этапа.
last_run_time	int	Время начала последнего выполнения этапа.
proxy_id	int	Учетная запись-посредник для шага задания.

Замечания

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

Разрешения

По умолчанию эту хранимую процедуру могут выполнять члены фиксированной серверной роли sysadmin. Другим пользователям должна быть предоставлена одна из следующих фиксированных ролей базы данных агента 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

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

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

USE msdb ;
GO

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

См. также

Справочник

sp_add_jobstep (Transact-SQL)
sp_delete_jobstep (Transact-SQL)
sp_help_job (Transact-SQL)
sp_update_jobstep (Transact-SQL)
Системные хранимые процедуры (Transact-SQL)

Справка и поддержка

Получение помощи по SQL Server 2005