Compartilhar via

sp_help_jobschedule (Transact-SQL)

  • Artigo

Aplica-se a: SQL Server

Retorna informações sobre o agendamento de trabalhos usados pelo SQL Server Management Studio para executar atividades automatizadas.

Convenções de sintaxe de Transact-SQL

Sintaxe

sp_help_jobschedule
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @schedule_id = ] schedule_id ]
    [ , [ @include_description = ] include_description ]
[ ; ]

Argumentos

@job_id [ = ] 'job_id'

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

Tanto @job_id quanto @job_name devem ser especificados, 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.

Tanto @job_id quanto @job_name devem ser especificados, mas ambos não podem ser especificados.

@schedule_name [ = ] N'schedule_name'

O nome do item de agenda que será definido para o trabalho. @schedule_name é sysname, com um padrão de NULL.

@schedule_id [ = ] schedule_id

O número de identificação do item de agenda do trabalho. @schedule_id é int, com um padrão de NULL.

@include_description [ = ] include_description

Especifica se deve ser incluída a descrição da agenda no conjunto de resultados. @include_description é bit, com um padrão de 0.

  • Quando 0, a descrição do agendamento não está incluída no conjunto de resultados.
  • Quando 1, a descrição do agendamento é incluída no conjunto de resultados.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Conjunto de resultados

Nome da coluna Tipo de dados Descrição
schedule_id int Número do identificador de agenda.
schedule_name sysname Nome da agenda.
enabled int Se o agendamento foi habilitado (1) ou não habilitado (0).
freq_type int Valor que indica quando o trabalho deve ser executado.

1 = Uma vez
4 = Diário
8 = Semanais
16 = Mensal
32 = Mensal, em relação ao freq_interval
64 = Executar quando o serviço SQL Server Agent for iniciado.
freq_interval int Dias em que o trabalho é executado. O valor depende do valor de freq_type. Para obter mais informações, consulte sp_add_schedule.
freq_subday_type int Unidades para freq_subday_interval. Para obter mais informações, consulte sp_add_schedule.
freq_subday_interval int Número de freq_subday_type períodos a serem observados entre cada execução do trabalho. Para obter mais informações, consulte sp_add_schedule.
freq_relative_interval int Ocorrência do trabalho agendado em freq_interval cada mês. Para obter mais informações, consulte sp_add_schedule.
freq_recurrence_factor int Número de meses entre a execução agendada do trabalho.
active_start_date int Data em que a agenda foi ativada.
active_end_date int Data de término da agenda.
active_start_time int Hora do dia em que a agenda é iniciada.
active_end_time int Hora do dia em que a agenda é encerrada.
date_created datetime Data em que a agenda foi criada.
schedule_description nvarchar(4000) Uma descrição em inglês da tabela derivada de valores em msdb.dbo.sysschedules. Quando @include_description é 0, esta coluna contém texto informando que a descrição não foi solicitada.
next_run_date int A próxima data do agendamento faz com que o trabalho seja executado.
next_run_time int O tempo em que o agendamento for executado fará com que o trabalho seja executado.
schedule_uid uniqueidentifier Identificador da agenda.
job_count int Contagem de trabalhos retornados.

Observação

sp_help_jobschedule Retorna valores das dbo.sysjobschedules tabelas e dbo.sysschedules do sistema em msdb.sysjobschedules atualizações a cada 20 minutos. Isso pode afetar os valores que são retornados por esse procedimento armazenado.

Comentários

Os parâmetros de sp_help_jobschedule podem ser usados apenas em determinadas combinações. Se @schedule_id for especificado, @job_id e @job_name não poderão ser especificados. Caso contrário, os parâmetros @job_id ou @job_name podem ser usados com @schedule_name.

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.

Os membros de SQLAgentUserRole só podem exibir propriedades de agendas de trabalho que possuem.

Exemplos

R. Retornar o agendamento de trabalho para um trabalho específico

O exemplo a seguir retorna todas as informações de agendamento do trabalho chamado BackupDatabase.

USE msdb;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'BackupDatabase' ;
GO

B. Retornar o agendamento de trabalho para um agendamento específico

O exemplo a seguir retorna as informações da agenda chamada NightlyJobs e do trabalho chamado RunReports.

USE msdb;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs';
GO

C. Retorne o agendamento de trabalho e a descrição do agendamento para um agendamento específico

O exemplo a seguir retorna as informações da agenda chamada NightlyJobs e do trabalho chamado RunReports. O conjunto de resultados retornado inclui uma descrição da agenda.

USE msdb;
GO

EXEC dbo.sp_help_jobschedule
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs',
    @include_description = 1;
GO

Conteúdo relacionado