Documentation sur Oracle Cloud Infrastructure

Informations de référence sur l'ensemble DBMS_DATA_TOOLS_JOBS

Ce chapitre fournit des informations sur les packages que vous utilisez avec la fonctionnalité Jobs dans Data Studio. La rubrique Sommaire des sous-programmes DBMS_DATA_TOOLS_JOBS couvre également les procédures incluses dans l'ensemble DBMS_DATA_TOOLS_JOBS.

Rubriques :

Sommaire des sous-programmes DBMS_DATA_TOOLS_JOB

Rubrique parent : Fonction Travaux

Sommaire des sous-programmes DBMS_DATA_TOOLS_JOB

L'ensemble DBMS_DATA_TOOLS_JOB fournit un ensemble de fonctions et de procédures de programmation que vous utilisez avec la fonction Tâches de la suite d'outils Data Studio.

DBMS_DATA_TOOLS_JOB Sous-programmes d'ensemble

Le tableau suivant répertorie les sous-programmes DBMS_DATA_TOOLS_JOB et les décrit brièvement.

Tableau 3-11 DBMS_DATA_TOOLS_JOB Noms et description des sous-programmes DBMS_DATA_TOOLS_JOB

Sous-programme Description
Procédure de création d'emploi Cette procédure crée un nouveau travail.
Procédure de suppression d'emploi Supprime le travail du programmateur.
Renommer la procédure Job Renomme le travail avec le nom souhaité.
Mettre à jour la procédure d'emploi Modifie les attributs d'un travail existant.
Exécuter la procédure Exécute une tâche immédiatement, quel que soit le programme que vous définissez.
Procédure d'arrêt de travail Arrête un travail en cours d'exécution. Cela met fin à un travail gracieusement et, si nécessaire, l'arrête de force.

CREATE_JOB Procédure

Cette procédure crée un seul travail. Si vous créez le travail comme activé en réglant l'attribut Activé à TRUE, le planificateur exécute automatiquement le travail en fonction de sa programmation. Si vous créez le travail désactivé, il ne s'exécute pas tant que vous ne l'avez pas activé avec la fonction Activer le travail.

Syntaxe 

dbms_data_tools_job.create_job(
                       job_name        in varchar2,
                       description     in varchar2,
                       steps           in clob,
                       owner           in varchar2 default null,
                       start_date      IN TIMESTAMP WITH TIME ZONE DEFAULT NULL,
                       repeat_interval IN VARCHAR2                 DEFAULT NULL,
                       end_date        IN TIMESTAMP WITH TIME ZONE DEFAULT NULL,
                       job_class       IN VARCHAR2                 DEFAULT NULL,
                       enabled         IN BOOLEAN                  DEFAULT FALSE,
                       reporting       in clob default null);

CREATE_JOB Paramètres de procédure

Tableau 3-12 CREATE_JOB Paramètres de procédure

Paramètre Description
Nom de tâche Nom à affecter à l'emploi. Si job_name n'est pas spécifié, une erreur est générée.
Description Il s'agit d'informations supplémentaires définies pour les emplois.
Étapes Il s'agit des différentes tâches exécutées par l'outil Data Studio qui comprennent un travail.
Steps est un tableau JSON. Chaque élément de tableau est un objet JSON. Voici les éléments JSON qui s'appliquent à tous les objets :
  • type - chaîne, déclare le type d'étape qui est effectuée : data_load, smart_table, procédure, http.
  • on_errors- Chaîne
  • stop : Si une erreur est détectée, la tâche est arrêtée et l'erreur est générée.
  • continue : L'erreur est enregistrée, mais le traitement se poursuit à l'étape suivante de la tâche.
  • step_name - Nom descriptif de l'étape à afficher dans les journaux

Chaque type d'objet comporte des éléments supplémentaires en fonction du type.

data_load:
  • data_load_name - (obligatoire) Nom d'un chargement de données créé précédemment à exécuter

smart_table:
  • recipe_name - (Obligatoire) Nom d'une recette de table intelligente créée précédemment à exécuter.
  • url - URL REST (obligatoire) à laquelle se connecter.
  • method - GET (par défaut), POST, PUT, DELETE ou tout autre verbe HTTP
procedure:

  • procedure - Nom (obligatoire) de la procédure à exécuter. Il peut éventuellement être qualifié de schéma et peut être une procédure nue ou une méthode de package.

  • arguments - Tableau d'arguments chaîne, nombre ou booléen à fournir à la procédure.
Responsable

Il s'agit du schéma dans lequel le travail est créé. Si vous créez un travail sans spécifier de schéma, le responsable sera l'utilisateur exécutant la procédure CREATE_JOB.

Date de début

Cet attribut spécifie la première date et heure auxquelles le démarrage de la tâche est programmé. Si start_date et repeat_interval restent vides, l'exécution de la tâche est programmée dès que la tâche est activée.

Pour les tâches répétitives qui utilisent une expression de planification pour spécifier l'intervalle de répétition, start_date est utilisé comme date de référence. La première exécution du travail correspond à la première correspondance de l'expression de planification qui est identique ou postérieure à la date et à l'heure courantes.

Le planificateur ne peut pas garantir qu'un travail s'exécute à une heure exacte, car le système peut être surchargé et les ressources ne sont donc pas disponibles.
Intervalle de répétition

Cet attribut spécifie la fréquence de répétition de la fenêtre. Il est exprimé à l'aide de la syntaxe de planification du planificateur. Pour plus d'informations, voir "Syntaxe de calendrier".

Une expression PL/SQL ne peut pas être utilisée pour spécifier l'intervalle de répétition d'une fenêtre.

L'expression spécifiée est évaluée pour déterminer la prochaine ouverture de la fenêtre. Si aucune valeur repeat_interval n'est spécifiée, la fenêtre ne s'ouvre qu'une seule fois à la date de début spécifiée.

Date de fin

Cet attribut spécifie la date et l'heure après lesquelles la tâche expire et n'est plus exécutée.

La valeur de end_date doit être postérieure à la valeur de start_date. Si end_date est inférieur à start_date, une erreur est générée. Si end_date est identique à start_date, la tâche ne s'exécutera pas et aucune erreur ne sera générée.

Si aucune valeur n'est spécifiée pour end_date, la tâche se répète définitivement sauf si vous utilisez stop job.
Classe de la tâche Classe à laquelle ce travail est associé.
Cochée Cet attribut spécifie si la création de la tâche est activée ou non. Les paramètres possibles sont TRUE ou FALSE. Par défaut, cet attribut est réglé à FALSE et, par conséquent, la tâche est créée comme désactivée. Une tâche désactivée signifie que les métadonnées de la tâche ont été saisies et qu'elle existe en tant qu'objet de base de données. Toutefois, le planificateur ignore le travail et le coordinateur du travail ne le sélectionne pas pour traitement. Pour que le coordonnateur traite la tâche, celle-ci doit être activée. Vous pouvez activer une tâche en sélectionnant l'icône Enable Job.
Production de rapports Cet attribut spécifie les détails d'exécution de tâche au moyen du bouton Rapport dans la fonction Tâches.
Il s'agit d'un objet JSON similaire à l'argument de production de rapports pour dbms_live_feed. Il peut comporter les éléments suivants :

  • completed : Cibles à aviser lorsqu'une tâche est terminée.

  • errors : Cibles à aviser lorsqu'une étape d'une tâche a rencontré des erreurs.

  • failed : Cibles à aviser lorsqu'une tâche présente une erreur fatale en dehors du contexte d'une étape.

  • long : Cibles à aviser lorsqu'une tâche est longue.

Chacun de ces quatre éléments peut spécifier un tableau d'adresses de courriel dans l'élément smtp ou des canaux de marge dans l'élément slack. L'élément long peut avoir un élément max_runtime_seconds qui détermine la durée d'exécution d'un travail avant qu'il ne soit considéré comme ayant exécuté trop long.

DELETE_JOB Procédure

Cette procédure supprime un travail.

Syntaxe 

dbms_data_tools_job.delete_job(job_name in varchar2, owner in varchar2 default null);

DELETE_JOB Paramètres de procédure

Tableau 3-13 DELETE_JOB Paramètres de procédure

Paramètre Description
Nom de tâche Nom à affecter à l'emploi. Si job_name n'est pas spécifié, une erreur est générée.
Responsable

Il s'agit du schéma dans lequel le travail est créé. Si vous créez un travail sans spécifier de schéma, le responsable sera l'utilisateur exécutant la procédure CREATE_JOB.

RENAME_JOB Procédure

Cette procédure renomme un travail.

Syntaxe 

dbms_data_tools_job.rename_job(old_job_name in varchar2,
                       new_job_name in varchar2,
                       owner        in varchar2 default null);

RENAME_JOB Paramètres de procédure

Tableau 3-14 RENAME_JOB Paramètres de procédure

Paramètre Description
Nom de l'ancienne tâche Nom de la tâche existante.
Nom du nouvel emploi

Nom du nouvel emploi.
Responsable

Il s'agit du schéma dans lequel le travail est créé.

UPDATE_JOB Procédure

Cette procédure met à jour tous les attributs d'emploi existants.

Syntaxe 

dbms_data_tools_job.update_job(job_name in varchar2,
                       owner           in varchar2 default null,
                       description     in varchar2 default null,
                       steps           in clob default null,
                       start_date      IN TIMESTAMP WITH TIME ZONE DEFAULT NULL,
                       repeat_interval IN VARCHAR2                 DEFAULT NULL,
                       end_date        IN TIMESTAMP WITH TIME ZONE DEFAULT NULL,
                       job_class       IN VARCHAR2                 DEFAULT NULL,
                       enabled         IN BOOLEAN                  DEFAULT NULL,
                       reporting       in clob default null);

UPDATE_JOB Paramètres de procédure

Tableau 3-15 UPDATE_JOB Paramètres de procédure

Paramètre Description
Nom de tâche Nom de la tâche à mettre à jour.
Responsable

Il s'agit du schéma dans lequel le travail doit être mis à jour.
Description Description mise à jour à appliquer.
Étapes Les nouvelles étapes à mettre à jour.
Date de début La nouvelle date de début.
Intervalle de répétition Intervalle de répétition mis à jour.
Date de fin Date de fin mise à jour.
Classe de la tâche Classe d'emploi mise à jour.
Cochée Il peut être activé ou désactivé.
Production de rapports Attribut de rapport mis à jour.

Exécuter la procédure

Cette procédure exécute un travail immédiatement.

Si un travail est activé, le planificateur l'exécute automatiquement. Il n'est pas nécessaire d'appeler RUN_JOB pour exécuter une tâche en fonction de sa programmation. Utilisez RUN_JOB pour exécuter une tâche en dehors de son programme normal.

Syntaxe 

dbms_data_tools_job.run(job_name            in varchar2,
                owner               in varchar2 default null,
                use_current_session in number   default null,
                options             in clob     default null);

Paramètres de procédure RUN

Tableau 3-16 : Paramètres de procédure RUN

Paramètre Description
Nom de tâche

Nom d'un travail ou liste d'entrées séparées par des virgules, chacune étant le nom d'un travail existant, éventuellement précédée d'un nom de schéma et d'un séparateur de points.

Si vous spécifiez un travail à destinations multiples, le travail s'exécute sur toutes les destinations. Dans ce cas, l'argument use_current_session doit être FALSE.

Responsable

Il s'agit du schéma dans lequel le travail est exécuté.
Utiliser la session courante

Cette option indique si l'exécution du travail doit avoir lieu dans la même session à partir de laquelle la procédure a été appelée.

Lorsque use_current_session est réglé à TRUE :

  • Vous pouvez tester un travail et voir toutes les erreurs possibles sur la ligne de commande.

  • RUN peut être exécuté en parallèle avec une exécution de travail programmée régulièrement.

Lorsque use_current_session est réglé à FALSE :
  • Vous devez consulter le journal des travaux pour trouver des informations sur les erreurs.
  • Tous les champs pertinents dans scheduler_jobs sont mis à jour.
  • RUN échoue si une tâche régulièrement programmée est en cours d'exécution.
Options  

STOP_JOB Procédure

Cette procédure arrête les travaux en cours d'exécution ou tous les travaux d'une classe de travail.

Après l'arrêt de la tâche, l'état d'une tâche ponctuelle est réglé à STOPPED, tandis que l'état d'une tâche répétitive est réglé à SCHEDULED ou COMPLETED, selon que la prochaine exécution de la tâche est programmée ou non.

Syntaxe 

 dbms_data_tools_job.stop_job(job_name in varchar2,
                     owner    in varchar2 default null,
                     force    in boolean  default false);

STOP_JOB Paramètres de procédure

Tableau 3-17 STOP_JOB Paramètres de procédure

Paramètre Description
Nom de tâche

Nom d'une tâche à arrêter. Il s'agit du nom d'un travail existant, éventuellement précédé d'un nom de schéma et d'un séparateur de points.
Responsable

Il s'agit du schéma dans lequel le travail doit être arrêté.
Force

Si force est réglé à FALSE, le programmateur tente d'arrêter correctement la tâche à l'aide d'un mécanisme d'interruption. Cette méthode donne le contrôle au processus esclave, qui peut mettre à jour le statut du travail dans la file d'attente de travaux à Arrêté. Si cela échoue, une erreur est renvoyée.

Si force est réglé à TRUE, le programmateur met immédiatement fin à l'esclave de la tâche. Oracle recommande que STOP_JOB avec force réglée à TRUE ne soit utilisé qu'après l'échec d'un STOP_JOB avec force réglé à FALSE.

L'utilisation de l'option force nécessite le privilège système MANAGE SCHEDULER.