sp_help_category (Transact-SQL)

Fornece informações sobre as classes especificadas de trabalhos, alertas ou operadores.

Convenções de sintaxe Transact-SQL

Sintaxe

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

Argumentos

• [ @class=] 'class'
  A classe sobre a qual as informações são solicitadas. class é varchar(8), com o valor padrão JOB. class pode ser um destes valores.

  Valor	Descrição
  JOB	Fornece informações sobre uma categoria de trabalho.
  ALERT	Fornece informações sobre uma categoria de alerta.
  OPERATOR	Fornece informações sobre uma categoria de operador.

• [ @type= ] 'type'
  O tipo de categoria para a qual as informações são solicitadas. type é varchar(12), com um valor padrão NULL, e pode ser um destes valores.

  Valor	Descrição
  LOCAL	Categoria de trabalho local.
  MULTI -SERVER	Categoria de trabalho multiservidor.
  NONE	Categoria de uma classe diferente de JOB.

• [ @name= ] 'name'
  O nome da categoria para a qual as informações são solicitadas. name é sysname, com um padrão NULL.

• [ @suffix= ] suffix
  Especifica se a coluna category_type do conjunto de resultados é um ID ou um nome. suffix é bit, com um padrão 0. 1 mostra o category_type como um nome e 0 o mostra como um ID.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

Quando @suffix for 0, sp_help_category retornará o seguinte conjunto de resultados:

Nome da coluna	Tipo de dados	Descrição
category_id	int	ID da categoria
category_type	tinyint	Tipo de categoria. 1 = Local 2 = Multiservidor 3 = Nenhum
name	sysname	Nome da categoria

Quando @suffix for 1, sp_help_category retornará o seguinte conjunto de resultados:

Nome da coluna	Tipo de dados	Descrição
category_id	int	ID da categoria
category_type	sysname	Tipo de categoria. Um entre LOCAL, MULTI-SERVER ou NONE
name	sysname	Nome da categoria

Comentários

sp_help_category deve ser executado a partir do banco de dados msdb.

Se nenhum parâmetro for especificado, o conjunto de resultados fornecerá informações sobre todas as categorias de trabalho.

Permissões

Por padrão, os membros da função de servidor fixa sysadmin podem executar este procedimento armazenado. Deve ser concedida a outros usuários uma das seguintes funções de banco de dados fixas do SQL Server Agent no banco de dados msdb:

• SQLAgentUserRole

• SQLAgentReaderRole

• SQLAgentOperatorRole

Para obter detalhes sobre as permissões dessas funções, consulte Funções de banco de dados fixas do SQL Server Agent.

Exemplos

A. Retornando informações do trabalho local

O exemplo a seguir retorna informações sobre trabalhos que são administrados localmente.

USE msdb ;
GO

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

B. Retornando informações de alerta

O exemplo a seguir retorna informações sobre a categoria de alerta Replication.

USE msdb ;
GO

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

Consulte também

Referência

sp_add_category (Transact-SQL)

sp_delete_category (Transact-SQL)

sp_update_category (Transact-SQL)

Procedimentos armazenados do sistema (Transact-SQL)