sp_help_jobschedule (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
  ジョブの識別番号を指定します。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 のデータ型は bit で、既定値は 0 です。include_description が 0 の場合は、スケジュールの説明が結果セットに含まれません。include_description が 1 の場合は、スケジュールの説明が結果セットに含まれます。

リターン コードの値

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

結果セット

注
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 のメンバシップが必要です。他のユーザーには、msdb データベースにおける次のいずれかの SQL Server エージェント固定データベース ロールが許可されている必要があります。

• SQLAgentUserRole

• SQLAgentReaderRole

• SQLAgentOperatorRole

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

SQLAgentUserRole のメンバは、自分が所有しているジョブ スケジュールのプロパティだけを表示できます。

例

A. 特定のジョブのジョブ スケジュールを返す

USE msdb ;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'BackupDatabase' ;
GO

B. 特定のスケジュールのジョブ スケジュールを返す

USE msdb ;
GO

EXEC dbo.sp_help_jobschedule 
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs' ;
GO

C. 特定スケジュールのジョブ スケジュールとスケジュール説明を返す

USE msdb ;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs',
    @include_description = 1 ;
GO

関連項目

参照