sp_help_jobstep (Transact-SQL)

Retorna informações das etapas em um trabalho usado pelo serviço do Agente SQL Server para executar atividades automatizadas.

Convenções da sintaxe Transact-SQL

Sintaxe

sp_help_jobstep { [ @job_id = ] 'job_id' | [ @job_name = ] 'job_name' }
     [ , [ @step_id = ] step_id ] 
     [ , [ @step_name = ] 'step_name' ] 
     [ , [ @suffix = ] suffix ] 

Argumentos

• [ @job_id =] 'job_id'
  O número de identificação do trabalho para o qual as informações de trabalho devem ser retornadas. 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 job_id ou job_name, mas não é possível especificar ambos ao mesmo tempo.

• [ @step_id =] step_id
  O número de identificação da etapa no trabalho. Se não for incluído, todas as etapas do trabalho serão incluídas. step_id é int, com um padrão NULL.

• [ @step_name =] 'step_name'
  O nome da etapa no trabalho. step_name é sysname, com um padrão NULL.

• [ @suffix =] suffix
  Um sinalizador que indica se uma descrição de texto será anexada à coluna flags da saída. suffixé bit, com o padrão 0. Se suffix for 1, uma descrição será anexada.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

Nome da coluna	Tipo de dados	Descrição
step_id	int	Identificador exclusivo da etapa.
step_name	sysname	Nome da etapa no trabalho.
subsystem	nvarchar(40)	Subsistema no qual o comando de etapa será executado.
command	nvarchar(max)	Comando executado na etapa.
flags	int	Um bitmask de valores que controlam o comportamento da etapa.
cmdexec_success_code	int	Para uma etapa CmdExec, este é o código de saída do processo de um comando com êxito.
on_success_action	tinyint	Ação a ser efetuada se a etapa tiver êxito: 1 = Sair do trabalho relatando êxito. 2 = Sair do trabalho relatando falha. 3 = Ir para a próxima etapa. 4 = Ir para a etapa.
on_success_step_id	int	Se on_success_action for 4, isto indicará a próxima etapa a ser executada.
on_fail_action	tinyint	O que fazer se a etapa falhar. Os valores são os mesmos que os de on_success_action.
on_fail_step_id	int	Se on_fail_action for 4, isto indicará a próxima etapa a ser executada.
server	sysname	Reservado.
database_name	sysname	Para uma etapa Transact-SQL, este é o banco de dados no qual o comando é executado.
database_user_name	sysname	Para uma etapa Transact-SQL, este é o contexto de usuário do banco de dados no qual o comando é executado.
retry_attempts	int	Número máximo de vezes que o comando deve ser repetido (se for malsucedido).
retry_interval	int	Intervalo (em minutos) para quaisquer tentativas de repetição.
os_run_priority	int	Reservado.
output_file_name	nvarchar(200)	Arquivo no qual a saída do comando deve ser gravada (somente etapas Transact-SQL, CmdExec e PowerShell).
last_run_outcome	int	Resultado da etapa na última vez em que foi executada: 0 = Falhou 1 = Obteve êxito 2 = Tentar novamente 3 = Cancelada 5 = Desconhecido
last_run_duration	int	Duração (em segundos) da etapa na última vez em que foi executada.
last_run_retries	int	Número de vezes que o comando foi repetido da última vez em que a etapa foi executada.
last_run_date	int	Data em que a execução da etapa foi iniciada pela última vez.
last_run_time	int	Hora em que a execução da etapa foi iniciada pela última vez.
proxy_id	int	Proxy da etapa do trabalho.

Comentários

sp_help_jobstep está no banco de dados msdb.

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 as etapas dos trabalhos que possuem.

Exemplos

A.Retornar informações de todas as etapas em um trabalho específico

O exemplo a seguir retorna todas as etapas do trabalho nomeado Weekly Sales Data Backup.

USE msdb ;
GO

EXEC dbo.sp_help_jobstep
    @job_name = N'Weekly Sales Data Backup' ;
GO

B.Retornar informações sobre uma etapa de trabalho específica

O exemplo a seguir retorna informações sobre a primeira etapa de trabalho do trabalho nomeado Weekly Sales Data Backup.

USE msdb ;
GO

EXEC dbo.sp_help_jobstep
    @job_name = N'Weekly Sales Data Backup',
    @step_id = 1 ;
GO

Consulte também

Referência

sp_add_jobstep (Transact-SQL)

sp_delete_jobstep (Transact-SQL)

sp_help_job (Transact-SQL)

sp_update_jobstep (Transact-SQL)

Procedimentos armazenados do sistema (Transact-SQL)