sp_help_schedule (Transact-SQL)
Contient des informations sur les planifications.
Syntaxe
sp_help_schedule
[ @schedule_id = ] id ,
[ @schedule_name = ] 'schedule_name'
[ , [ @attached_schedules_only = ] attached_schedules_only ]
[ , [ @include_description = ] include_description ]
Arguments
- [ @schedule_id = ] id
Identificateur de la planification à répertorier. schedule_name est de type int, et n'a pas de valeur par défaut. schedule_id ou schedule_name peut être spécifié.
- [ @schedule_name = ] 'schedule_name'
Nom de la planification à répertorier. schedule_name est de type sysname, et n'a pas de valeur par défaut. schedule_id ou schedule_name peut être spécifié.
- [ @attached_schedules_only = ] attached_schedules_only ]
Spécifie s'il faut afficher seulement les planifications auxquelles un travail est attaché. L'argument attached_schedules_only est de type bit et a une valeur par défaut de 0. Lorsque l'argument attached_schedules_only a la valeur 0, toutes les planifications sont affichées. Lorsque attached_schedules_only a la valeur 1, l'ensemble de résultats contient uniquement les planifications attachées à un travail.
- [ @include_description = ] include_description
Spécifie s'il faut inclure les descriptions dans l'ensemble de résultats. L'argument include_description est de type bit, avec une valeur par défaut de 0. Lorsque l'argument include_description prend la valeur 0, la colonne schedule_description de l'ensemble de résultats contient un espace réservé. Si cet argument est défini sur 1, cette description est comprise dans l'ensemble de résultats.
Notes
Lorsqu'aucun paramètre n'est fourni, sp_help_schedule affiche des informations sur toutes les planifications de l'instance.
Autorisations
Seuls les membres du rôle de serveur fixe sysadmin peuvent exécuter cette procédure stockée. Les autres utilisateurs doivent disposer de l'un des rôles de base de données fixes SQL Server Agent suivants dans la base de données msdb.
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
Pour en savoir plus sur les autorisations de ces rôles, consultez Rôles de base de données fixes de l'Agent SQL Server.
Les membres du rôle SQLAgentUserRole peuvent consulter uniquement les planifications dont ils sont propriétaires.
Valeurs des codes renvoyés
0 (succès) ou 1 (échec)
Ensembles de résultats
Cette procédure renvoie l'ensemble de résultats suivant :
| Nom de colonne | Type de données | Description |
|---|---|---|
schedule_id |
int |
Numéro d'identificateur de la planification. |
schedule_uid |
uniqueidentifier |
Identificateur de la planification. |
schedule_name |
sysname |
Nom de la planification. |
enabled |
int |
Indique si la planification est activée (1) ou non (0). |
freq_type |
int |
Valeur indiquant quand le travail doit être exécuté. 1 = Une fois 4 = Quotidiennement 8 = Hebdomadairement 16 = Mensuellement 32 = Mensuellement, en fonction de freq_interval 64 = Lancé au démarrage du service SQLServerAgent |
freq_interval |
int |
Jours d'exécution du travail. La valeur dépend de la valeur de freq_type. Pour plus d'informations, consultez sp_add_schedule (Transact-SQL). |
freq_subday_type |
int |
Unités pour freq_subday_interval. Pour plus d'informations, consultez sp_add_schedule (Transact-SQL). |
freq_subday_interval |
int |
Nombre de périodes freq_subday_type entre chaque exécution planifiée du travail. Pour plus d'informations, consultez sp_add_schedule (Transact-SQL). |
freq_relative_interval |
int |
Nombre d'exécutions planifiées du travail à freq_interval par mois. Pour plus d'informations, consultez sp_add_schedule (Transact-SQL). |
freq_recurrence_factor |
int |
Nombre de mois devant s'écouler entre les exécutions planifiées du travail. |
active_start_date |
int |
Date d'activation de la planification. |
active_end_date |
int |
Date de fin de la planification. |
active_start_time |
int |
Heure de début de la planification. |
active_end_time |
int |
Heure de fin de la planification. |
date_created |
datetime |
Date de création de la planification. |
schedule_description |
nvarchar(4000) |
Description en anglais de la planification (sur demande). |
job_count |
int |
Renvoie le nombre de travaux auxquels la planification fait référence. |
Exemples
A. Affichage d'informations sur toutes les planifications de l'instance
L'exemple suivant affiche des informations sur toutes les planifications de l'instance.
USE msdb ;
GO
EXEC dbo.sp_help_schedule ;
GO
B. Affichage d’informations sur une planification spécifique
L'exemple suivant affiche des informations sur la planifications nommée NightlyJobs.
USE msdb ;
GO
EXEC dbo.sp_help_schedule
@schedule_name = N'NightlyJobs' ;
GO
Voir aussi
Référence
sp_add_schedule (Transact-SQL)
sp_attach_schedule (Transact-SQL)
sp_delete_schedule (Transact-SQL)
sp_detach_schedule (Transact-SQL)