sp_help_schedule (Transact-SQL)

適用対象:SQL Server

スケジュールに関する情報を一覧表示します。

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 は ビットであり、既定値は 0 です。 attached_schedules_onlyが 0 の場合、すべてのスケジュールが表示されます。 attached_schedules_onlyが 1 の場合、結果セットにはジョブにアタッチされているスケジュールのみが含まれます。

[ @include_description = ] include_description 結果セットに説明を含めるかどうかを指定します。 include_description は ビットであり、既定値は 0 です。 include_descriptionが 0 の場合、結果セットのschedule_description列にはプレースホルダーが含まれます。 include_descriptionが 1 の場合、スケジュールの説明が結果セットに含まれます。

リターン コードの値

0 (成功) または 1 (失敗)

結果セット

このプロシージャは、次の結果セットを返します。

列名	データ型	説明
schedule_id	int	スケジュール識別子番号。
schedule_uid	uniqueidentifier	スケジュールの識別子。
schedule_name	sysname	スケジュールの名前。
有効	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 固定サーバー ロールのメンバーです。 他のユーザーには、 SQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。

• 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  

参照

sp_add_schedule (Transact-SQL)
sp_attach_schedule (Transact-SQL)
sp_delete_schedule (Transact-SQL)
sp_detach_schedule (Transact-SQL)