• Artigo

sp_help_jobschedule (Transact-SQL)

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

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

sp_help_jobschedule { [ @job_id = ] job_id | [ @job_name = ] 'job_name' }
     [ , [ @schedule_name = ] '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.

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

    ObservaçãoObservação

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

  • [ @schedule_name= ] '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 include_description for 0, a descrição da agenda não será incluída no conjunto de resultados. Quando include_description for 1, a descrição da agenda será incluída no conjunto de resultados.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos 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 a agenda foi habilitada (1) ou não (0).

freq_type

int

Valor que indica quando o trabalho será executado.

1 = Uma vez

4 = Diariamente

8 = Semanalmente

16 = Mensalmente

32 = Mensalmente, relativo a freq_interval

64 = Executar quando o serviço SQLServerAgent iniciar.

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 (Transact-SQL).

freq_subday_type

int

Unidades para freq_subday_interval. Para obter mais informações, consulte sp_add_schedule (Transact-SQL).

freq_subday_interval

int

Número de períodos de freq_subday_type que devem ocorrer entre cada execução do trabalho. Para obter mais informações, consulte sp_add_schedule (Transact-SQL).

freq_relative_interval

int

A ocorrência do trabalho agendado do freq_interval em cada mês. Para obter mais informações, consulte sp_add_schedule (Transact-SQL).

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 da agenda em inglês que é derivada dos valores de msdb.dbo.sysschedules. Quando include_description for 0, essa coluna conterá texto que informando que a descrição não foi solicitada.

next_run_date

int

Próxima data em que a agenda fará o trabalho ser executado.

next_run_time

int

Próxima hora em que a agenda fará o trabalho ser executado.

schedule_uid

uniqueidentifier

Identificador da agenda.

job_count

int

Contagem de trabalhos retornados.
ObservaçãoObservação

sp_help_jobschedule retorna valores das tabelas de sistema dbo.sysjobschedules e dbo.sysschedules de msdb. sysjobschedules é atualizado 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 somente em determinadas combinações. Se schedule_id for especificada, nem job_id, nem job_name podem ser especificados. Caso contrário, o parâmetro job_id ou job_name pode ser usado com schedule_name.

Permissões

Requer associação à função de servidor fixa sysadmin. Outros usuários deverão receber 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 propriedades das agendas dos trabalhos de sua propriedade.

Exemplos

A. Retornando a agenda 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. Retornando a agenda de trabalho de uma agenda específica

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. Retornando a agenda de trabalho e a descrição de uma agenda específica

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