sp_help_jobschedule (Transact-SQL)
Возвращает сведения о расписании выполнения заданий, используемом средой Среда SQL Server Management Studio для выполнения автоматических действий.
.gif "Значок ссылки на раздел")
Синтаксис
sp_help_jobschedule { [ @job_id = ] job_id | [ @job_name = ] 'job_name' }
[ , [ @schedule_name = ] 'schedule_name' ]
[ , [ @schedule_id = ] schedule_id ]
[ , [ @include_description = ] include_description ]
Аргументы
[ @job_id= ] job_id
Идентификационный номер задачи. Аргумент job_id имеет тип uniqueidentifier и значение по умолчанию NULL.[ @job_name= ] 'job_name'
Имя задания. Аргумент job_name имеет тип sysname и значение по умолчанию NULL..gif "Примечание")
ПримечаниеНужно указать либо значение аргумента job_id, либо значение аргумента job_name, но не значения обоих аргументов одновременно.
[ @schedule_name= ] 'schedule_name'
Имя элемента расписания для задания. Аргумент schedule_name имеет тип sysname и значение по умолчанию NULL.[ @schedule_id= ] schedule_id
Номер идентификатора элемента расписания для задания. Аргумент schedule_id имеет тип int и значение по умолчанию NULL.[ @include_description= ] include_description
Указывает, нужно ли включать описание расписания в результирующий набор. Аргумент include_description имеет тип bit и значение по умолчанию 0. Когда значение аргумента include_description равно 0, описание расписания не включается в результирующий набор. Когда значение аргумента include_description равно 1, описание расписания включается в результирующий набор.
Значения кодов возврата
0 (успешное завершение) или 1 (неуспешное завершение).
Результирующие наборы
Имя столбца |
Тип данных |
Описание |
|---|---|---|
schedule_id |
int |
Идентификационный номер расписания. |
schedule_name |
sysname |
Имя расписания. |
enabled |
int |
Расписание задействовано (1) или не задействовано (0). |
freq_type |
int |
Значение, указывающее, когда должно выполняться задание: 1 = однократно; 4 = ежедневно; 8 = еженедельно; 16 = ежемесячно; 32 = ежемесячно относительно значения, указанного в столбце freq_interval; 64 = запускать при запуске службы SQLServerAgent. |
freq_interval |
int |
Дни, в которые выполняется задание. Значение зависит от значения в столбце freq_type. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL). |
freq_subday_type |
int |
Единицы для столбца freq_subday_interval. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL). |
freq_subday_interval |
int |
Число периодов, указанных в столбце freq_subday_type, которое должно пройти между выполнениями задания. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL). |
freq_relative_interval |
int |
Запланированное в расписании задание выполняется в момент, указанный в столбце freq_interval, каждый месяц. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL). |
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_description принимает значение 0, этот столбец содержит текст, указывающий, что описание не было запрошено. |
next_run_date |
int |
Дата следующего выполнения задания по расписанию. |
next_run_time |
int |
Время следующего выполнения задания по расписанию. |
schedule_uid |
uniqueidentifier |
Идентификатор расписания. |
job_count |
int |
Возвращенное количество заданий. |
| Примечание |
|---|
Хранимая процедура sp_help_jobschedule возвращает значения из системных таблиц dbo.sysjobschedules и dbo.sysschedules в базе данных msdb. Таблица sysjobschedules обновляется каждые 20 минут. Это может повлиять на значения, возвращаемые этой хранимой процедурой. |
Замечания
Параметры хранимой процедуры sp_help_jobschedule можно использовать только в определенных сочетаниях. Если указан аргумент schedule_id, нельзя указывать аргументы job_id и job_name. В противном случае аргументы job_id и job_name можно использовать с аргументом schedule_name.
Разрешения
Требуется членство в предопределенной роли сервера sysadmin. Другим пользователям должна быть предоставлена одна из следующих предопределенных ролей базы данных агента SQL Server в базе данных msdb:
SQLAgentUserRole;
SQLAgentReaderRole;
SQLAgentOperatorRole.
Дополнительные сведения о разрешениях для этих ролей см. в разделе Предопределенные роли базы данных агента SQL Server.
Члены роли SQLAgentUserRole могут лишь просматривать свойства их собственных расписаний заданий.
Примеры
А. Возвращение расписания задания для конкретного задания
Следующий пример возвращает сведения о расписании для задания с именем BackupDatabase.
USE msdb ;
GO
EXEC dbo.sp_help_jobschedule
@job_name = N'BackupDatabase' ;
GO
Б. Возвращение расписания задания для конкретного расписания
Следующий пример возвращает сведения о расписании с названием NightlyJobs и задании с названием RunReports.
USE msdb ;
GO
EXEC dbo.sp_help_jobschedule
@job_name = N'RunReports',
@schedule_name = N'NightlyJobs' ;
GO
В. Возвращение расписания задания и описания расписания для конкретного расписания
Следующий пример возвращает сведения о расписании с названием NightlyJobs и задании с названием RunReports. Возвращаемый результирующий набор включает описание расписания.
USE msdb ;
GO
EXEC dbo.sp_help_jobschedule
@job_name = N'RunReports',
@schedule_name = N'NightlyJobs',
@include_description = 1 ;
GO