sp_help_category (Transact-SQL)
適用於:SQL Server
提供指定之作業、警示或運算符類別的相關信息。
語法
sp_help_category
[ [ @class = ] 'class' ]
[ , [ @type = ] 'type' ]
[ , [ @name = ] N'name' ]
[ , [ @suffix = ] suffix ]
[ ; ]
引數
[ @class = ] 'class'
指定要求哪些信息的類別。 @class為 varchar(8),而且可以是下列其中一個值。
值 | Description |
---|---|
JOB (預設值) |
提供作業類別目錄的相關信息。 |
ALERT |
提供警示類別的相關信息。 |
OPERATOR |
提供運算子類別的相關信息。 |
[ @type = ] 'type'
要求信息的類別類型。 @type為 varchar(12),而且可以是下列其中一個值。
值 | Description |
---|---|
LOCAL |
本機作業類別目錄。 |
MULTI-SERVER |
多伺服器作業類別目錄。 |
NONE |
以外的 JOB 類別類別分類。 |
[ @name = ] N'name'
要求資訊的類別名稱。 @name為 sysname,預設值為 NULL
。
[ @suffix = ] 後綴
指定結果集中的數據 category_type
行是識別碼或名稱。 @suffix為 bit,預設值為 0
。
1
category_type
會將 顯示為名稱。0
category_type
會將 顯示為識別碼。
傳回碼值
0
(成功) 或 1
(失敗)。
結果集
當 @suffix 為 0
時,sp_help_category
會傳回下列結果集:
資料行名稱 | 資料類型 | 描述 |
---|---|---|
category_id |
int | 分類 ID |
category_type |
tinyint | 類別類型:1 = 本機2 = Multiserver3 = 無 |
name |
sysname | 類別名稱 |
當 @suffix 為 1
時,sp_help_category
會傳回下列結果集:
資料行名稱 | 資料類型 | 描述 |
---|---|---|
category_id |
int | 分類 ID |
category_type |
sysname | 類別的類型。 其中一個 LOCAL 、 MULTI-SERVER 或 NONE |
name |
sysname | 類別名稱 |
備註
sp_help_category
必須從 msdb
資料庫執行。
如果未指定任何參數,結果集會提供所有作業類別的相關信息。
權限
您可以授與此 EXECUTE
程序的許可權,但這些許可權可能會在 SQL Server 升級期間覆寫。
其他用戶必須在資料庫中獲得下列其中一個 SQL Server Agent 固定資料庫角色 msdb
:
- 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