Partilhar via


sp_help_jobstep (Transact-SQL)

Aplica-se a:SQL Server

Devolve informações para os passos de um trabalho usados pelo serviço SQL Server Agent para realizar atividades automatizadas.

Transact-SQL convenções de sintaxe

Sintaxe

sp_help_jobstep
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @step_id = ] step_id ]
    [ , [ @step_name = ] N'step_name' ]
    [ , [ @suffix = ] suffix ]
[ ; ]

Arguments

[ @job_id = ] 'job_id'

O número de identificação do emprego para o qual devolver a informação do cargo. @job_id é um identificador único, com um padrão de NULL.

Ou @job_id ou @job_name devem ser especificados, mas nenhum dos dois pode ser especificado.

[ @job_name = ] N'job_name'

O nome da tarefa. @job_name é sysname, com o padrão de NULL.

Ou @job_id ou @job_name devem ser especificados, mas nenhum dos dois pode ser especificado.

[ @step_id = ] step_id

O número de identificação do passo no trabalho. Se não for incluído, todos os passos do trabalho estão incluídos. @step_id é int, com um padrão de NULL.

[ @step_name = ] N'step_name'

O nome da etapa do trabalho. @step_name é sysname, com um padrão de NULL.

[ @suffix = ] sufixo

Uma flag que indica se uma descrição de texto está anexada à coluna de flags na saída. @suffix é bit, com um padrão de 0. Se @sufixo for 1, uma descrição é acrescentada.

Valores de código de retorno

0 (sucesso) ou 1 (fracasso).

Conjunto de resultados

Nome da coluna Tipo de dados Description
step_id int Identificador único para o passo.
step_name sysname Nome do passo do trabalho.
subsystem Nvarchar (40) Subsistema onde executar o comando step.
command nvarchar(max) Comando executado no passo.
flags int Uma máscara de valores que controlam o comportamento dos passos.
cmdexec_success_code int Para um passo do CmdExec , este valor é o código de saída do processo de um comando bem-sucedido.
on_success_action tinyint Ação a tomar se o passo for bem-sucedido:

1 = Desistir do emprego de reportar sucesso.
2 = Desistir da falha no relatório de emprego.
3 = Passar para o próximo passo.
4 = Vai para o degrau.
on_success_step_id int Se on_success_action for 4, este valor indica o passo seguinte a executar.
on_fail_action tinyint O que fazer se o passo falhar. Os valores são os mesmos que on_success_action.
on_fail_step_id int Se on_fail_action for 4, este valor indica o próximo passo a executar.
server sysname Reservado.
database_name sysname Para um passo Transact-SQL, este valor é a base de dados onde o comando é executado.
database_user_name sysname Para um passo Transact-SQL, este valor é o contexto do utilizador da base de dados em que o comando é executado.
retry_attempts int O número máximo de vezes que o comando deve ser tentado novamente (se não for bem-sucedido).
retry_interval int Intervalo (em minutos) para qualquer tentativa de retentativa.
os_run_priority int Reservado.
output_file_name Nvarchar(200) Ficheiro para o qual a saída de comando deve ser escrita (apenas passos Transact-SQL, CmdExec e PowerShell ).
last_run_outcome int Resultado do passo na última vez que foi executado:

0 = Falhou
1 = Sucedeu
2 = Retentativa
3 = Cancelado
5 = Desconhecido
last_run_duration int Duração (hhmmss) do passo da última vez que foi executado.
last_run_retries int O número de vezes que o comando foi repetido da última vez que o passo foi executado.
last_run_date int Data a última etapa iniciada pela execução.
last_run_time int A última vez que o passo iniciou a execução.
proxy_id int Proxy para a etapa do trabalho.

Observações

sp_help_jobstep está na msdb base de dados.

Permissions

Pode conceder EXECUTE permissões neste procedimento, mas essas permissões podem ser anuladas durante uma atualização do SQL Server.

Outros utilizadores devem receber um dos seguintes papéis fixos de base de dados SQL Server Agent na msdb base de dados:

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

Para detalhes sobre as permissões destes papéis, consulte Funções de Base de Dados Fixas do Agente SQL Server.

Os membros do SQLAgentUserRole só podem visualizar os passos do trabalho dos trabalhos que possuem.

Examples

A. Informação de devolução para todas as etapas de um trabalho específico

O exemplo seguinte devolve todos os passos do trabalho para o trabalho nomeado Weekly Sales Data Backup.

USE msdb;
GO

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

B. Devolver informações sobre uma etapa específica do trabalho

O exemplo seguinte devolve informações sobre o primeiro passo do trabalho para o trabalho denominado Weekly Sales Data Backup.

USE msdb;
GO

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