sp_help_schedule (Transact-SQL)
Возвращает информацию о расписаниях.
.gif "Значок ссылки на раздел")
Синтаксис
sp_help_schedule
[ @schedule_id = ] id ,
[ @schedule_name = ] 'schedule_name'
[ , [ @attached_schedules_only = ] attached_schedules_only ]
[ , [ @include_description = ] include_description ]
Аргументы
[ @schedule_id = ] id
Идентификатор расписания, информацию о котором следует возвратить. Этот аргумент имеет тип int и не имеет значения по умолчанию. При вызове процедуры можно указать schedule_id или schedule_name.[ @schedule_name = ] 'schedule_name'
Имя расписания, информацию о котором следует возвратить. Этот аргумент имеет тип sysname и не имеет значения по умолчанию. При вызове процедуры можно указать schedule_id или schedule_name.[ @attached_schedules_only = ] attached_schedules_only ]
Этот аргумент указывает, следует ли возвратить информацию только о расписаниях, связанных с заданиями. Он имеет тип bit и значение по умолчанию 0. Если аргумент attached_schedules_only равен 0, то выводится информация о всех расписаниях. Если этот аргумент равен 1, то результирующий набор содержит информацию только о расписаниях, связанных с заданиями.[ @include_description = ] include_description
Этот аргумент указывает, следует ли включить в результирующий набор описания. Он имеет тип bit и значение по умолчанию 0. Если он равен 0, то столбец schedule_description результирующего набора содержит заполнитель. Если этот аргумент равен 1, то в результирующий набор включается описание расписания.
Значения кодов возврата
0 (успешное завершение) или 1 (неуспешное завершение)
Результирующие наборы
Данная процедура возвращает следующий результирующий набор:
Имя столбца |
Тип данных |
Описание |
|---|---|---|
schedule_id |
int |
Идентификационный номер расписания. |
schedule_uid |
uniqueidentifier |
Идентификатор расписания. |
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) |
Описание расписания на английском языке (если запрошено). |
job_count |
int |
Число заданий, ссылающихся на данное расписание. |
Замечания
Если никакие параметры не указаны, хранимая процедура sp_help_schedule возвращает информацию о всех расписаниях в экземпляре.
Разрешения
По умолчанию эту хранимую процедуру могут выполнять элементы предопределенной роли сервера sysadmin. Другим пользователям должна быть предоставлена одна из следующих предопределенных ролей базы данных агента SQL Server в базе данных msdb:
SQLAgentUserRole
SQLAgentReaderRole
SQLAgentOperatorRole
Дополнительные сведения о разрешениях для этих ролей см. в разделе Предопределенные роли базы данных агента SQL Server.
Элементы роли SQLAgentUserRole могут только просматривать принадлежащие им расписания.
Примеры
А. Получение информации о всех расписаниях в экземпляре
Следующий пример выводит информацию о всех расписаниях в экземпляре.
USE msdb ;
GO
EXEC dbo.sp_help_schedule ;
GO
Б. Получение информации о конкретном расписании
Следующий пример выводит информацию о расписании NightlyJobs.
USE msdb ;
GO
EXEC dbo.sp_help_schedule
@schedule_name = N'NightlyJobs' ;
GO