Dans SQL Server, le sp_help_schedule
procédure stockée renvoie des informations sur les planifications dans l'Agent SQL Server.
Cet article fournit un aperçu de cette procédure stockée, y compris des exemples.
Syntaxe
La syntaxe officielle ressemble à ceci :
sp_help_schedule
[ @schedule_id = ] id ,
[ @schedule_name = ] 'schedule_name'
[ , [ @attached_schedules_only = ] attached_schedules_only ]
[ , [ @include_description = ] include_description ]
Vous pouvez appeler sp_help_schedule
, avec ou sans paramètres.
Lorsque vous l'appelez sans aucun paramètre, il renvoie une liste de tous les horaires de l'instance.
Lorsque vous transmettez un nom ou un ID de planification, il renvoie uniquement cette planification.
Notez que sp_help_schedule
est dans le msdb base de données, il doit donc être exécuté à partir de là. Vous pouvez le faire soit en basculant vers le msdb base de données (par exemple avec USE msdb
), ou en qualifiant la procédure avec le nom et le schéma de la base de données (c'est-à-dire msdb.dbo.sp_help_schedule
).
Exemple
Voici un exemple pour montrer comment renvoyer toutes les planifications dans l'instance :
EXEC msdb.dbo.sp_help_schedule;
Résultat :
Renvoyer un programme basé sur son nom
Vous pouvez également obtenir un horaire basé sur son nom :
EXEC msdb.dbo.sp_help_schedule
@schedule_name = 'Weekly_Sun_3AM';
Renvoyer un horaire en fonction de son ID
Vous pouvez également obtenir un horaire basé sur son ID :
EXEC msdb.dbo.sp_help_schedule
@schedule_id = 14;
Renvoyer uniquement les horaires joints
Bien que sp_help_schedule
ne renvoie pas les horaires pour un travail spécifique (utilisez sp_help_jobschedule
pour cela), vous pouvez l'utiliser pour renvoyer uniquement les horaires qui sont attachés à un travail.
Vous pouvez le faire avec le @attached_schedules_only
paramètre.
Le @attached_schedules_only
le paramètre est bit , avec une valeur par défaut de 0
, ce qui signifie qu'il renvoie à la fois les plannings attachés et non attachés. Passer une valeur de 1
le limite uniquement aux horaires joints.
Exemple :
EXEC sp_help_schedule
@attached_schedules_only = 1;
Inclure la description
Une autre chose que vous pouvez faire est de spécifier si vous souhaitez ou non inclure la description de l'horaire.
Par défaut, la description n'est pas incluse dans le jeu de résultats. En fait, le schedule_description
la colonne est inclus, mais il ne contient pas la description, sauf si vous le demandez explicitement. Si vous ne le demandez pas, le schedule_description
la colonne affiche (Description not requested.)
.
Le @include_description
le paramètre est bit , avec une valeur par défaut de 0
, ce qui signifie qu'il n'affiche pas la description. Passer une valeur de 1
entraîne l'affichage de la description.
EXEC sp_help_jobschedule
@job_name = 'SqlAgentTest',
@include_description = 1;