Partager via

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 = ] N'job_name' ]
    [ , [ @schedule_name = ] N'schedule_name' ]
    [ , [ @schedule_id = ] schedule_id ]
    [ , [ @include_description = ] include_description ]
[ ; ]

Arguments

[ @job_id = ] 'job_id'

Numéro d’identification du travail. @job_id est uniqueidentifier, avec la valeur par défaut NULL.

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

[ @job_name = ] N’job_name'

Nom du travail. @job_name est sysname, avec la valeur par défaut NULL.

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

[ @schedule_name = ] N’schedule_name'

Nom de l'élément de planification pour le travail. @schedule_name est 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_id est 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.

  • Quand 0, la description de la planification n’est pas incluse dans le jeu de résultats.
  • Quand 1, la description de la planification est incluse dans le jeu de résultats.

Valeurs des codes de retour

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

Jeu 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.
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 fois
4 = Quotidien
8 = Hebdomadaire
16 = Mensuel
32 = Mensuel, par rapport au freq_interval
64 = Exécuter quand le service SQL Server Agent 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 anglaise de la planification dérivée des valeurs dans msdb.dbo.sysschedules. Lorsque @include_description est 0, cette colonne contient du texte indiquant que la description n’a pas été demandée.
next_run_date int La date suivante de la planification entraîne l’exécution du travail.
next_run_time int L’heure suivante de la planification entraîne l’exécution du travail.
schedule_uid uniqueidentifier Identificateur de la planification.
job_count int Nombre de travaux retournés.

Remarque

sp_help_jobscheduleretourne les valeurs des tables système et dbo.sysschedules des dbo.sysjobschedules tables système dans msdb.sysjobschedules les mises à 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é, @job_id et @job_name ne peuvent pas être spécifiés. Sinon, les paramètres @job_id ou @job_name peuvent être utilisés avec @schedule_name.

autorisations

Cette procédure stockée appartient au rôle db_owner . Vous pouvez accorder EXECUTE des autorisations pour n’importe quel utilisateur, 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 propriétés des planifications de travail qu’ils possèdent.

Exemples

R. Retourner la planification du travail pour 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. Retourner la planification du 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. Retourner la planification du travail et la description de planification 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

Contenu connexe