SQLServerでのsp_help_scheduleの使用

SQL Serverでは、sp_help_schedule ストアドプロシージャは、SQLServerエージェントのスケジュールに関する情報を返します。

この記事では、例を含むこのストアドプロシージャの概要を説明します。

構文

公式の構文は次のようになります：

sp_help_schedule   
     [ @schedule_id = ] id ,  
     [ @schedule_name = ] 'schedule_name'   
     [ , [ @attached_schedules_only = ] attached_schedules_only ]  
     [ , [ @include_description = ] include_description ]

sp_help_scheduleを呼び出すことができます、パラメータありまたはなし。

パラメータなしで呼び出すと、インスタンス内のすべてのスケジュールのリストが返されます。

スケジュール名またはIDのいずれかを渡すと、そのスケジュールだけが返されます。

sp_help_scheduleに注意してください msdbにありますデータベースなので、そこから実行する必要があります。これは、 msdbに切り替えることで実行できます。データベース（例：USE msdb ）、またはデータベース名とスキーマ（つまり、msdb.dbo.sp_help_scheduleでプロシージャを修飾することによって）。

例

インスタンス内のすべてのスケジュールを返す方法を示す例を次に示します。

EXEC msdb.dbo.sp_help_schedule;

結果：

名前に基づいてスケジュールを返す

名前に基づいてスケジュールを取得することもできます：

EXEC msdb.dbo.sp_help_schedule
	@schedule_name = 'Weekly_Sun_3AM';

IDに基づいてスケジュールを返す

または、IDに基づいてスケジュールを取得することもできます：

EXEC msdb.dbo.sp_help_schedule
	@schedule_id = 14;

添付のスケジュールのみを返す

sp_help_schedule 特定のジョブのスケジュールを返しません（sp_help_jobscheduleを使用してください）そのため）、それを使用して、ジョブに関連付けられているスケジュールのみを返すことができます。

これは、@attached_schedules_onlyを使用して行うことができますパラメータ。

@attached_schedules_only パラメータはビットです、デフォルトは0 、これは、アタッチされたスケジュールとアタッチされていないスケジュールの両方を返すことを意味します。 1の値を渡す添付されたスケジュールのみに制限します。

例：

EXEC sp_help_schedule
	@attached_schedules_only = 1;

説明を含める

もう1つできることは、スケジュールの説明を含めるかどうかを指定することです。

デフォルトでは、説明は結果セットに含まれていません。実際、schedule_description 列はです含まれていますが、明示的に要求しない限り、説明は含まれていません。リクエストしない場合は、schedule_description 列に(Description not requested.) 。

@include_description パラメータはビットです、デフォルトは0 、つまり、説明は表示されません。 1の値を渡す説明が表示されます。

EXEC sp_help_jobschedule
	@job_name = 'SqlAgentTest',
	@include_description = 1;