sp_add_jobschedule (Transact-SQL)

Crée la planification d'un travail.

Icône Lien de rubriqueConventions de la syntaxe Transact-SQL

Syntaxe

sp_add_jobschedule [ @job_id = ] job_id, | [ @job_name = ] 'job_name', [ @name = ] 'name'
     [ , [ @enabled = ] enabled_flag ]
     [ , [ @freq_type = ] frequency_type ]
     [ , [ @freq_interval = ] frequency_interval ]
     [ , [ @freq_subday_type = ] frequency_subday_type ]
     [ , [ @freq_subday_interval = ] frequency_subday_interval ]
     [ , [ @freq_relative_interval = ] frequency_relative_interval ]
     [ , [ @freq_recurrence_factor = ] frequency_recurrence_factor ]
     [ , [ @active_start_date = ] active_start_date ]
     [ , [ @active_end_date = ] active_end_date ]
     [ , [ @active_start_time = ] active_start_time ]
     [ , [ @active_end_time = ] active_end_time ]
     [ , [ @schedule_id = ] schedule_id OUTPUT ]

Arguments

  • [ @job_id= ] job_id
    Numéro d'identification du travail auquel ajouter la planification. L'argument job_id est de type uniqueidentifier et n'a pas de valeur par défaut.

  • [ @job_name= ] 'job_name'
    Nom du travail auquel la planification est ajoutée. L'argument job_name est de type nvarchar(128) et n'a pas de valeur par défaut.

    Notes

    Vous devez définir la valeur de job_id ou de job_name, mais pas les deux valeurs à la fois.

  • [ @name= ] 'name'
    Nom de la planification. L'argument name est de type nvarchar(128) et n'a pas de valeur par défaut.

  • [ @enabled= ] enabled_flag
    Indique l'état actuel de la planification. L'argument enabled_flag est de type tinyint, avec la valeur 1 par défaut (activé). Si la valeur 0 est affectée à l'argument, la planification n'est pas activée. Lorsque la planification n'est pas activée, le travail n'est pas exécuté.

  • [ @freq_type= ] frequency_type
    Valeur qui indique à quel moment le travail doit s'exécuter. L'argument frequency_type est de type int, avec 0 comme valeur par défaut. Il peut prendre l'une des valeurs suivantes :

    Valeur

    Description

    1

    Une fois

    4

    Quotidienne

    8

    Hebdomadaire

    16

    Mensuelle

    32

    Mensuellement, en fonction de frequency_interval.

    64

    Lancer lorsque le service de l'Agent SQL Server démarre.

    128

    Lancer lorsque l'ordinateur est inactif.

  • [ @freq_interval= ] frequency_interval
    Jour d'exécution du travail. L'argument frequency_interval est de type int, avec 0 comme valeur par défaut, et varie en fonction de la valeur de frequency_type, comme indiqué dans le tableau suivant :

    Valeur

    Effet

    1 (une fois)

    frequency_interval n'est pas utilisé.

    4 (quotidiennement)

    Tous les frequency_interval jours.

    8 (hebdomadairement)

    frequency_interval prend une ou plusieurs des valeurs suivantes (combinées avec un opérateur logique OR) :

    1 = Dimanche

    2 = Lundi

    4 = Mardi

    8 = Mercredi

    16 = Jeudi

    32 = Vendredi

    64 = Samedi

    16 (mensuellement)

    Le jour défini par l'argument frequency_interval.

    32 (mensuel relatif)

    frequency_interval prend l'une des valeurs suivantes :

    1 = Dimanche

    2 = Lundi

    3 = Mardi

    4 = Mercredi

    5 = Jeudi

    6 = Vendredi

    7 = Samedi

    8 = Jour

    9 = Jour de semaine

    10 = Jour de week-end

    64 (lorsque le service de l'Agent SQL Server démarre)

    frequency_interval n'est pas utilisé.

    128

    frequency_interval n'est pas utilisé.

  • [ @freq_subday_type= ] frequency_subday_type
    Spécifie les unités pour frequency_subday_interval. L'argument frequency_subday_type est de type int sans valeur par défaut et peut correspondre à l'une de ces valeurs :

    Valeur

    Description (unité)

    0x1

    À une heure spécifiée

    0x4

    Minutes

    0x8

    Heures

  • [ @freq_subday_interval= ] frequency_subday_interval
    Nombre de périodes en frequency_subday_type entre chaque exécution d'un travail. frequency_subday_interval est de type int, avec 0 comme valeur par défaut.

  • [ @freq_relative_interval= ] frequency_relative_interval
    Définit de manière plus approfondie frequency_interval lorsque frequency_type a la valeur 32 (fréquence mensuelle relative).

    L'argument frequency_relative_interval est de type int sans valeur par défaut et peut correspondre à l'une de ces valeurs :

    Valeur

    Description (unité)

    1

    First

    2

    Deuxième

    4

    Troisième

    8

    Quatrième

    16

    Last

    frequency_relative_interval indique l'occurrence de l'intervalle. Par exemple, si frequency_relative_interval a la valeur 2, frequency_type a la valeur 32 et frequency_interval a la valeur 3, le travail planifié a lieu le deuxième mardi de chaque mois.

  • [ @freq_recurrence_factor= ] frequency_recurrence_factor
    Nombre de semaines ou de mois devant s'écouler entre l'exécution planifiée du travail. frequency_recurrence_factor est utilisé uniquement si frequency_type a la valeur 8, 16 ou 32. frequency_recurrence_factor est de type int, avec 0 comme valeur par défaut.

  • [ @active_start_date= ] active_start_date
    Date à laquelle l'exécution du travail peut commencer. active_start_date est de type int, sans valeur par défaut. La date a le format AAAAMMJJ. Si une valeur est affectée à l'argument active_start_date, la date doit être supérieure ou égale à 19900101.

    Après avoir créé la planification, examinez la date de début et assurez-vous qu'elle est correcte. Pour plus d'informations, consultez la section relative à la planification de la date de début dans Création et attachement de planifications à des travaux.

  • [ @active_end_date= ] active_end_date
    Date à laquelle l'exécution du travail peut s'arrêter. active_end_date est de type int, sans valeur par défaut. La date est au format AAAAMMJJ.

  • [ @active_start_time= ] active_start_time
    Heure de n'importe quel jour entre active_start_date et active_end_date pour démarrer l'exécution du travail. active_start_time est de type int, sans valeur par défaut. L'heure est au format HHMMSS et est exprimée sur 24 heures.

  • [ **@active_end_time=**active_end_time
    Heure de n'importe quel jour entre active_start_date et active_end_date pour arrêter l'exécution du travail. active_end_time est de type int, sans valeur par défaut. L'heure est au format HHMMSS et est exprimée sur 24 heures.

  • [ @schedule_id=schedule_idOUTPUT
    Numéro d'identification de planification affecté à la planification si le travail est correctement créé. schedule_id est une variable de sortie de type int, sans valeur par défaut.

  • [ @schedule_uid= ] schedule_uidOUTPUT
    Identificateur unique de la planification. La variable schedule_uid est de type uniqueidentifier.

Valeurs des codes de retour

0 (succès) ou 1 (échec)

Jeux de résultats

Aucun

Notes

Il est désormais possible de gérer la planification des travaux indépendamment des travaux. Pour ajouter une planification à un travail, utilisez sp_add_schedule pour créer la planification et sp_attach_schedule pour l'associer à un travail.

Autorisations

Seuls les membres du rôle de 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 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.