sp_help_job (Transact-SQL)

Синтаксис

sp_help_job { [ @job_id = ] job_id
[ @job_name = ] 'job_name' } 
     [ , [ @job_aspect = ] 'job_aspect' ] 
     [ , [ @job_type = ] 'job_type' ] 
     [ , [ @owner_login_name = ] 'login_name' ] 
     [ , [ @subsystem = ] 'subsystem' ] 
     [ , [ @category_name = ] 'category' ] 
     [ , [ @enabled = ] enabled ] 
     [ , [ @execution_status = ] status ] 
     [ , [ @date_comparator = ] 'date_comparison' ] 
     [ , [ @date_created = ] date_created ] 
     [ , [ @date_last_modified = ] date_modified ] 
     [ , [ @description = ] 'description_pattern' ]

Аргументы

• [ @job_id =] job_id
  Идентификационный номер задания. Аргумент job_id имеет тип uniqueidentifier и значение по умолчанию NULL.

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

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

• [ @job_aspect =] 'job_aspect'
  Атрибут задания для отображения. Аргумент job_aspect имеет тип varchar(9), значение по умолчанию NULL и может принимать одно из следующих значений.

  Значение	Описание
  ALL	Сведения об аспекте задания
  JOB	Сведения о задании
  SCHEDULES	Сведения о расписании
  STEPS	Сведения об шаге задания
  TARGETS	Сведения о цели

• [ @job_type =] 'job_type'
  Тип заданий для включения в отчет. Аргумент job_type имеет тип varchar(12) и значение по умолчанию NULL. Аргумент job_type может принимать значение LOCAL или MULTI-SERVER.

• [ @owner_login_name =] 'login_name'
  Имя входа владельца задания в системе. Аргумент login_name имеет тип sysname и значение по умолчанию NULL.

• [ @subsystem =] 'subsystem'
  Имя подсистемы. Аргумент subsystem имеет тип nvarchar(40) и значение по умолчанию NULL.

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

• [ @enabled =] enabled
  Номер, указывающий, для каких заданий отображаются сведения — включенных или отключенных. Аргумент enabled имеет тип tinyint и значение по умолчанию NULL. 1 указывает на включенные задания, а 0 — на отключенные.

• [ @execution_status =] status
  Состояние выполнения заданий. Аргумент status имеет тип int, значение по умолчанию NULL и может принимать одно из следующих значений.

  Значение	Описание
  0	Возвращает только те задания, которые не находятся в состоянии бездействия или приостановки.
  1	Выполняющиеся.
  2	Ожидающие потока.
  3	Ожидающие повторной попытки.
  4	Бездействующие.
  5	Приостановленные.
  7	Выполняющие завершающие действия.

• [ @date_comparator =] 'date_comparison'
  Оператор, используемый для сравнения аргументов date_created и date_modified. Аргумент date_comparison имеет тип char(1) и может представлять собой символ =, < или >.

• [ @date_created =] date_created
  Дата создания задания. Аргумент date_created имеет тип datetime и значение по умолчанию NULL.

• [ @date_last_modified =] date_modified
  Дата последнего изменения задания. Аргумент date_modified имеет тип datetime и значение по умолчанию NULL.

• [ @description =] 'description_pattern'
  Описание задания. Аргумент description_pattern имеет тип nvarchar(512) и значение по умолчанию NULL. Аргумент description_pattern может включать символы-шаблоны SQL Server для совпадения с маской.

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

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

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

Если не заданы аргументы, процедура sp_help_job возвращает следующий результирующий набор.

Если указан аргумент job_id или аргумент job_name, то процедура sp_help_job возвращает следующие дополнительные результирующие наборы для шагов задания, расписания и целевых серверов задания.

Это результирующий набор для шагов задания.

Это результирующий набор для расписания задания.

Это результирующий набор для целевых серверов задания.

Разрешения

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

• SQLAgentUserRole

• SQLAgentReaderRole

• SQLAgentOperatorRole

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

Членам роли SQLAgentUserRole доступен просмотр только тех заданий, которыми они владеют. Членам ролей sysadmin, SQLAgentReaderRole и SQLAgentOperatorRole доступен просмотр всех локальных и многосерверных заданий.

Примеры

A. Вывод списка сведений обо всех заданиях

USE msdb ;
GO

EXEC dbo.sp_help_job ;
GO

Б. Вывод сведений о заданиях, совпадающих с определенным критерием

USE msdb ;
GO

EXEC dbo.sp_help_job 
   @job_type = N'MULTI-SERVER',
   @owner_login_name = N'françoisa',
   @enabled = 1,
   @execution_status = 1 ;
GO

В. Вывод всех аспектов сведений о задании

USE msdb ;
GO

EXEC dbo.sp_help_job
    @job_name = N'NightlyBackups',
    @job_aspect = N'ALL' ;
GO

См. также

Справочник