sp_help_category (Transact-SQL)

Proporciona información acerca de las clases especificadas de trabajos, alertas u operadores.

Convenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

• [ @class=] 'class'
  Es la clase sobre la que se solicita información. class es de tipo varchar(8) y su valor predeterminado es JOB. class puede tener los valores siguientes.

  Valor	Descripción
  JOB	Proporciona información acerca de una categoría de trabajo.
  ALERT	Proporciona información acerca de una categoría de alerta.
  OPERATOR	Proporciona información acerca de una categoría de operador.

• [ @type= ] 'type'
  Es el tipo de categoría cuya información se solicita. type es de tipo varchar(12), su valor predeterminado es NULL y puede tener los valores siguientes.

  Valor	Descripción
  LOCAL	Categoría de trabajo local.
  MULTI -SERVER	Categoría de trabajo multiservidor.
  NONE	Categoría para una clase distinta de JOB.

• [ @name= ] 'name'
  Es el nombre de la categoría para la que se solicita información. name es de tipo sysname y su valor predeterminado es NULL.

• [ @suffix= ] suffix
  Especifica si la columna category_type del conjunto de resultados es un Id. o un nombre. suffix es de tipo bit y su valor predeterminado es 0. 1 muestra category_type como nombre y 0 muestra esta opción como un Id.

Valores de código de retorno

0 (correcto) o 1 (error)

Conjuntos de resultados

Si @suffix es 0, sp_help_category devuelve el siguiente conjunto de resultados:

Nombre de columna	Tipo de datos	Descripción
category_id	int	Id. de categoría
category_type	tinyint	Tipo de categoría: 1 = Local 2 = Multiservidor 3 = Ninguno
name	sysname	Nombre de la categoría

Si @suffix es 1, sp_help_category devuelve el siguiente conjunto de resultados:

Nombre de columna	Tipo de datos	Descripción
category_id	int	Id. de categoría
category_type	sysname	Tipo de categoría. Puede ser LOCAL, MULTI-SERVER o NONE.
name	sysname	Nombre de la categoría

Comentarios

sp_help_category se debe ejecutar desde la base de datos msdb.

Si no se especifica ningún parámetro, el conjunto de resultados proporciona información acerca de todas las categorías de trabajo.

Permisos

De forma predeterminada, los miembros de la función fija de servidor sysadmin pueden ejecutar este procedimiento almacenado. A otros usuarios debe concederse una de las siguientes funciones fijas de base de datos del Agente SQL Server en la base de datos msdb:

• SQLAgentUserRole

• SQLAgentReaderRole

• SQLAgentOperatorRole

Para obtener más información acerca de los permisos de estas funciones, vea Funciones fijas de base de datos del Agente SQL Server.

Ejemplos

A. Devolver información de un trabajo local

Este ejemplo devuelve información acerca de los trabajos que se administran localmente.

USE msdb ;
GO

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

B. Devolver información de alertas

Este ejemplo devuelve información acerca de la categoría de alertas de replicación.

USE msdb ;
GO

EXEC dbo.sp_help_category
    @class = N'ALERT',
    @name = N'Replication' ;
GO

Vea también

Referencia

sp_add_category (Transact-SQL)

sp_delete_category (Transact-SQL)

sp_update_category (Transact-SQL)

Procedimientos almacenados del sistema (Transact-SQL)