sp_help_jobschedule (Transact-SQL)sp_help_jobschedule (Transact-SQL)

Применимо к:Applies to: даSQL ServerSQL Server (все поддерживаемые версии) yesSQL ServerSQL Server (all supported versions) Применимо к:Applies to: даSQL ServerSQL Server (все поддерживаемые версии) yesSQL ServerSQL Server (all supported versions)

Возвращает сведения о расписании выполнения заданий, используемом средой SQL Server Management StudioSQL Server Management Studio для выполнения автоматических действий.Returns information about the scheduling of jobs used by SQL Server Management StudioSQL Server Management Studio to perform automated activities.

Значок ссылки на раздел Синтаксические обозначения в Transact-SQLTopic link icon Transact-SQL Syntax Conventions

СинтаксисSyntax

  
sp_help_jobschedule { [ @job_id = ] job_id | [ @job_name = ] 'job_name' }  
     [ , [ @schedule_name = ] 'schedule_name' ]  
     [ , [ @schedule_id = ] schedule_id ]  
     [ , [ @include_description = ] include_description ]  

АргументыArguments

[ @job_id = ] job_id Идентификационный номер задания.[ @job_id = ] job_id The job identification number. job_idимеет тип uniqueidentifierи значение по умолчанию NULL.job_idis uniqueidentifier, with a default of NULL.

[ @job_name = ] 'job_name' Имя задания.[ @job_name = ] 'job_name' The name of the job. Аргумент job_nameимеет тип sysnameи значение по умолчанию NULL.job_nameis sysname, with a default of NULL.

Примечание

Необходимо указать либо job_id , либо job_name , но нельзя указать оба значения.Either job_id or job_name must be specified, but both cannot be specified.

[ @schedule_name = ] 'schedule_name' Имя элемента расписания для задания.[ @schedule_name = ] 'schedule_name' The name of the schedule item for the job. Аргумент schedule_nameимеет тип sysnameи значение по умолчанию NULL.schedule_nameis sysname, with a default of NULL.

[ @schedule_id = ] schedule_id Идентификационный номер элемента расписания для задания.[ @schedule_id = ] schedule_id The identification number of the schedule item for the job. schedule_idимеет тип intи значение по умолчанию NULL.schedule_idis int, with a default of NULL.

[ @include_description = ] include_description Указывает, следует ли включать описание расписания в результирующий набор.[ @include_description = ] include_description Specifies whether to include the description of the schedule in the result set. include_description имеет бити значение по умолчанию 0.include_description is bit, with a default of 0. Если include_description равен 0, описание расписания не включается в результирующий набор.When include_description is 0, the description of the schedule is not included in the result set. Если include_description равен 1, описание расписания включается в результирующий набор.When include_description is 1, the description of the schedule is included in the result set.

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

0 (успешное завершение) или 1 (неуспешное завершение)0 (success) or 1 (failure)

Результирующие наборыResult Sets

Имя столбцаColumn name Тип данныхData type ОписаниеDescription
schedule_idschedule_id intint Идентификационный номер расписания.Schedule identifier number.
schedule_nameschedule_name sysnamesysname Имя расписания.Name of the schedule.
доступнойenabled intint Включено ли расписание (1) или не включено (0).Whether the schedule enabled (1) or not enabled (0).
freq_typefreq_type intint Значение, указывающее, когда должно выполняться задание.Value indicating when the job is to be executed.

1 = один раз1 = Once

4 = ежедневно4 = Daily

8 = еженедельно8 = Weekly

16 = ежемесячно16 = Monthly

32 = ежемесячно относительно freq_interval32 = Monthly, relative to the freq_interval

64 = запуск при запуске службы SQLServerAgent .64 = Run when SQLServerAgent service starts.
freq_intervalfreq_interval intint Дни, в которые выполняется задание.Days when the job is executed. Значение зависит от значения freq_type.The value depends on the value of freq_type. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL).For more information, see sp_add_schedule (Transact-SQL).
freq_subday_typefreq_subday_type intint Единицы для freq_subday_interval.Units for freq_subday_interval. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL).For more information, see sp_add_schedule (Transact-SQL).
freq_subday_intervalfreq_subday_interval intint Число периодов freq_subday_type , которые должны быть выполнены между выполнением задания.Number of freq_subday_type periods to occur between each execution of the job. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL).For more information, see sp_add_schedule (Transact-SQL).
freq_relative_intervalfreq_relative_interval intint Вхождение freq_interval запланированного задания в каждый месяц.Scheduled job's occurrence of the freq_interval in each month. Дополнительные сведения см. в разделе sp_add_schedule (Transact-SQL).For more information, see sp_add_schedule (Transact-SQL).
freq_recurrence_factorfreq_recurrence_factor intint Число месяцев между выполнениями задания по расписанию.Number of months between the scheduled execution of the job.
active_start_dateactive_start_date intint Дата, когда начинает действовать расписание.Date the schedule is activated.
active_end_dateactive_end_date intint Дата, когда прекращает действовать расписание.End date of the schedule.
active_start_timeactive_start_time intint Время суток, когда начинает действовать расписание.Time of the day the schedule starts.
active_end_timeactive_end_time intint Время суток, когда прекращает действовать расписание.Time of the day schedule ends.
date_createddate_created datetimedatetime Дата создания расписания.Date the schedule is created.
schedule_descriptionschedule_description nvarchar(4000)nvarchar(4000) Описание расписания на английском языке, полученное из значений в msdb.dbo.sysрасписаниях.An English description of the schedule that is derived from values in msdb.dbo.sysschedules. Если значение include_description равно 0, этот столбец содержит текст, указывающий, что описание не было запрошено.When include_description is 0, this column contains text stating that the description was not requested.
next_run_datenext_run_date intint Дата следующего выполнения задания в соответствии с расписанием.Date the schedule will next cause the job to run.
next_run_timenext_run_time intint Время следующего выполнения задания в соответствии с расписанием.Time the schedule will next cause the job to run.
schedule_uidschedule_uid uniqueidentifieruniqueidentifier Идентификатор расписания.Identifier for the schedule.
job_countjob_count intint Возвращенное количество заданий.Count of jobs returned.

Примечание. sp_help_jobschedule возвращает значения из dbo.sysжобсчедулес и dbo.sysрасписаний системных таблиц в базе данных msdb.NOTE: sp_help_jobschedule returns values from the dbo.sysjobschedules and dbo.sysschedules system tables in msdb. sysjobschedules обновляются каждые 20 минут.sysjobschedules updates every 20 minutes. Это может повлиять на значения, возвращаемые этой хранимой процедурой.This might affect the values that are returned by this stored procedure.

ПримечанияRemarks

Параметры sp_help_jobschedule могут использоваться только в определенных сочетаниях.The parameters of sp_help_jobschedule can be used only in certain combinations. Если указан schedule_id , нельзя указать ни job_id , ни job_name .If schedule_id is specified, neither job_id nor job_name can be specified. В противном случае можно использовать параметры job_id или job_name с schedule_name.Otherwise, the job_id or job_name parameters can be used with schedule_name.

РазрешенияPermissions

Необходимо членство в предопределенной роли сервера sysadmin .Requires membership in the sysadmin fixed server role. Другим пользователям должна быть предоставлена одна из следующих предопределенных ролей базы данных агента SQL ServerSQL Server в базе данных msdb :Other users must be granted one of the following SQL ServerSQL Server Agent fixed database roles in the msdb database:

  • SQLAgentUserRoleSQLAgentUserRole

  • SQLAgentReaderRoleSQLAgentReaderRole

  • SQLAgentOperatorRoleSQLAgentOperatorRole

Дополнительные сведения о разрешениях этих ролей см. в разделе Предопределенные роли базы данных агента SQL Server.For details about the permissions of these roles, see SQL Server Agent Fixed Database Roles.

Члены SQLAgentUserRole могут только просматривать свойства расписаний заданий, которыми они владеют.Members of SQLAgentUserRole can only view properties of job schedules that they own.

ПримерыExamples

A.A. Возвращение расписания задания для конкретного заданияReturning the job schedule for a specific job

Следующий пример возвращает сведения о расписании для задания с именем BackupDatabase.The following example returns the scheduling information for a job named BackupDatabase.

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

Б.B. Возвращение расписания задания для конкретного расписанияReturning the job schedule for a specific schedule

Следующий пример возвращает сведения о расписании с названием NightlyJobs и задании с названием RunReports.The following example returns the information for the schedule named NightlyJobs and the job named RunReports.

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

В.C. Возвращение расписания задания и описания расписания для конкретного расписанияReturning the job schedule and schedule description for a specific schedule

Следующий пример возвращает сведения о расписании с названием NightlyJobs и задании с названием RunReports.The following example returns the information for the schedule named NightlyJobs and the job named RunReports. Возвращаемый результирующий набор включает описание расписания.The result set returned includes a description of the schedule.

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

См. такжеSee Also

sp_add_schedule (Transact-SQL) sp_add_schedule (Transact-SQL)
sp_delete_schedule (Transact-SQL) sp_delete_schedule (Transact-SQL)
sp_update_schedule (Transact-SQL) sp_update_schedule (Transact-SQL)
Системные хранимые процедуры (Transact-SQL)System Stored Procedures (Transact-SQL)