sp_help_jobstep (Transact-SQL)

Статья
03/07/2014

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

Применимо для следующих объектов: SQL Server (начиная с SQL Server 2008 до текущей версии).

Значок ссылки на раздел Cинтаксические обозначения в Transact-SQL

Синтаксис

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(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	Продолжительность этапа в секундах при последнем запуске.
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)

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