sp_help_category (Transact-SQL)

Aplica-se a: SQL Server

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

Convenções de sintaxe de Transact-SQL

Sintaxe

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

Argumentos

@class [ = ] 'classe'

Especifica a classe sobre a qual as informações são solicitadas. @class é varchar(8) e pode ser um desses valores.

Valor Descrição
JOB (padrão) 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 [ = ] 'tipo'

O tipo de categoria para a qual as informações são solicitadas. @type é varchar(12) e pode ser um desses valores.

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

@name [ = ] N'nome'

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

@suffix [ = ] sufixo

Especifica se a category_type coluna no conjunto de resultados é uma ID ou um nome. @suffix é bit, com um padrão de 0.

  • 1 mostra o category_type como um nome.
  • 0 mostra o category_type como um ID.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Conjunto de resultados

Quando @suffix é 0, sp_help_category retorna 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 = Locais
2 = Multiservidor
3 = Nenhum
name sysname Nome da categoria

Quando @suffix é 1, sp_help_category retorna 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. Uma opção entre LOCAL, MULTI-SERVER ou NONE
name sysname Nome da categoria

Comentários

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

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

Permissões

Esse procedimento armazenado pertence à função db_owner . Você pode conceder EXECUTE permissões para qualquer usuário, mas essas permissões podem ser substituídas durante uma atualização do SQL Server.

Outros usuários devem receber uma das seguintes funções de banco de dados fixas do msdb SQL Server Agent no banco de dados:

  • 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

R. Retornar informações de 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. Informações de alerta de retorno

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