sp_help_schedule (Transact-SQL)

適用対象: SQL サーバー

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

Transact-SQL 構文表記規則

構文

sp_help_schedule
    [ [ @schedule_id = ] schedule_id ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @attached_schedules_only = ] attached_schedules_only ]
    [ , [ @include_description = ] include_description ]
[ ; ]

引数

[ @schedule_id = ] schedule_id

一覧表示するスケジュールの識別子。 @schedule_id は int で、既定値は NULL です。

@schedule_idまたは@schedule_nameを指定できます。

[ @schedule_name = ] N'schedule_name'

一覧表示するスケジュールの名前。 @schedule_name は sysname で、既定値は NULL です。

@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 は ビットで、既定値は 0 です。 @include_descriptionが0されると、結果セットの@schedule_description列にプレースホルダーが含まれます。 @include_descriptionが1されると、スケジュールの説明が結果セットに含まれます。

リターン コードの値

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

結果セット

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

解説

パラメーターが指定されていない場合、 sp_help_schedule インスタンス内のすべてのスケジュールの情報が一覧表示されます。

アクセス許可

このストアド プロシージャは、 db_owner ロールによって所有されています。 EXECUTEアクセス許可は任意のユーザーに付与できますが、SQL Server のアップグレード中にこれらのアクセス許可がオーバーライドされる可能性があります。

他のユーザーには、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

関連するコンテンツ

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