共用方式為

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為 bit，預設值為 0。 當@attached_schedules_only為 0時，會顯示所有排程。 當@attached_schedules_only為 1時，結果集只會包含附加至作業的排程。

[ @include_description = ] include_description

指定是否要在結果集中包含描述。 @include_description為 bit，預設值為 0。 當 @include_description 為時，結果集@schedule_description數據行包含0佔位元。 當@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。
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 請列出 實例中所有排程的資訊。

權限

此預存程式是由 db_owner 角色所擁有。 您可以授與 EXECUTE 任何用戶的許可權，但這些許可權可能會在 SQL Server 升級期間覆寫。

其他用戶必須在資料庫中獲得下列其中一個 SQL Server Agent 固定資料庫角色 msdb ：

  • 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

相關內容