Partilhar via


sp_help_schedule (Transact-SQL)

Aplica-se a:SQL Server

Lista informações sobre horários.

Transact-SQL convenções de sintaxe

Sintaxe

sp_help_schedule
    [ [ @schedule_id = ] schedule_id ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @attached_schedules_only = ] attached_schedules_only ]
    [ , [ @include_description = ] include_description ]
[ ; ]

Arguments

[ @schedule_id = ] schedule_id

O identificador do horário a listar. @schedule_id é int, com um padrão de NULL.

Pode ser especificado @schedule_id ou @schedule_name .

[ @schedule_name = ] N'schedule_name'

O nome do horário a listar. @schedule_name é sysname, com um padrão de NULL.

Pode ser especificado @schedule_id ou @schedule_name .

[ @attached_schedules_only = ] attached_schedules_only

Especifica se deve mostrar apenas os horários a que um trabalho está associado. @attached_schedules_only é bit, com um padrão de 0. Quando @attached_schedules_only0é , todos os horários são mostrados. Quando @attached_schedules_only é 1, o conjunto de resultados contém apenas os agendamentos que estão associados a um trabalho.

[ @include_description = ] include_description

Especifica se deve incluir descrições no conjunto de resultados. @include_description é bit, com um padrão de 0. Quando @include_description é 0, a coluna @schedule_description do conjunto de resultados contém um marcador de posição. Quando @include_description é 1, a descrição do cronograma é incluída no conjunto de resultados.

Valores de código de retorno

0 (sucesso) ou 1 (fracasso).

Conjunto de resultados

Este procedimento devolve o seguinte conjunto de resultados:

Nome da coluna Tipo de dados Description
schedule_id int Número do identificador do horário.
schedule_uid uniqueidentifier Identificador para o horário.
schedule_name sysname Nome da agenda.
enabled int Quer o horário esteja ativado (1) ou não (0).
freq_type int Valor indica quando o trabalho deve ser executado.

1 = Uma vez
4 = Diário
8 = Semanal
16 = Mensal
32 = Mensalmente, em relação ao 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.
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 ocorrer entre cada execução do trabalho. Para obter mais informações, consulte sp_add_schedule.
freq_relative_interval int Ocorrência do emprego 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 prevista do trabalho.
active_start_date int Data em que o calendário é ativado.
active_end_date int Data de fim do calendário.
active_start_time int Hora do dia em que o horário começa.
active_end_time int O horário do dia termina.
date_created datetime Data em que o calendário é criado.
schedule_description Nvarchar(4000) Uma descrição em inglês do horário (se solicitado).
job_count int Devolve quantos empregos referenciam este horário.

Observações

Quando não são fornecidos parâmetros, sp_help_schedule lista a informação de todos os horários na instância.

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 horários que possuem.

Examples

A. Lista de informações para todos os horários na instância

O exemplo seguinte lista informações para todos os anexos na instância.

USE msdb;
GO

EXECUTE dbo.sp_help_schedule;
GO

B. Lista de informações para um horário específico

O exemplo seguinte lista informações para o anexo denominado NightlyJobs.

USE msdb;
GO

EXECUTE dbo.sp_help_schedule @schedule_name = N'NightlyJobs';
GO