sp_help_job (Transact-SQL)

Sintaxe

sp_help_job { [ @job_id = ] job_id
[ @job_name = ] 'job_name' } 
     [ , [ @job_aspect = ] 'job_aspect' ] 
     [ , [ @job_type = ] 'job_type' ] 
     [ , [ @owner_login_name = ] 'login_name' ] 
     [ , [ @subsystem = ] 'subsystem' ] 
     [ , [ @category_name = ] 'category' ] 
     [ , [ @enabled = ] enabled ] 
     [ , [ @execution_status = ] status ] 
     [ , [ @date_comparator = ] 'date_comparison' ] 
     [ , [ @date_created = ] date_created ] 
     [ , [ @date_last_modified = ] date_modified ] 
     [ , [ @description = ] 'description_pattern' ]

Argumentos

• [ @job_id =] job_id
  O número de identificação do trabalho. job_id é uniqueidentifier, com um padrão NULL.

• [ @job_name =] 'job_name'
  O nome do trabalho. job_name é sysname, com um padrão NULL.

  Observação
  É necessário especificar a job_id ou o job_name, mas não é possível especificar ambos ao mesmo tempo.

• [ @job_aspect =] 'job_aspect'
  O atributo do trabalho a ser exibido. job_aspect é varchar(9), com um padrão NULL, e pode ser um destes valores.

  Valor	Descrição
  ALL	Informações de aspecto do trabalho
  JOB	Informações do trabalho
  SCHEDULES	Informações da agenda
  STEPS	Informações de etapa do trabalho
  TARGETS	Informações de destino

• [ @job_type =] 'job_type'
  O tipo dos trabalhos a serem incluídos no relatório. job_type é varchar(12), com um padrão NULL. job_type pode ser LOCAL ou MULTI-SERVER.

• [ @owner_login_name =] 'login_name'
  O nome de logon do proprietário do trabalho. login_name é sysname, com um padrão NULL.

• [ @subsystem =] 'subsystem'
  O nome do subsistema. subsystem é nvarchar(40), com um padrão NULL.

• [ @category_name =] 'category'
  O nome da categoria. category é sysname, com um padrão NULL.

• [ @enabled =] enabled
  Um número que indica se as informações são mostradas para trabalhos habilitados ou desabilitados. enabled é tinyint, com um padrão NULL. 1 indica trabalhos habilitados e 0 indica trabalhos desabilitados.

• [ @execution_status =] status
  O status de execução dos trabalhos. status é int, com um padrão NULL, e pode ser um destes valores.

  Valor	Descrição
  0	Retorna somente os trabalhos que não estão ociosos ou suspensos.
  1	Em execução.
  2	Esperando por thread.
  3	Entre repetições.
  4	Ocioso.
  5	Suspenso.
  7	Executando ações de conclusão.

• [ @date_comparator =] 'date_comparison'
  O operador de comparação a ser usado em comparações de date_created e date_modified. date_comparison é char(1) e pode ser =, < ou >.

• [ @date_created =] date_created
  A data em que o trabalho foi criado. date_createdé datetime, com um padrão NULL.

• [ @date_last_modified =] date_modified
  A data em que o trabalho foi modificado pela última vez. date_modified é datetime, com um padrão NULL.

• [ @description =] 'description_pattern'
  A descrição do trabalho. description_pattern é nvarchar(512), com um padrão NULL. description_pattern pode incluir os caracteres curinga do SQL Server para correspondência de padrões.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

Se nenhum argumento for especificado, sp_help_job retornará este conjunto de resultados.

Se job_id ou job_name for especificado, sp_help_job retornará estes conjuntos de resultados adicionais para etapas de trabalho, agendas de trabalho e servidores de destino de trabalho.

Este é o conjunto de resultados para etapas de trabalho.

Este é o conjunto de resultados para agendas de trabalho.

Este é o conjunto de resultados para servidores de destino 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.

Os membros de SQLAgentUserRole só podem exibir os trabalhos que possuem. Os membros de sysadmin, SQLAgentReaderRolee SQLAgentOperatorRole podem exibir todos os trabalhos locais e multiservidor.

Exemplos

A. Listar informações de todos os trabalhos

USE msdb ;
GO

EXEC dbo.sp_help_job ;
GO

B. Listando informações para trabalhos que correspondam a critérios específicos

USE msdb ;
GO

EXEC dbo.sp_help_job 
   @job_type = N'MULTI-SERVER',
   @owner_login_name = N'françoisa',
   @enabled = 1,
   @execution_status = 1 ;
GO

C. Listando todos os aspectos de informações de um trabalho

USE msdb ;
GO

EXEC dbo.sp_help_job
    @job_name = N'NightlyBackups',
    @job_aspect = N'ALL' ;
GO

Consulte também

Referência