共用方式為


sp_help_schedule (Transact-SQL)

列出排程的相關資訊。

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

語法

sp_help_schedule 
     [ @schedule_id = ] id ,
     [ @schedule_name = ] 'schedule_name' 
     [ , [ @attached_schedules_only = ] attached_schedules_only ]
     [ , [ @include_description = ] include_description ]

引數

  • [ @schedule_id = ] id
    這是要列出的排程識別碼。 schedule_name 是 int,沒有預設值。 您只能指定 schedule_id 或 schedule_name 其中之一。

  • [ @schedule_name = ] 'schedule_name'
    這是要列出的排程名稱。 schedule_name 是 sysname,沒有預設值。 您只能指定 schedule_id 或 schedule_name 其中之一。

  • [ @attached_schedules_only = ] attached_schedules_only ]
    指定是否只顯示作業所連接的排程。 attached_schedules_only 是 bit,預設值是 0。 當 attached_schedules_only 是 0 時,會顯示所有排程。 當 attached_schedules_only 是 1 時,結果集只包含作業所連接的排程。

  • [ @include_description = ] include_description
    指定是否在結果集中併入說明。 include_description 是 bit,預設值是 0。 當 include_description 是 0 時,結果集的 schedule_description 資料行包含預留位置。 當 include_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) 固定伺服器角色的成員,才能夠執行這個預存程序。 其他使用者必須被授與 msdb 資料庫的下列其中一個 SQL Server Agent 固定資料庫角色。

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

如需有關這些角色權限的詳細資料,請參閱<SQL Server Agent 固定資料庫角色>。

SQLAgentUserRole 的成員只能檢視他們自己的排程。

範例

A.列出執行個體中所有排程的資訊

下列範例會列出執行個體中所有排程的資訊。

USE msdb ;
GO

EXEC dbo.sp_help_schedule ;
GO

B.列出特定排程的資訊

下列範例會列出名稱為 NightlyJobs 之排程的資訊。

USE msdb ;
GO

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

請參閱

參考

sp_add_schedule (Transact-SQL)

sp_attach_schedule (Transact-SQL)

sp_delete_schedule (Transact-SQL)

sp_detach_schedule (Transact-SQL)