sp_help_jobschedule (Transact-SQL)
Retourne des informations sur la planification des travaux utilisés par SQL Server Management Studio pour effectuer des opérations automatisées.
.gif "Icône Lien de rubrique")
Syntaxe
sp_help_jobschedule { [ @job_id = ] job_id | [ @job_name = ] 'job_name' }
[ , [ @schedule_name = ] 'schedule_name' ]
[ , [ @schedule_id = ] schedule_id ]
[ , [ @include_description = ] include_description ]
Arguments
[ @job_id= ] job_id
Numéro d'identification du travail. L'argument job_idest de type uniqueidentifier, avec NULL comme valeur par défaut.[ @job_name= ] 'job_name'
Nom du travail. L'argument job_nameest de type sysname, avec NULL comme valeur par défaut.[!REMARQUE]
Vous devez définir la valeur de job_id ou de job_name, mais pas les deux valeurs à la fois.
[ @schedule_name= ] 'schedule_name'
Nom de l'élément de planification pour le travail. L'argument schedule_nameest de type sysname, avec NULL comme valeur par défaut.[ @schedule_id= ] schedule_id
Numéro d'identification de l'élément de planification pour le travail. schedule_idest de type int, avec NULL comme valeur par défaut.[ @include_description= ] include_description
Spécifie s'il faut inclure la description de la planification dans l'ensemble de résultats. L'argument include_description est de type bit, avec 0 comme valeur par défaut. Lorsque la valeur de include_description est définie sur 0, la description de la planification n'est pas englobée dans l'ensemble de résultats. Si elle est définie sur 1, cette description est comprise dans l'ensemble de résultats.
Valeurs du code de retour
0 (succès) ou 1 (échec)
Ensembles de résultats
Nom de colonne |
Type de données |
Description |
|---|---|---|
schedule_id |
int |
Numéro d'identification 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 la fréquence d'exécution du travail. 1 = Une fois 4 = Une fois par jour 8 = Une fois par semaine 16 = Une fois par mois 32 = Une fois par mois, en fonction de freq_interval. 64 = Exécuté 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 de 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 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 dérivée des valeurs présentes dans msdb.dbo.sysschedules. Lorsque la valeur de include_description est définie sur 0, cette colonne contient un texte indiquant que la description n'a pas été demandée. |
next_run_date |
int |
Date à laquelle la planification lance l'exécution du travail suivante. |
next_run_time |
int |
Heure à laquelle la planification lance l'exécution du travail suivante. |
schedule_uid |
uniqueidentifier |
Identificateur de la planification. |
job_count |
int |
Nombre de travaux retournés. |
[!REMARQUE]
sp_help_jobschedule retourne des valeurs des tables système dbo.sysjobschedules et dbo.sysschedules de msdb. sysjobschedules est mis à jour toutes les 20 minutes. Cela peut affecter les valeurs retournées par cette procédure stockée.
Notes
Les paramètres de sp_help_jobschedule ne peuvent être utilisés que dans certaines combinaisons. Si schedule_id est spécifié, ni job_id ni job_name ne peut être spécifié. Par contre, les paramètres job_id ou job_name peuvent être utilisés avec schedule_name.
Autorisations
Nécessite l'appartenance au rôle serveur fixe sysadmin. 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 propriétés des planifications des travaux dont ils sont propriétaires.
Exemples
A. Retour de la planification d'un travail spécifique
Cet exemple retourne les informations de planification du travail BackupDatabase.
USE msdb ;
GO
EXEC dbo.sp_help_jobschedule
@job_name = N'BackupDatabase' ;
GO
B. Retour de la planification d'un travail pour une planification spécifique
Cet exemple retourne les informations de planification NightlyJobs et du travail RunReports.
USE msdb ;
GO
EXEC dbo.sp_help_jobschedule
@job_name = N'RunReports',
@schedule_name = N'NightlyJobs' ;
GO
C. Retour de la planification de travail et de la description d'une planification spécifique
Cet exemple retourne les informations de planification NightlyJobs et du travail RunReports. L'ensemble de résultats retourné comporte une description de la planification.
USE msdb ;
GO
EXEC dbo.sp_help_jobschedule
@job_name = N'RunReports',
@schedule_name = N'NightlyJobs',
@include_description = 1 ;
GO