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' 要求的資訊所屬的類別目錄類型。 typeVarchar (12),預設值是 Null,而且可以是下列其中一個值。

描述
LOCAL 本機作業類別目錄。
MULTI -SERVER 多伺服器作業類別目錄。
NONE 作業 以外類別的類別。

[ @name = ] 'name' 要求的資訊所屬的類別目錄名稱。 名稱sysname,預設值是 Null。

[ @suffix = ] suffix 指定結果集中的 category_type 資料行是否為識別碼或名稱。 尾碼bit,預設值是 01 以名稱顯示 category_type0 則顯示為識別碼。

傳回碼值

0 (成功) 或 1 (失敗)

結果集

@ 尾碼0 時, sp_help_category 會傳回下列結果集:

資料行名稱 資料類型 描述
category_id int 類別目錄識別碼
category_type tinyint 類別目錄類型:

1 = 本機

2 = 多伺服器

3 = 無
name sysname 類別目錄名稱

@ 尾碼1 時, sp_help_category 會傳回下列結果集:

資料行名稱 資料類型 描述
category_id int 類別目錄識別碼
category_type sysname 類別目錄的類型。 其中一個 本機多伺服器
name sysname 類別目錄名稱

備註

sp_help_category 必須從 msdb 資料庫執行。

如果未指定任何參數,結果集會提供所有作業類別目錄的相關資訊。

權限

依預設,只有 系統管理員 (sysadmin) 固定伺服器角色的成員,才能夠執行這個預存程序。 其他使用者必須被授與 SQL Server msdb 資料庫的下列其中一個 Agent 固定資料庫角色。

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

如需這些角色權限的詳細資訊,請參閱 SQL Server Agent 固定資料庫角色

範例

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)