sp_help_jobschedule (Transact-SQL)

Применимо к:SQL Server

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

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

Синтаксис

sp_help_jobschedule
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @schedule_id = ] schedule_id ]
    [ , [ @include_description = ] include_description ]
[ ; ]

Аргументы

[ @job_id = ] 'job_id'

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

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

[ @job_name = ] N'job_name'

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

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

[ @schedule_name = ] N'schedule_name'

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

[ @schedule_id = ] schedule_id

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

[ @include_description = ] include_description

Указывает, нужно ли включать описание расписания в результирующий набор. @include_description бит с значением по умолчанию0.

  • Если 0описание расписания не включается в результирующий набор.
  • Если 1в результирующем наборе включено описание расписания.

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

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

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

Имя столбца Тип данных Description
schedule_id int Идентификационный номер расписания.
schedule_name sysname Имя расписания.
enabled int Включено ли расписание (1) или не включено (0).
freq_type int Значение, указывающее, когда должно выполняться задание.

1 = один раз
4 = ежедневно
8 = еженедельно
16 = ежемесячно
32 = ежемесячно, относительно freq_interval
64= запуск при запуске службы агент SQL Server.
freq_interval int Дни, в которые выполняется задание. Значение зависит от значения freq_type. Дополнительные сведения см. в sp_add_schedule.
freq_subday_type int Единицы для freq_subday_interval. Дополнительные сведения см. в sp_add_schedule.
freq_subday_interval int Количество периодов, возникающих freq_subday_type между каждым выполнением задания. Дополнительные сведения см. в sp_add_schedule.
freq_relative_interval int Запланированное задание в freq_interval каждом месяце. Дополнительные сведения см. в sp_add_schedule.
freq_recurrence_factor int Число месяцев между выполнениями задания по расписанию.
active_start_date int Дата, когда начинает действовать расписание.
active_end_date int Дата, когда прекращает действовать расписание.
active_start_time int Время суток, когда начинает действовать расписание.
active_end_time int Время суток, когда прекращает действовать расписание.
date_created datetime Дата создания расписания.
schedule_description nvarchar(4000) Английское описание расписания, которое является производным от значений в msdb.dbo.sysschedules. Если @include_description0, этот столбец содержит текст, указывающий, что описание не было запрошено.
next_run_date int Дата следующего расписания приводит к выполнению задания.
next_run_time int Время следующего расписания приводит к выполнению задания.
schedule_uid uniqueidentifier Идентификатор расписания.
job_count int Возвращенное количество заданий.

Примечание.

sp_help_jobschedule возвращает значения из системных dbo.sysjobschedulesdbo.sysschedules таблиц каждые msdb.sysjobschedules 20 минут. Это может повлиять на значения, возвращаемые этой хранимой процедурой.

Замечания

Параметры могут использоваться только в определенных сочетаниях sp_help_jobschedule . Если указан @schedule_id , не удается указать @job_id и @job_name . В противном случае параметры @job_id или @job_name можно использовать с @schedule_name.

Разрешения

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

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

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

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

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

Примеры

А. Возврат расписания заданий для определенного задания

Следующий пример возвращает сведения о расписании для задания с именем BackupDatabase.

USE msdb;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'BackupDatabase' ;
GO

B. Возврат расписания задания для определенного расписания

Следующий пример возвращает сведения о расписании с названием NightlyJobs и задании с названием RunReports.

USE msdb;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs';
GO

C. Возврат описания расписания задания и расписания для определенного расписания

Следующий пример возвращает сведения о расписании с названием NightlyJobs и задании с названием RunReports. Возвращаемый результирующий набор включает описание расписания.

USE msdb;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs',
    @include_description = 1;
GO