sp_help_jobstep (Transact-SQL)
Aplica-se a:SQL Server
Retorna informações para as etapas em um trabalho usado pelo serviço SQL Server Agent para executar atividades automatizadas.
Convenções de sintaxe de Transact-SQL
Sintaxe
sp_help_jobstep
[ [ @job_id = ] 'job_id' ]
[ , [ @job_name = ] N'job_name' ]
[ , [ @step_id = ] step_id ]
[ , [ @step_name = ] N'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 de NULL
.
Devem ser especificados @job_id ou @job_name , mas ambos não podem ser especificados.
@job_name [ = ] N'job_name'
O nome do trabalho. @job_name é sysname, com um padrão de NULL
.
Devem ser especificados @job_id ou @job_name , mas ambos não podem ser especificados.
@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 de NULL
.
@step_name [ = ] N'step_name'
O nome da etapa no trabalho. @step_name é sysname, com um padrão de NULL
.
@suffix [ = ] sufixo
Um sinalizador que indica se uma descrição de texto é anexada à coluna de sinalizadores na saída. @suffix é bit, com um padrão de 0
. Se @suffix for 1
, uma descrição será acrescentada.
Valores do código de retorno
0
(sucesso) ou 1
(falha).
Conjunto 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 , esse valor é o código de saída do processo de um comando bem-sucedido. |
on_success_action |
tinyint | Ação a ser efetuada se a etapa tiver êxito:1 = Sair do trabalho relatando sucesso.2 = Saia da falha de relatório de trabalho.3 = Vá para a próxima etapa.4 = Vá para o passo. |
on_success_step_id |
int | Se on_success_action for 4, esse valor indicará a próxima etapa a ser executada. |
on_fail_action |
tinyint | O que fazer se a etapa falhar. Os valores são iguais aos on_success_action do . |
on_fail_step_id |
int | Se on_fail_action for 4 , esse valor indica a próxima etapa a ser executada. |
server |
sysname | Reservado. |
database_name |
sysname | Para uma etapa Transact-SQL, esse valor é o banco de dados no qual o comando é executado. |
database_user_name |
sysname | Para uma etapa Transact-SQL, esse valor é 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 tentado novamente (se não for bem-sucedido). |
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 = Falhou1 = Sucedido2 = Repetir3 = Cancelado5 = Desconhecido |
last_run_duration |
int | Duração (hhmmss ) da etapa da última vez 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 msdb
banco de dados.
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 msdb
do 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.
Os membros de SQLAgentUserRole só podem exibir etapas de trabalho para trabalhos que possuem.
Exemplos
R. 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
Conteúdo relacionado
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários