sp_help_jobschedule （Transact-SQL）

發行項
11/07/2023

適用於：SQL Server

傳回 SQL Server Management Studio 用來執行自動化活動之作業排程的相關資訊。

語法

  
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。

注意

必須指定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 為位，預設值為 0 。當include_description 為 0 時 ，排程的描述不會包含在結果集中。當include_description 為 1 時 ，排程的描述會包含在結果集中。

傳回碼值

0 (成功) 或 1 (失敗)

結果集

資料行名稱	資料類型	描述
schedule_id	int	排程識別碼。
schedule_name	sysname	排程的名稱。
「已啟用」	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** 會從 msdb 中的 dbo.sysjobschedules 和 dbo.sysschedules 系統資料表傳 回值。 sysjobschedule 會 每隔 20 分鐘更新一次。這可能會影響這個預存程式所傳回的值。

備註

sp_help_jobschedule 的參數 只能在特定組合中使用。如果 指定了schedule_id ，就無法 指定job_id 或 job_name 。否則， job_id 或 job_name 參數可以搭配 schedule_name 使用。

權限

需要 系統管理員 (sysadmin) 固定伺服器角色中的成員資格。其他使用者必須獲授與 msdb 資料庫的下列其中一個 SQL Server Agent 固定資料庫角色：

SQLAgentUserRole
SQLAgentReaderRole
SQLAgentOperatorRole

如需這些角色權限的詳細資訊，請參閱 SQL Server Agent 固定資料庫角色。

SQLAgentUserRole 的成員只能檢視其擁有之作業排程的屬性。

範例

A. 傳回特定作業的作業排程

下列範例會傳回名為 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

另請參閱

sp_add_schedule (Transact-SQL)
sp_delete_schedule （Transact-SQL）
sp_update_schedule (Transact-SQL)
系統預存程序 (Transact-SQL)