sp_help_job (Transact-SQL)

適用対象:SQL Server

SQL Server で自動アクティビティを実行するためにSQL Server エージェントによって使用されるジョブに関する情報を返します。

Transact-SQL 構文表記規則

構文

sp_help_job
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @job_aspect = ] 'job_aspect' ]
    [ , [ @job_type = ] 'job_type' ]
    [ , [ @owner_login_name = ] N'owner_login_name' ]
    [ , [ @subsystem = ] N'subsystem' ]
    [ , [ @category_name = ] N'category_name' ]
    [ , [ @enabled = ] enabled ]
    [ , [ @execution_status = ] execution_status ]
    [ , [ @date_comparator = ] 'date_comparator' ]
    [ , [ @date_created = ] date_created ]
    [ , [ @date_last_modified = ] date_last_modified ]
    [ , [ @description = ] N'description' ]
[ ; ]

引数

[ @job_id = ] 'job_id'

ジョブ ID 番号。 @job_idは uniqueidentifier で、既定値は NULL.

特定のジョブを表示するには、@job_idまたは@job_nameを指定する必要があります。 すべてのジョブに関する情報を返すには、@job_idと@job_nameの両方を省略します。

[ @job_name = ] N'job_name'

ジョブの名前。 @job_nameは sysname で、既定値は NULL.

特定のジョブを表示するには、@job_idまたは@job_nameを指定する必要があります。 すべてのジョブに関する情報を返すには、@job_idと@job_nameの両方を省略します。

[ @job_aspect = ] 'job_aspect'

表示するジョブ属性を指定します。 @job_aspectは varchar(9) であり、これらの値のいずれかを指定できます。

[ @job_type = ] 'job_type'

レポートに含めるジョブの種類。@job_typeは varchar(12) で、既定値は NULL. @job_typeまたは LOCALMULTI-SERVER.

[ @owner_login_name = ] N'owner_login_name'

ジョブの所有者のログイン名を指定します。 @owner_login_nameは sysname で、既定値は NULL.

[ @subsystem = ] N'subsystem'

サブシステムの名前。 @subsystemは nvarchar(40) で、既定値は NULL.

[ @category_name = ] N'category_name'

カテゴリの名前。 @category_nameは sysname で、既定値は NULL.

[ @enabled = ] が有効

有効なジョブまたは無効なジョブの情報が表示されるかどうかを示す数値。 @enabledは tinyint で、既定値は NULL.

• 1 は、有効なジョブを示します。
• 0 は無効なジョブを示します。

[ @execution_status = ] execution_status

ジョブの実行状態を指定します。 @execution_statusは int であり、これらの値のいずれかになります。

[ @date_comparator = ] 'date_comparator'

@date_createdと@date_last_modifiedの比較に使用する比較演算子。 @date_comparatorは char(1)、=または . <>

[ @date_created = ] date_created

ジョブが作成された日付を指定します。 @date_createdは datetime で、既定値は NULL.

[ @date_last_modified = ] date_last_modified

ジョブが最後に変更された日付を指定します。 @date_last_modifiedは datetime で、既定値は NULL.

[ @description = ] N'description'

ジョブの説明。 @descriptionは nvarchar(512) で、既定値は NULL. @descriptionパターン マッチング用のワイルドカード文字を含めることができます。

リターン コードの値

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

結果セット

引数が指定されていない場合は、 sp_help_job この結果セットを返します。

@job_idまたは@job_nameが指定されている場合は、ジョブ ステップ、sp_help_jobジョブ スケジュール、およびジョブ ターゲット サーバーに対して、これらの追加の結果セットを返します。

次に、ジョブ ステップに関する結果セットを示します。

これはジョブ スケジュールの結果セットです。

次に、ジョブターゲット サーバーに関する結果セットを示します。

アクセス許可

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

他のユーザーには、データベース内の固定データベース ロールSQL Server エージェント次のいずれかを付与するmsdb必要があります。

• SQLAgentUserRole
• SQLAgentReaderRole
• SQLAgentOperatorRole

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

SQLAgentUserRole のメンバーは、自分が所有するジョブのみを表示できます。 sysadmin、SQLAgentReaderRole、SQLAgentOperatorRole のメンバーは、すべてのローカル ジョブとマルチサーバー ジョブを表示できます。

例

A. すべてのジョブの情報を一覧表示する

次の例では、 sp_help_job データベースで現在定義されているすべてのジョブの情報を返すパラメーターなしでプロシージャを msdb 実行します。

USE msdb;
GO

EXEC dbo.sp_help_job;
GO

B. 特定の条件に一致するジョブの情報を一覧表示する

次の例では、françoisa が所有するマルチサーバー ジョブのジョブ情報を一覧表示します。ここでは、有効でかつ、実行中のジョブが対象になります。

USE msdb;
GO

EXEC dbo.sp_help_job
   @job_type = N'MULTI-SERVER',
   @owner_login_name = N'françoisa',
   @enabled = 1,
   @execution_status = 1;
GO

C: ジョブの情報のすべての側面を一覧表示する

次の例では、NightlyBackups ジョブに関するすべての属性情報を一覧表示します。

USE msdb;
GO

EXEC dbo.sp_help_job
    @job_name = N'NightlyBackups',
    @job_aspect = N'ALL';
GO

関連するコンテンツ

• sp_add_job (Transact-SQL)
• sp_delete_job (Transact-SQL)
• sp_update_job (Transact-SQL)
• システム ストアド プロシージャ (Transact-SQL)