Compartilhar via

sp_help_schedule (Transact-SQL)

  • Artigo

Aplica-se a: SQL Server

Lista informações sobre agendas.

Convenções de sintaxe de Transact-SQL

Sintaxe

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

Argumentos

@schedule_id [ = ] schedule_id

O identificador da agenda a ser listado. @schedule_id é int, com um padrão de NULL.

Pode ser especificado @schedule_id ou @schedule_name .

@schedule_name [ = ] N'schedule_name'

O nome da agenda a ser listada. @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 apenas agendas com um trabalho anexado devem ser mostradas. @attached_schedules_only é bit, com um padrão de 0. Quando @attached_schedules_only é 0, todas as programações são mostradas. Quando @attached_schedules_only é 1, o conjunto de resultados contém apenas agendamentos anexados a um trabalho.

@include_description [ = ] include_description

Especifica se descrições devem ser incluídas 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 espaço reservado. Quando @include_description é 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

Este procedimento retorna o seguinte conjunto de resultados:

Nome da coluna Tipo de dados Descrição
schedule_id int Número do identificador de agenda.
schedule_uid uniqueidentifier Identificador da 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 SQLServerAgent 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 agenda (se solicitado).
job_count int Retorna o número de trabalhos que referenciam essa agenda.

Comentários

Quando nenhum parâmetro é fornecido, sp_help_schedule lista informações para todas as programações na instância.

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 do SQLAgentUserRole só podem exibir as agendas que possuem.

Exemplos

R. Listar informações para todas as programações na instância

O exemplo a seguir lista as informações para todas as agendas na instância.

USE msdb;
GO

EXEC dbo.sp_help_schedule;
GO

B. Listar informações para uma programação específica

O exemplo a seguir lista as informações para a agenda chamada NightlyJobs.

USE msdb;
GO

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

Conteúdo relacionado