Поделиться через

sp_help_schedule (Transact-SQL)

  • Статья

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

Возвращает информацию о расписаниях.

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

Синтаксис

sp_help_schedule
    [ [ @schedule_id = ] schedule_id ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @attached_schedules_only = ] attached_schedules_only ]
    [ , [ @include_description = ] include_description ]
[ ; ]

Аргументы

[ @schedule_id = ] schedule_id

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

Можно указать @schedule_id или @schedule_name.

[ @schedule_name = ] N'schedule_name'

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

Можно указать @schedule_id или @schedule_name.

[ @attached_schedules_only = ] attached_schedules_only

Этот аргумент указывает, следует ли возвратить информацию только о расписаниях, связанных с заданиями. @attached_schedules_only имеет значение по умолчанию0. При @attached_schedules_only 0отображаются все расписания. Если @attached_schedules_only , 1результирующий набор содержит только расписания, присоединенные к заданию.

[ @include_description = ] include_description

Этот аргумент указывает, следует ли включить в результирующий набор описания. @include_description бит с значением по умолчанию0. Если @include_description, столбец @schedule_description 0 результирующий набор содержит заполнитель. При @include_description 1описание расписания включается в результирующий набор.

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

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

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

Данная процедура возвращает следующий результирующий набор:

Имя столбца Тип данных Description
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.
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) Описание расписания на английском языке (если запрошено).
job_count int Число заданий, ссылающихся на данное расписание.

Замечания

Если параметры отсутствуют, sp_help_schedule выводится список сведений обо всех расписаниях в экземпляре.

Разрешения

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

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

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

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

Члены SQLAgentUserRole могут просматривать только собственные расписания.

Примеры

А. Список сведений обо всех расписаниях в экземпляре

Следующий пример выводит информацию о всех расписаниях в экземпляре.

USE msdb;
GO

EXEC dbo.sp_help_schedule;
GO

B. Перечисление сведений для определенного расписания

Следующий пример выводит информацию о расписании NightlyJobs.

USE msdb;
GO

EXEC dbo.sp_help_schedule
    @schedule_name = N'NightlyJobs';
GO

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