共用方式為

  • 發行項

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 資料行是識別碼或名稱。suffix 是 bit，預設值是 0。1 會將 category_type 顯示為名稱，0 則會顯示為識別碼。

傳回碼值

0 (成功) 或 1 (失敗)

結果集

當 @suffix 是 0 時，sp_help_category 會傳回下列結果集：

資料行名稱

資料類型

描述

category_id

int

類別目錄識別碼

category_type

tinyint

類別目錄的類型：

1 = 本機

2 = 多伺服器

3 = 無

name

sysname

類別目錄名稱

當 @suffix 是 1 時，sp_help_category 會傳回下列結果集：

資料行名稱

資料類型

描述

category_id

int

類別識別碼

category_type

sysname

類別目錄的類型。共有三種類型：LOCAL、MULTI-SERVER 和 NONE。

name

sysname

類別目錄名稱

備註

sp_help_category 必須從 msdb 資料庫中執行。

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

權限

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