sp_help_schedule (Transact-SQL)
Lista informações sobre agendas.
.gif "Ícone de vínculo de tópico")
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 da agenda a ser listado. schedule_name é int, sem nenhum padrão. Pode ser especificado schedule_id ou schedule_name.[ @schedule_name = ] 'schedule_name'
O nome da agenda a ser listado. schedule_name é sysname, sem nenhum padrão. Pode ser especificado schedule_id ou schedule_name.[ @attached_schedules_only = ] attached_schedules_only ]
Especifica se devem ser mostradas somente as agendas com um trabalho anexado. attached_schedules_only é bit, com um padrão de 0. Quando attached_schedules_only for 0, todas as agendas são mostradas. Quando attached_schedules_only for 1, o conjunto de resultados terá somente agendas anexadas a um trabalho.[ @include_description = ] include_description
Especifica se devem ser incluídas descrições no conjunto de resultados. include_description é bit, com um padrão de 0. Quando include_description for 0, a coluna schedule_description do conjunto de resultados terá um espaço reservado. 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
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 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 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 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 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 as informações de todas as agendas 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.
Membros de SQLAgentUserRole podem exibir somente as agendas de sua propriedade.
Exemplos
A. Listando informações para todas as agendas 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. Listando informações para 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