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。 类 可以是其中一个值。

Value 说明
工作 提供有关作业类别的信息。
警报 提供有关警报类别的信息。
算子 提供有关操作员类别的信息。

[ @type = ] 'type' 请求其信息的类别的类型。 type 为 varchar (12) ，默认值为 NULL，可以是以下值之一。

Value 说明
LOCAL 本地作业类别。
MULTI-SERVER 多服务器作业类别。
NONE 作业以外的类的类别。

[ @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 类别的类型。 本地、多服务器或 NONE 之一
name sysname 类别名称

备注

必须 从 msdb 数据库运行sp_help_category。

如果未指定参数，则结果集将提供有关所有作业类别的信息。

权限

默认情况下，只有 sysadmin 固定服务器角色的成员才可以执行此存储过程。 其他用户必须被授予 msdb 数据库中下列 SQL Server 代理固定数据库角色的权限之一：

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

有关这些角色的权限的详细信息，请参阅 SQL Server 代理固定数据库角色。

示例

A. 返回本地作业信息

以下示例将返回有关在本地管理的作业的信息。

USE msdb ;  
GO  
  
EXEC dbo.sp_help_category  
    @type = N'LOCAL' ;  
GO

B. 返回警报信息

以下示例将返回有关 Replication 警报类别的信息。

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)