• 项目

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 列是 ID 还是名称。suffix 的数据类型为 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

类别的类型。LOCAL、MULTI-SERVER 或 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