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 ジョブ ID 番号。 job_idは uniqueidentifier で、既定値は NULL です。

[ @job_name = ] 'job_name' ジョブの名前。 job_nameは sysname で、既定値は NULL です。

注意

job_idまたはjob_nameを指定する必要がありますが、両方を指定することはできません。

[ @schedule_name = ] 'schedule_name' ジョブのスケジュール項目の名前。 schedule_nameは sysname で、既定値は NULL です。

[ @schedule_id = ] schedule_id ジョブのスケジュール項目の識別番号。 schedule_idは int で、既定値は NULL です。

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

リターン コードの値

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

結果セット

列名 データ型 説明
schedule_id int スケジュール識別子番号。
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) msdb.dbo.sysschedules の値から派生したスケジュールの英語の説明。 include_descriptionが 0 の場合、この列には説明が要求されなかったことを示すテキストが含まれます。
next_run_date int スケジュールが次にジョブを実行する日付。
next_run_time int スケジュールが次にジョブを実行する時間。
schedule_uid uniqueidentifier スケジュールの識別子。
job_count int 返されたジョブの数。

注意

sp_help_jobschedule** は、msdb の dbo.sysjobschedules および dbo.sysschedules システム テーブルから値を返します。 sysjobschedules は 20 分ごとに更新されます。 これは、このストアド プロシージャによって返される値に影響する可能性があります。

解説

sp_help_jobscheduleのパラメーターは、特定の組み合わせでのみ使用できます。 schedule_idを指定した場合、job_idもjob_nameも指定できません。 それ以外の場合は、 job_id または job_name パラメーターを schedule_nameと共に使用できます。

アクセス許可

sysadmin 固定サーバー ロールのメンバーシップが必要です。 他のユーザーには、 SQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

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

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 (Transact-SQL)
sp_delete_schedule (Transact-SQL)
sp_update_schedule (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)