sp_help_schedule (Transact-SQL)
S'applique à : SQL Server
Contient des informations sur les planifications.
Conventions de la syntaxe Transact-SQL
Syntaxe
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
Identificateur de la planification à répertorier. @schedule_id est int, avec la valeur par défaut NULL
.
Vous pouvez spécifier @schedule_id ou @schedule_name .
[ @schedule_name = ] N’schedule_name'
Nom de la planification à répertorier. @schedule_name est sysname, avec la valeur par défaut NULL
.
Vous pouvez spécifier @schedule_id ou @schedule_name .
[ @attached_schedules_only = ] attached_schedules_only
Spécifie s'il faut afficher seulement les planifications auxquelles un travail est attaché. @attached_schedules_only est bit, avec la valeur par défaut 0
. Lorsque @attached_schedules_only est 0
, toutes les planifications sont affichées. Lorsque @attached_schedules_only est 1
, le jeu de résultats contient uniquement des planifications attachées à un travail.
[ @include_description = ] include_description
Spécifie s'il faut inclure les descriptions dans le jeu de résultats. @include_description est bit, avec la valeur par défaut 0
. Lorsque @include_description est 0
, la colonne @schedule_description du jeu de résultats contient un espace réservé. Lorsque @include_description est 1
, la description de la planification est incluse dans le jeu de résultats.
Valeurs des codes de retour
0
(réussite) or 1
(échec).
Jeu de résultats
Cette procédure retourne le jeu de résultats suivant :
Nom de la 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 activée (0 ). |
freq_type |
int | Valeur indiquant quand le travail doit être exécuté.1 = Une fois4 = Quotidien8 = Hebdomadaire16 = Mensuel32 = Mensuel, par rapport au freq_interval 64 = Exécuter lorsque le service SQLServerAgent démarre. |
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. |
freq_subday_type |
int | Unités pour freq_subday_interval . Pour plus d’informations, consultez sp_add_schedule. |
freq_subday_interval |
int | Nombre de freq_subday_type périodes à effectuer entre chaque exécution du travail. Pour plus d’informations, consultez sp_add_schedule. |
freq_relative_interval |
int | L’occurrence du travail planifié de chaque freq_interval mois. Pour plus d’informations, consultez sp_add_schedule. |
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. |
Notes
Lorsqu’aucun paramètre n’est fourni, sp_help_schedule
répertorie les informations de toutes les planifications de l’instance.
autorisations
Vous pouvez accorder EXECUTE
des autorisations sur cette procédure, mais ces autorisations peuvent être remplacées lors d’une mise à niveau de SQL Server.
D’autres utilisateurs doivent disposer de l’un des rôles de base de données fixes SQL Server Agent suivants dans la msdb
base de données :
- 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 de SQLAgentUserRole peuvent uniquement afficher les planifications qu’ils possèdent.
Exemples
R. Répertorier les informations de toutes les planifications dans 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. Répertorier les informations d’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