sp_help_jobschedule (Transact-SQL)

適用範圍: 是SQL Server (所有支援的版本)

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

主題連結圖示 Transact-SQL 語法慣例

語法

  
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_iduniqueidentifier,預設值是 Null。

[ @job_name = ] 'job_name' 作業的名稱。 job_namesysname,預設值是 Null。

注意

必須指定 job_idjob_name ,但不能同時指定兩者。

[ @schedule_name = ] 'schedule_name' 作業的排程專案名稱。 schedule_namesysname,預設值是 Null。

[ @schedule_id = ] schedule_id 作業的排程專案識別碼。 schedule_idint,預設值是 Null。

[ @include_description = ] include_description 指定是否要在結果集中包含排程的描述。 include_descriptionbit,預設值是 0。 當 include_description0 時,不會將排程的描述包含在結果集中。 當 include_description1 時,排程的描述會包含在結果集中。

傳回碼值

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 (SQL)
freq_subday_type int Freq_subday_interval 的單位。 如需詳細資訊,請參閱sp_add_schedule (SQL)
freq_subday_interval int 每次執行作業之間發生的 freq_subday_type 期間數。 如需詳細資訊,請參閱sp_add_schedule (SQL)
freq_relative_interval int 每個月的排程工作發生 freq_interval 。 如需詳細資訊,請參閱sp_add_schedule (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. sysschedules 中的值衍生的排程的英文描述。 當 include_description0 時,此資料行會包含文字,指出未要求描述。
next_run_date int 排程下次執行作業的日期。
next_run_time int 排程下次執行作業的時間。
schedule_uid uniqueidentifier 排程的識別碼。
job_count int 傳回的作業計數。

注意: sp_help_jobschedule 會從 msdb 中的 dbo. sysjobschedulesdbo. sysschedules 系統資料表傳回值。 sysjobschedules 每隔20分鐘更新一次。 這可能會影響這個預存程序所傳回的值。

備註

Sp_help_jobschedule 的參數只能用於特定組合。 如果指定 schedule_id ,就不能同時指定 job_idjob_name 。 否則, job_idjob_name 參數可以搭配 schedule_name 使用。

權限

需要 系統管理員 (sysadmin) 固定伺服器角色中的成員資格。 其他使用者必須被授與 SQL Server msdb 資料庫的下列其中一個 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 (SQL transact-sql)
sp_delete_schedule (SQL transact-sql)
sp_update_schedule (SQL transact-sql)
系統預存程序 (Transact-SQL)