sp_help_schedule (Transact-SQL)

Aplica-se a:SQL Server

Lista informações sobre agendas.

Convenções de sintaxe de Transact-SQL

Sintaxe

  
sp_help_schedule   
     [ @schedule_id = ] id ,  
     [ @schedule_name = ] 'schedule_name'   
     [ , [ @attached_schedules_only = ] attached_schedules_only ]  
     [ , [ @include_description = ] include_description ]  

Argumentos

[ @schedule_id = ] id O identificador do agendamento a ser listado. schedule_name é int, sem padrão. Pode ser especificado schedule_id ou schedule_name .

[ @schedule_name = ] 'schedule_name' O nome da agenda a ser listada. schedule_name é sysname, sem padrão. Pode ser especificado schedule_id ou schedule_name .

[ @attached_schedules_only = ] attached_schedules_only ] Especifica se é necessário mostrar apenas os agendamentos aos quais um trabalho está anexado. attached_schedules_only é bit, com um padrão de 0. Quando attached_schedules_only é 0, todos os agendamentos são mostrados. Quando attached_schedules_only é 1, o conjunto de resultados contém apenas agendamentos anexados a um trabalho.

[ @include_description = ] include_description Especifica se as 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 (êxito) ou 1 (falha)

Conjuntos 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.
Habilitado	int	Se o agendamento está habilitado (1) ou não (0).
freq_type	int	Valor que indica quando o trabalho deve ser executado. 1 = Uma vez 4 = Diário 8 = Semanal 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 (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 freq_subday_type períodos a 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 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 todos os agendamentos na instância.

Permissões

Por padrão, os membros da função de servidor fixa sysadmin podem executar este procedimento armazenado. Deve ser concedida a outros usuários 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 do SQLAgentUserRole só podem exibir os agendamentos que possuem.

Exemplos

a. Listando informações para todas as agendas da 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. Listando informações de uma agenda 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  

Consulte Também

sp_add_schedule (Transact-SQL)
sp_attach_schedule (Transact-SQL)
sp_delete_schedule (Transact-SQL)
sp_detach_schedule (Transact-SQL)