sp_help_category (Transact-SQL)

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

Transact-SQL 構文表記規則

構文

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

引数

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

  値	説明
  JOB	ジョブ カテゴリに関する情報
  ALERT	警告カテゴリに関する情報
  OPERATOR	オペレータ カテゴリに関する情報

• [ @type= ] 'type'
  要求する情報に関するカテゴリの種類を指定します。type のデータ型は varchar(12) で、既定値は NULL です。次のいずれかの値を指定できます。

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

• [ @name= ] 'name'
  要求する情報に関するカテゴリの名前を指定します。name のデータ型は sysname で、既定値は NULL です。

• [ @suffix= ] suffix
  結果セットの category_type 列が ID と名前のどちらであるかを指定します。suffix のデータ型は 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 固定サーバー ロールのメンバです。他のユーザーには、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

関連項目

参照

sp_add_category (Transact-SQL)

sp_delete_category (Transact-SQL)

sp_update_category (Transact-SQL)

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