sp_help_category (Transact-SQL)
適用対象: 
SQL サーバー
ジョブ、警告、またはオペレーターについて、指定されたクラスの情報を提供します。
構文
sp_help_category
[ [ @class = ] 'class' ]
[ , [ @type = ] 'type' ]
[ , [ @name = ] N'name' ]
[ , [ @suffix = ] suffix ]
[ ; ]
引数
[ @class = ] 'class'
情報を要求するクラスを指定します。 @class は varchar(8)であり、これらの値のいずれかを指定できます。
| Value | 説明 |
|---|---|
JOB (既定値) |
ジョブ カテゴリに関する情報を提供します。 |
ALERT |
アラート カテゴリに関する情報を提供します。 |
OPERATOR |
オペレーター カテゴリに関する情報 |
[ @type = ] 'type'
情報が要求されるカテゴリの種類。 @type は varchar(12)であり、これらの値のいずれかになります。
| Value | 説明 |
|---|---|
LOCAL |
ローカル ジョブ カテゴリ。 |
MULTI-SERVER |
マルチサーバー ジョブ カテゴリ。 |
NONE |
JOB以外のクラスのカテゴリ。 |
[ @name = ] N'name'
要求する情報に関するカテゴリの名前を指定します。 @name は sysname で、既定値は NULL です。
[ @suffix = ] suffix
結果セットの category_type 列が ID か名前かを指定します。 @suffix は bit で、既定値は 0 です。
1には、category_typeが名前として表示されます。0には、category_typeが ID として表示されます。
リターン コードの値
0 (成功) または 1 (失敗)。
結果セット
@suffixが0されると、sp_help_categoryは次の結果セットを返します。
| 列名 | データ型 | 説明 |
|---|---|---|
category_id |
int | Category ID |
category_type |
tinyint | カテゴリの種類:1 = ローカル2 = マルチサーバー3 = なし |
name |
sysname | カテゴリ名 |
@suffixが1されると、sp_help_categoryは次の結果セットを返します。
| 列名 | データ型 | 説明 |
|---|---|---|
category_id |
int | Category ID |
category_type |
sysname | カテゴリの種類。 LOCAL、MULTI-SERVER、または NONE のいずれか |
name |
sysname | カテゴリ名 |
解説
sp_help_category は、 msdb データベースから実行する必要があります。
パラメーターを指定しない場合、結果セットではすべてのジョブ カテゴリに関する情報が提供されます。
アクセス許可
このストアド プロシージャは、 db_owner ロールによって所有されています。 EXECUTEアクセス許可は任意のユーザーに付与できますが、SQL Server のアップグレード中にこれらのアクセス許可がオーバーライドされる可能性があります。
他のユーザーには、msdb データベース内の次SQL Server エージェント固定データベース ロールのいずれかを付与する必要があります。
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。
例
A. ローカル ジョブ情報を返す
次の例では、ローカルで管理されるジョブに関する情報を返します。
USE msdb;
GO
EXEC dbo.sp_help_category @type = N'LOCAL';
GO
B. アラート情報を返す
次の例では、レプリケーション アラート カテゴリに関する情報を返します。
USE msdb;
GO
EXEC dbo.sp_help_category
@class = N'ALERT',
@name = N'Replication';
GO