• [アーティクル]

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 = 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 エージェント固定データベース ロールが許可されている必要があります。

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

これらのロールの権限の詳細については、「SQL Server エージェントの固定データベース ロール」を参照してください。

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