Share via

sp_help_category (Transact-SQL)

  • 项目

适用于：SQL Server

提供有关作业、警报或操作员的指定类的信息。

Transact-SQL 语法约定

语法

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

参数

[ @class = ] 'class'

指定有关请求哪些信息的类。 @class 为 varchar（8），可以是以下值之一。

值 说明
JOB（默认值） 提供有关作业类别的信息。
ALERT 提供有关警报类别的信息。
OPERATOR 提供有关操作员类别的信息。

[ @type = ] 'type'

请求其信息的类别的类型。 @type是 varchar（12），可以是其中一个值。

值 说明
LOCAL 本地作业类别。
MULTI-SERVER 多服务器作业类别。
NONE 类的类别。JOB

[ @name = ] N'name'

请求其信息的类别的名称。 @name为 sysname，默认值为 NULL.

[ @suffix = ] 后缀

指定结果集中的 category_type 列是 ID 还是名称。 @suffix为位，默认值为 0.

  • 1 显示为 category_type 名称。
  • 0 显示为 category_type 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 数据库运行。

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

权限

此存储过程由 db_owner 角色拥有。 你可以为任何用户授予 EXECUTE 权限，但这些权限可能会在 SQL Server 升级期间被重写。

其他用户必须被授予数据库中以下SQL Server 代理固定数据库角色msdb之一：

  • 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

相关内容