sp_help_schedule (Transact-SQL)

Article
05/23/2023

S’applique à :SQL Server

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 int, sans valeur par défaut. Vous pouvez spécifier schedule_id ou schedule_name .

[ @schedule_name = ] 'schedule_name' Nom de la planification à répertorier. schedule_name est sysname, sans valeur par défaut. Vous pouvez spécifier schedule_id ou schedule_name .

[ @attached_schedules_only = ] attached_schedules_only ] Spécifie s’il faut afficher uniquement les planifications auxquelles un travail est attaché. attached_schedules_only est bit, avec la valeur par défaut 0. Lorsque attached_schedules_only a la valeur 0, toutes les planifications sont affichées. Lorsque attached_schedules_only a la valeur 1, le jeu de résultats contient uniquement des planifications attachées à un travail.

[ @include_description = ] include_description Spécifie s’il faut inclure des descriptions 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 colonne schedule_description du jeu de résultats contient un espace réservé. 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

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.
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 (sur demande).
job_count	int	Renvoie le nombre de travaux auxquels la planification fait référence.

Remarques

Lorsqu’aucun paramètre n’est fourni, sp_help_schedule répertorie des informations pour toutes les planifications de l’instance.

Autorisations

Par défaut, les membres du rôle 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 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 planifications dont ils sont propriétaires.

Exemples

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

sp_add_schedule (Transact-SQL)
sp_attach_schedule (Transact-SQL)
sp_delete_schedule (Transact-SQL)
sp_detach_schedule (Transact-SQL)