sp_help_jobschedule (Transact-SQL)

  • Article

S’applique à :SQL Server

Retourne des informations sur la planification des travaux utilisés par SQL Server Management Studio pour effectuer des activités automatisées.

Conventions de la syntaxe Transact-SQL

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. job_idest uniqueidentifier, avec la valeur par défaut NULL.

[ @job_name = ] 'job_name' Nom du travail. job_nameest sysname, avec la valeur par défaut NULL.

Notes

Vous devez spécifier job_id ou job_name , mais les deux ne peuvent pas être spécifiés.

[ @schedule_name = ] 'schedule_name' Nom de l’élément de planification pour le travail. schedule_nameest sysname, avec la valeur par défaut NULL.

[ @schedule_id = ] schedule_id Numéro d’identification de l’élément de planification pour le travail. schedule_idest int, avec la valeur par défaut NULL.

[ @include_description = ] include_description Spécifie s’il faut inclure la description de la planification dans le jeu de résultats. include_description est bit, avec la valeur par défaut 0. Lorsque include_description a la valeur 0, la description de la planification n’est pas incluse dans le jeu de résultats. Lorsque include_description a la valeur 1, la description de la planification est incluse dans le jeu de résultats.

Codet de retour

0 (réussite) ou 1 (échec)

Jeux de résultats

Nom de la colonne Type de données Description
schedule_id int Numéro d'identificateur de la planification.
schedule_name sysname Nom de la planification.
activé 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 fois

4 = Quotidienne

8 = Hebdomadaire

16 = mensuel

32 = mensuel, par rapport au freq_interval

64 = Exécuter 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 du travail. Pour plus d’informations, consultez sp_add_schedule (Transact-SQL).
freq_relative_interval int L’occurrence du travail planifié de l’freq_interval chaque 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 dérivée des valeurs dans msdb.dbo.sysschedules. Lorsque include_description a la valeur 0, cette colonne contient du texte indiquant que la description n’a pas été demandée.
next_run_date int Date à laquelle la planification va lancer l'exécution du travail.
next_run_time int Heure à laquelle la planification va lancer l'exécution du travail.
schedule_uid uniqueidentifier Identificateur de la planification.
job_count int Nombre de travaux retournés.

Notes

sp_help_jobschedule** retourne des valeurs à partir des tables système dbo.sysjobschedules et dbo.sysschedules dans msdb. sysjobschedules est mis à jour toutes les 20 minutes. Cela peut affecter les valeurs retournées par cette procédure stockée.

Remarques

Les paramètres de sp_help_jobschedule peuvent être utilisés uniquement dans certaines combinaisons. Si schedule_id est spécifié, ni job_id ni job_name ne peuvent être spécifiés. Sinon, 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 suivants de SQL Server Agent 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 de SQLAgentUserRole peuvent uniquement afficher les propriétés des planifications de travaux dont ils sont propriétaires.

Exemples

R. 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

Voir aussi

sp_add_schedule (Transact-SQL)
sp_delete_schedule (Transact-SQL)
sp_update_schedule (Transact-SQL)
Procédures stockées système (Transact-SQL)