sp_help_job (Transact-SQL)

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

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

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

Синтаксис

sp_help_job
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @job_aspect = ] 'job_aspect' ]
    [ , [ @job_type = ] 'job_type' ]
    [ , [ @owner_login_name = ] N'owner_login_name' ]
    [ , [ @subsystem = ] N'subsystem' ]
    [ , [ @category_name = ] N'category_name' ]
    [ , [ @enabled = ] enabled ]
    [ , [ @execution_status = ] execution_status ]
    [ , [ @date_comparator = ] 'date_comparator' ]
    [ , [ @date_created = ] date_created ]
    [ , [ @date_last_modified = ] date_last_modified ]
    [ , [ @description = ] N'description' ]
[ ; ]

Аргументы

[ @job_id = ] 'job_id'

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

Чтобы просмотреть определенное задание, необходимо указать @job_id или @job_name . Опустите как @job_id, так и @job_name для возврата сведений обо всех заданиях.

[ @job_name = ] N'job_name'

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

Чтобы просмотреть определенное задание, необходимо указать @job_id или @job_name . Опустите как @job_id, так и @job_name для возврата сведений обо всех заданиях.

[ @job_aspect = ] 'job_aspect'

Отображаемое задание атрибута. @job_aspect — varchar(9) и может быть одним из этих значений.

[ @job_type = ] 'job_type'

Тип заданий, которые необходимо включить в отчет.@job_type — varchar(12), с значением по умолчаниюNULL. @job_type может быть LOCAL или MULTI-SERVER.

[ @owner_login_name = ] N'owner_login_name'

Имя входа владельца задания. @owner_login_name имеет имя sysname с значением по умолчаниюNULL.

[ @subsystem = ] N'подсистема

Имя подсистемы. @subsystem — nvarchar(40) с значением по умолчаниюNULL.

[ @category_name = ] N'category_name'

Имя категории. @category_name — sysname с значением по умолчаниюNULL.

[ @enabled = ] включен

Номер, указывающий, для каких заданий отображаются сведения — включенных или отключенных. @enabled крошечный, с значением по умолчаниюNULL.

• 1 указывает на включенные задания.
• 0 указывает отключенные задания.

[ @execution_status = ] execution_status

Состояние выполнения заданий. @execution_status является int и может быть одним из этих значений.

[ @date_comparator = ] 'date_comparator'

Оператор сравнения для сравнения @date_created и @date_last_modified. @date_comparator является char(1), и может быть =, <или >.

[ @date_created = ] date_created

Дата создания задания. @date_created — datetime с значением по умолчаниюNULL.

[ @date_last_modified = ] date_last_modified

Дата последнего изменения задания. @date_last_modified — datetime с значением по умолчаниюNULL.

[ @description = ] N'description'

Описание задания. @description — nvarchar(512) с значением по умолчаниюNULL. @description могут включать подстановочные знаки для сопоставления шаблонов.

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

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

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

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

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

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

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

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

Разрешения

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

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

• SQLAgentUserRole
• SQLAgentReaderRole
• SQLAgentOperatorRole

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

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

Примеры

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

На следующем примере показано, как процедура sp_help_job, выполняемая без параметров, возвращает сведения обо всех заданиях, определенных в данный момент в базе данных msdb.

USE msdb;
GO

EXEC dbo.sp_help_job;
GO

B. Перечисление сведений о заданиях, соответствующих определенным критериям

В следующем примере показано, как выводятся сведения о многосерверных заданиях, владельцем которых является françoisa, которые включены и выполняются.

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

C. Перечисление всех аспектов сведений для задания

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

USE msdb;
GO

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

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

• sp_add_job (Transact-SQL)
• sp_delete_job (Transact-SQL)
• sp_update_job (Transact-SQL)
• Системные хранимые процедуры (Transact-SQL)