sp_help_category (Transact-SQL)

適用対象:SQL Server

ジョブ、警告、またはオペレーターについて、指定されたクラスの情報を提供します。

Transact-SQL 構文表記規則

構文

  
sp_help_category [ [ @class = ] 'class' ]   
     [ , [ @type = ] 'type' ]   
     [ , [ @name = ] 'name' ]   
     [ , [ @suffix = ] suffix ]   

引数

[ @class = ] 'class' 情報が要求されるクラス。 クラス は varchar(8)で、既定値は JOB です。 クラス には、次のいずれかの値を指定できます。

値	説明
ジョブ	ジョブ カテゴリに関する情報を提供します。
警告	アラート カテゴリに関する情報を提供します。
演算子	オペレーター カテゴリに関する情報

[ @type = ] 'type' 情報が要求されるカテゴリの種類。 type は varchar(12)で、既定値は NULL で、これらの値のいずれかを指定できます。

値	説明
LOCAL	ローカル ジョブ カテゴリ。
MULTI -SERVER	マルチサーバー ジョブ カテゴリ。
NONE	JOB 以外のクラスのカテゴリ。

[ @name = ] 'name' 情報が要求されるカテゴリの名前。 name は sysname で、既定値は NULL です。

[ @suffix = ] suffix 結果セットの category_type 列が ID か名前かを指定します。 サフィックス は bit で、既定値は 0 です。 1 は category_type を名前として示し、 0 は ID として表示します。

リターン コードの値

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

結果セット

@suffixが 0 の場合、sp_help_categoryは次の結果セットを返します。

列名	データ型	説明
category_id	int	カテゴリ ID。
category_type	tinyint	カテゴリの種類: 1 = ローカル 2 = マルチサーバー 3 = なし
name	sysname	カテゴリ名

@suffixが 1 の場合、sp_help_categoryは次の結果セットを返します。

列名	データ型	説明
category_id	int	カテゴリ ID。
category_type	sysname	カテゴリの種類。 LOCAL、MULTI-SERVER、または NONE のいずれか
name	sysname	カテゴリ名

解説

sp_help_categoryは、msdb データベースから実行する必要があります。

パラメーターを指定しない場合、結果セットではすべてのジョブ カテゴリに関する情報が提供されます。

アクセス許可

既定では、このストアド プロシージャを実行できるのは、 sysadmin 固定サーバー ロールのメンバーです。 他のユーザーには、 SQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。

• 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  

参照

sp_add_category (Transact-SQL)
sp_delete_category (Transact-SQL)
sp_update_category (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)