Cours PL SQL apprendre les bases fondamentales du langage
![Cours PL SQL apprendre les bases fondamentales du langage](/images/remos_downloads/id-2506.2506.pdf_thumb_prev.jpg)
Oracle PL/SQL
par SheikYerbouti
Date de publication : Avril 2004
Dernière mise à jour : Juillet 2004
Découvrez le langage procédural d'Oracle
Introduction
1 - Le bloc PL/SQL
1.1 - La section déclarative
1.2 - La section exécution
1.2.1 - Assignation 1.2.2 - OPEN
1.2.3 - OPEN FOR
1.2.4 - CLOSE
1.2.5 - COMMIT
1.2.6 - EXECUTE IMMEDIATE
1.2.7 - EXIT
1.2.8 - FETCH
1.2.9 - FORALL
1.2.10 - GOTO
1.2.11 - IF
1.2.12 - CASE
1.2.13 - FOR (curseur)
1.2.14 - FOR, LOOP, WHILE
1.2.15 - NULL
1.2.16 - RAISE
1.2.17 - RETURN
1.2.18 - SAVEPOINT
1.2.19 - ROLLBACK
1.2.20 - SELECT INTO
1.2.21 - Instruction SQL
1.2.22 - Les curseurs explicites
1.2.23 - Portée des variables
1.3 - La section de gestion des erreurs
2 - Les variables, types et littéraux
2.1 - Les variables
2.2 - Types prédéfinis
2.2.1 - Types caractères
2.2.2 - Types numériques
2.2.3 - Types pour les grands objets
2.2.4 - Types supplémentaires
2.3 - Les Types et Sous-types définis par l'utilisateur
2.4 - Les littéraux
2.4.1 - Littéral de type caractère
2.4.2 - Littéral de type entier
2.4.3 - Littéral de type décimal
2.4.4 - Littéral de type intervalle (9i)
3 - Les fonctions natives
3.1 - Les fonctions chaînes de caractères
3.2 - Les fonctions arithmétiques
3.3 - Les fonctions de conversion et de transformation
3.4 - Les fonctions sur les dates
4 - Procédures, Fonctions et paquetages
4.1 - Les Procédures
4.2 - Les Fonctions
4.3 - Les Paquetages
4.4 - Fonctions sur des ensembles de lignes (PIPELINED) (9i)
4.5 - Maintenance des objets procéduraux
5 - Collections et enregistrements
5.1 - Déclarations et initialisation
5.2 - Accès aux éléments d'une collection
5.3 - Méthodes associées aux collections
5.4 - Utilisation des collections avec les données issues de la base
5.5 - Traitements en masse des collections
5.6 - Les collections et enregistrements en paramètres des procédures et fonctions
6 - Les déclencheurs
6.1 - Les déclencheurs sur TABLE
6.2 - Les déclencheurs sur VUE
6.3 - Les déclencheurs sur évènements système ou utilisateur
6.3.1 - Les attributs
6.3.2 - Les évènements système
6.3.3 - Les évènements utilisateur
6.4 - Maintenance des déclencheurs
7 - Le paquetage DBMS_OUTPUT
8 - Le paquetage UTL_FILE
8.1 - Procédures et fonctions du paquetage
8.1.1 - Liste des procédures et fonctions version 8i
8.1.2 - Liste des procédures et fonctions version 9i
8.2 - Syntaxe des procédures et fonctions
8.2.1 - IS_OPEN
8.2.2 - FCLOSE
8.2.3 - FCLOSE_ALL
8.2.4 - FCOPY
8.2.5 - FOPEN
8.2.6 - FOPEN_NCHAR
8.2.7 - FFLUSH
8.2.8 - FGETATTR
8.2.9 - FGETPOS
8.2.10 - FREMOVE
8.2.11 - FRENAME
8.2.12 - FSEEK
8.2.13 - GET_LINE
8.2.14 - GET_LINE_NCHAR
8.2.15 - GET_RAW
8.2.16 - NEW_LINE
8.2.17 - PUT
8.2.18 - PUT_NCHAR
8.2.19 - PUT_RAW
8.2.20 - PUT_LINE
8.2.21 - PUT_LINE_NCHAR
8.2.22 - PUTF
8.2.23 - PUTF_NCHAR
8.3 - Exceptions générées par le paquetage
8.3.1 - Exceptions de la version 8i
8.3.2 - Exceptions de la version 9i
8.4 - Exemples concrets
9 - Le paquetage DBMS_LOB
9.1 - Procédures et fonctions du paquetage
9.1.1 - Procédures et fonctions des versions 8i et 9i
9.1.2 - Procédures de la version 9i
9.1.3 - Procédures de la version 10g
9.2 - Syntaxe des procédures et fonctions
9.2.1 - APPEND
9.2.2 - CLOSE
9.2.3 - COMPARE
9.2.4 - CONVERTTOBLOB
9.2.5 - CONVERTTOCLOB
9.2.6 - COPY
9.2.7 - CREATETEMPORARY
9.2.8 - ERASE
9.2.9 - FILECLOSE
9.2.10 - FILECLOSEALL
9.2.11 - FILEEXISTS
9.2.12 - FILEGETNAME
9.2.13 - FILEISOPEN
9.2.14 - FILEOPEN
9.2.15 - FREETEMPORARY
9.2.16 - GETCHUNKSIZE
9.2.17 - GETLENGTH
9.2.18 - INSTR
9.2.19 - ISOPEN
9.2.20 - ISTEMPORARY
9.2.21 - LOADFROMFILE
9.2.22 - LOADBLOBFROMFILE
9.2.23 - LOADCLOBFROMFILE
9.2.24 - OPEN
9.2.25 - READ
9.2.26 - SUBSTR
9.2.27 - TRIM
9.2.28 - WRITE
9.2.29 - WRITEAPPEND
9.3 - Exceptions générées par le paquetage
9.4 - Exemples
9.5 - Manipulations courantes des LOB de type caractères (CLOB)
Index de recherche
Remerciements
Introduction
Tutoriel au format PDF
Téléchargez le tutoriel au format PDF
PL/SQL est le langage procédural d'Oracle. Il est une extension du SQL qui est un langage ensembliste.
PL/SQL permet de gérer des traitements qui utilisent les instructions SQL dans un langage procédural.
Les instructions de manipulation des données, de description des données, de contrôle des transactions, les fonctions SQL peuvent être utilisées avec la même syntaxe.
La gestion des variables et des structures de contrôle (tests, boucles) augmente la capacité de traitement des données
La gestion des curseurs et du traitement des erreurs accroît les possibilités de traitement Les instructions sont regroupées dans une unité appelée bloc qui ne génère qu'un accès à la base
Les blocs ou procédures PL/SQL sont compilés et exécutés par le moteur PL/SQL.
Ce moteur est intégré au moteur de la base de données et dans un certain nombre d'outils (Forms, Report).
En résumé, PL/SQL permet de construire des applications
Indication au lecteur
Cet ouvrage se situe entre le tutorial et le guide de référence
Il n'a pas pour vocation de se substituer à un ouvrage de formation à l'usage du débutant
La compréhension de cet article sous-entend des connaissances préalables en développement(en général) et en SQL(en particulier)
Versions des logiciels utilisés
L'intégralité des exemples présentés dans l'article a été effectuée avec la configuration suivante
OS : Windows 2000 5.00.2195 service pack 3
Noyau Oracle : Oracle9i Enterprise Edition Release 9.2.0.1.0 - Production
Sql*Plus : SQL*Plus: Release 9.2.0.1.0 - Production
Ce document traite des fonctionnalités PL/SQL actuellement en cours.
Dans la mesure du possible les nouveautés apparues avec la version 9i et 10g sont indiquées (9i) ou (10g) En aucun cas, ce travail n'a été effectué entre les versions 7 et 8.
Il est donc tout à fait possible que certains exemples tirés de cet article provoquent des erreurs de compilation ou d'exécution s'ils sont testés sur une version inférieure à 9.2
1 - Le bloc PL/SQL
PL/SQL est un langage structuré en blocs, constitués d'un ensemble d'instructions.
Un bloc PL/SQL peut être "externe", on dit alors qu'il est anonyme, ou alors stocké dans la base de données sous forme de procédure, fonction ou trigger.
un bloc PL/SQL est intégralement envoyé au moteur PL/SQL, qui traite chaque instruction PL/SQL et sous-traite les instructions purement SQL au moteur SQL, afin de réduire le trafic réseau.
Syntaxe d'un bloc PL/SQL
Chaque bloc PL/SQL peut être constitué de 3 sections :
• Une section facultative de déclaration et initialisation de types, variables et constantes
• Une section obligatoire contenant les instructions d'exécution
• Une section facultative de gestion des erreurs
[DECLARE
# déclarations et initialisation]
BEGIN
# instructions exécutables
[EXCEPTION
# interception des erreurs]
END;
Un bloc PL/SQL minimum peut être représenté de la façon suivante :
Le mot clé BEGIN détermine le début de la section des instructions exécutables
Le mot clé END; indique la fin de la section des instructions exécutables Une seule instruction figure dans ce bloc : Null; qui ne génère aucune action Ce bloc PL/SQL ne fait donc absolument rien !
La section déclarative (facultative) d'un bloc débute par le mot clé DECLARE
Elle contient toutes les déclarations des variables qui seront utilisées localement par la section exécutable, ainsi que leur éventuelle initialisation.
Une variable LC$Chaine est déclarée de type VARCHAR2(15) et initialisée avec la valeur 'Salut Monde' ;
Dans la section exécutable, cette variable est transmise à la fonction DBMS_OUTPUT() pour être affichée à l'écran Cette section ne peut pas contenir d'instructions exécutables. Toutefois, il est possible de définir dans cette section des procédures ou des fonctions contenant une section exécutable.
Toute variable doit avoir été déclarée avant de pouvoir être utilisée dans la section exécutable.
La section de gestion des erreurs (facultative) débute par le mot clé EXCEPTION
Elle contient le code exécutable mis en place pour la gestion des erreurs
Lorsqu'une erreur intervient dans l'exécution, le programme est stoppé et le code erreur est transmis à cette section
Les erreurs doivent être interceptées avec le mot clé WHEN suivi du code erreur ciblé. Ici, le code OTHERS qui définit toutes les erreurs non interceptées individuellement par les clauses WHEN précédentes.
Cette section peut elle-même contenir d'autres blocs PL/SQL
Les blocs PL/SQL peuvent être imbriqués les uns dans les autres
1.1 - La section déclarative
Vous pouvez déclarer dans cette section tous les types, variables et constantes nécessaires à l'exécution du bloc.
Ces variables peuvent être de n'importe quel type SQL ou PL/SQL ().
Leur initialisation, facultative, s'effectue avec l'opérateur :=
DECLARE LN$Nbre | NUMBER(3) := 0 ; |
LD$Date | DATE := SYSDATE ; |
LC$Nom | VARCHAR2(10) := 'PL/SQL' ; |
Une constante est une variable dont l'initialisation est obligatoire et dont la valeur ne pourra pas être modifiée en cours d'exécution
Elle est déclarée avec le mot clé : CONSTANT qui doit précéder le type
PL/SQL n'est pas sensible à la casse. Pour lui les expressions suivantes sont équivalentes :
NOM_VARIABLE NUMBER ;
Nom_Variable Number ; nom_variable number ;
1.2 - La section exécution
Délimitée par les mots clé BEGIN et END; elle contient les instructions d'exécution du bloc PL/SQL, les instructions de contrôle et d'itération, l'appel des procédures et fonctions, l'utilisation des fonctions natives, les ordres SQL, etc.
Chaque instruction doit être suivi du terminateur d'instruction ;
Voici la liste des instructions que cette section peut contenir
1.2.1 - Assignation
L'assignation d'une valeur à une variable peut être faite de 2 façons différentes
• En utilisant l'opérateur :=
• Par l'intermédiaire d'un ordre SELECT # INTO ou FETCH # INTO
1.2.2 - OPEN
Ouverture d'un curseur SQL
nom curseur représente le nom donné au curseur qui permettra de le référencer dans les instructions suivantes paramètres du curseur représente la liste des paramètres transmis au curseur
le curseur doit avoir été préalablement défini dans la section déclarative
1.2.3 - OPEN FOR
Ouverture d'un curseur SQL incluant l'ordre select correspondant.
La déclaration préalable du curseur dans la section déclarative n'est pas nécessaire
1.2.4 - CLOSE
Cette instruction est utilisée pour fermer un curseur préalablement ouvert avec l'instruction OPEN
CLOSE(nom_curseur)
Après cette instruction, le curseur n'est plus valide et toute instruction s'y reportant génèrera une erreur (voir exemple précédent)
1.2.5 - COMMIT
Cette instruction permet d'enregistrer en base toutes les modifications effectuées au cours de la transaction
Le mot clé WORK est facultatif et n'a aucun effet particulier
Un commentaire d'un maximum de 50 caractères peut apparaître entre apostrophes derrière le mot clé COMMENT
1.2.6 - EXECUTE IMMEDIATE
Cette instruction permet d'exécuter du SQL dynamique
-> Pour une explication détaillée de cette instruction, reportez-vous à l'article sur le sql dynamique natif
1.2.7 - EXIT
Cette instruction permet de quitter une structure itérative
label facultatif permet de nommer précisément la structure dont on veut sortir. expression booléenne permet de spécifier une condition de sortie
Exit saute à l'instruction suivant le mot clé END LOOP;
Dans le cas de boucles imbriquées, l'indication d'un label permet de quitter tout ou partie des boucles imbriquées
Lorsque le test effectué (LN$Num > 3) est vérifié (TRUE), la boucle Loop # End loop est quittée
Dans cet exemple, l'instruction EXIT suivie du label boucle1 permet de quitter les deux boucles imbriquées
1.2.8 - FETCH
Cette instruction permet de ramener une ligne d'un curseur préalablement ouvert avec l'instruction OPEN ou OPEN FOR
nom curseur représente le nom d'un curseur préalablement ouvert avec l'instruction OPEN ou OPEN FOR nom variable curseur représente le nom d'une variable curseur
nom variable curseur hôte représente le nom d'une variable curseur transmise par un programme tiers (ex : Pro*C, Pro*Cobol, etc.)
variable représente le nom d'une variable préalablement définie dans la section déclarative, qui doit être du même type que la colonne ramenée par l'instruction Select
enregistrement représente le nom d'un enregistrement préalablement défini dans la section déclarative qui doit être du même type que la ligne ramenée par l'instruction Select nom collection représente le nom d'une collection préalablement définie dans la section déclarative nom tableau hôte représente le nom du tableau transmis par un programme tiers
Si l'instruction FETCH ne ramène plus de ligne (fin du curseur) l'attribut %NOTFOUND prend la valeur TRUE et l'attribut %FOUND prend la valeur FALSE
-> Pour voir des exemples, reportez-vous à la section Les curseurs explicites (1.2.22)
1.2.9 - FORALL
Cette instruction permet de générer des ordres SQL de masse basés sur le contenu d'une collection
variable index représente l'indice de la collection sur laquelle porte l'instruction FORALL borne début représente la valeur d'indice de départ borne fin représente la valeur d'indice de fin instruction sql doit être un ordre SQL de type INSERT, UPDATE ou DELETE
(10g)
FORALL i IN INDICES OF nom_collection
permet de ne traiter que les indices valorisés de la collection (non forcément consécutifs comme il était impératif dans les versions précédentes)
Pour voir des exemples, reportez-vous au chapitre 5 Collections et enregistrements
1.2.10 - GOTO
Cette instruction permet d'exécuter un saut dans le code vers le label precisé
Une instruction valide doit suivre la déclaration du label
1.2.11 - IF
Cette instruction permet de faire des tests conditionnels
expression booléenne représente un test générant un booléen TRUE ou FALSE
Seuls les mots clé IF et END IF; sont obligatoires. Les clauses ELSIF et ELSE sont facultatives
1.2.12 - CASE
Cette instruction permet de mettre en place des structures de test conditionnel de type IF .. ELSE .. END IF, à la grande différence qu'elle est utilisable dans les requêtes SQL
2 syntaxes sont possibles
• CASE simple
[<<label>>] CASE opérateur { WHEN contenu_opérateur THEN { instruction;} } [ELSE { instruction;} ]
END CASE [label];
• CASE de recherche
[<<label>>] CASE { WHEN expression_booléenne THEN { instruction;} } [ELSE { instruction;} ] END
CASE [label];
opérateur peut être n'importe quel type PL/SQL à l'exception des objets suivants :
• BLOB
• BFILE
• Type objet
• Enregistrement
• Collection (NESTED TABLE, INDEX-BY TABLE, VARRAY)
Pour le CASE simple, chaque mot clé WHEN vérifie l'égalité entre opérateur et contenu_opérateur. Dans l'affirmative, l'instruction suivant le mot clé THEN est exécutée, puis la structure CASE est quittée et l'exécution du programme est reprise après le mot clé END CASE;
Exemple de CASE de recherche
Cette fois l'opérateur est précisé sur chaque ligne WHEN
Il ne s'agit alors plus d'un simple test d'égalité, mais de n'importe quelle expression booléenne restituant un résultat TRUE ou FALSE.
On observe également que le débranchement dans une clause WHEN est exclusif. En effet, dans chaque itération de boucle, la variable LN$Num est inférieure à 5, mais n'est prise en compte dans la deuxième clause WHEN que lorsque la première n'est plus vérifiée
Pour le CASE de recherche, l'omission de la clause ELSE provoque une erreur
1.2.13 - FOR (curseur)
Cette instruction permet de gérer un curseur sans utiliser les ordres OPEN, FETCH et CLOSE
enregistrement représente un nom de variable de type curseur implicite.
nom curseur représente le nom d'un curseur préalablement défini dans la section déclarative
La variable de curseur implicite Cur, non définie dans la section déclarative, doit être utilisée pour manipuler dans la boucle, les objets du curseur (To_char( Cur.empno ),Cur.ename)
Après l'instruction END LOOP; l'utilisation de cette variable génère une erreur
Avec cette syntaxe, l'utilisation des instructions OPEN, FETCH et CLOSE est inutile
Instruction FOR et curseur paramétré
Le passage des paramètres s'effectue sur le curseur déclaré (C_EMP) et non sur la variable curseur (Cur)
1.2.14 - FOR, LOOP, WHILE
Ces instructions déclarent une structure de type itérative (boucle)
Trois syntaxes sont possibles
• LOOP instruction;[instruction;[ ]] END LOOP;
Cette syntaxe met en place une boucle simple ou aucune condition de sortie n'est indiquée
Il faut donc une instruction EXIT pour sortir de ce type de boucle
• WHILE expression booléenne LOOP instruction;[instruction;[ ]] END LOOP;
Cette syntaxe permet de mettre en place une boucle dont la condition de test est évaluée au début.
Si expression booléenne donne le résultat FALSE, les instructions suivantes jusqu'au mot clé END LOOP; ne seront pas exécutées
• FOR variable index IN [REVERSE] borne_début..borne_fin LOOP instruction;[instruction;[ ]] END LOOP;
Cette syntaxe permet de mettre en place une boucle dont le nombre d'itérations est fixé dès l'entrée
Variable index représente le nom de la variable qui servira d'indice. Cette variable ne nécessite pas de définition préalable dans la section déclarative
Reverse permet de faire varier l'indice dans le sens contraire (décrémentation) borne début représente l'indice de départ borne fin représente l'indice de fin
1.2.15 - NULL
Cette instruction n'exécute rien et n'a aucun effet
1.2.16 - RAISE
Cette instruction permet de générer une exception
nom exception représente soit le nom d'une exception prédéfinie, soit une exception utilisateur définie dans la section déclarative
Si la variable LN$I est > 2, alors on provoque le saut dans la section EXCEPTION avec l'erreur utilisateur LE$Fin
1.2.17 - RETURN
Cette instruction permet de sortir d'une procédure ou d'une fonction
expression représente la valeur de retour d'une fonction. Cette valeur doit être compatible avec le type défini dans la clause RETURN de la déclaration de fonction
1.2.18 - SAVEPOINT
Cette instruction permet de placer une étiquette savepoint dans le corps du code.
Elle permet au traitement d'annuler, avec l'instruction ROLLBACK, les modifications effectuées à partir de cette étiquette
1.2.19 - ROLLBACK
Cette instruction permet d'annuler en base toutes les modifications effectuées au cours de la transaction
nom savepoint représente le nom d'une étiquette savepoint préalablement définie dans le corps du code avec l'instruction SAVEPOINT
Avec TO SAVEPOINT nom savepoint, l'annulation porte sur toutes les modifications effectuées à partir de l'étiquette nom savepoint
Dans cet exemple, une étiquette SAVEPOINT est placée après les instructions d'insertion
Un ROLLBACK TO SAVEPOINT est ajouté après l'instruction de mise à jour
puis un COMMIT est effectué
Les insertions sont bien enregistrées en base mais pas la mise à jour
1.2.20 - SELECT INTO
Séléction d'une ou de plusieurs lignes
Cette instruction permet d'exécuter un ordre Select implicite.
Cet ordre ne doit ramener qu'une ligne sous peine de générer l'exception NO_DATA_FOUND si aucune ligne n'est ramenée ou TOO_MANY_ROWS si plus d'une ligne sont ramenées
Utilisée avec la clause BULK COLLECT, elle permet de charger une collection avec les lignes ramenées
item représente un littérale ou un nom de colonne nom variable représente le nom d'une variable d'accueil. Son type doit être identique à celui de item nom record représente le nom d'un enregistrement composé de champs de même type que les items ramenés nom collection représente le nom d'une collection d'accueil nom tableau hôte représente le nom de la variable tableau passée par un programme tiers référence table représente la liste des tables et/ou vues de l'ordre SQL sous-requête représente le texte d'une sous-requête SQL conforme suite instruction représente la suite de l'ordre Select (clauses Where, Group by, Order by, etc.)
Dans l'exemple suivant, aucun employé ne porte le numéro 1 la requête ne ramène donc aucune ligne et génère l'exception NO_DATA_FOUND
Dans l'exemple suivant, la clause WHERE a été retirée la requête ramène donc plusieurs lignes et génère l'exception TOO_MANY_ROWS
Dans l'exemple suivant toute une ligne de la table EMP est chargée dans un enregistrement
Dans l'exemple suivant toutes les lignes de la table EMP sont chargées dans une collection
1.2.21 - Instruction SQL
Représente toute instruction SQL valide
• INSERT
• UPDATE
• DELETE
1.2.22 - Les curseurs explicites
Un curseur est une zone mémoire de taille fixe, utilisée par le moteur SQL pour analyser et interpréter un ordre SQL
Un curseur explicite, contrairement au curseur implicite (SELECT INTO) est géré par l'utilisateur pour traiter un ordre Select qui ramène plusieurs lignes
Tout curseur explicite géré dans la section exécution doit avoir été déclaré dans la section déclarative
• Déclaration
nom curseur représente le nom du curseur que l'on déclare déclaration des paramètres(facultatif) représente la liste des paramètres transmis au curseur instruction select représente l'ordre SQL Select d'alimentation du curseur
Un curseur nommé C_EMP est déclaré avec l'ordre Select correspondant (CURSOR C_EMP IS ) Il est ouvert avec l'instruction OPEN lu avec l'instruction FETCH et fermé avec l'instruction CLOSE
• Paramètres du curseur
Un curseur est paramétrable. On peut donc utiliser le même curseur pour obtenir différents résultats
nom paramètre représente le nom de la variable paramètre datatype représente le type SQL de la variable paramètre (doit correspondre en type avec la colonne visée) expression représente la valeur par défaut du paramètre (doit correspondre en type avec celui du paramètre)
• Déclaration d'une variable curseur
nom variable curseur représente le nom de la variable curseur déclarée nom type représente le nom d'un type curseur
• Spécification d'un curseur
Les attributs de curseur
Chaque curseur dispose de 4 attributs
• %FOUND
Cet attribut prend la valeur TRUE lorsque une ligne est ramenée, sinon il prend la valeur FALSE
• %NOTFOUND
Cet attribut prend la valeur FALSE lorsque une ligne est ramenée, sinon il prend la valeur TRUE
• %ISOPEN
Cet attribut prend la valeur TRUE lorsque le curseur indiqué est ouvert, sinon il prend la valeur FALSE
• %ROWCOUNT
Cet attribut retourne le nombre de lignes impactées par la dernière instruction SQL
1.2.23 - Portée des variables
La portée ou visibilité d'une variable est limitée au bloc PL/SQL dans laquelle elle est déclarée. Elle est donc locale au bloc PL/SQL
SQL> | Begin |
2 3 | Declare |
4 | LC$Ch1 varchar2(10) := 'Phrase 2'; |
5 | Begin |
6 | dbms_output.put_line( 'LC$Ch1 = ' || LC$Ch1 ) ; |
7 | End ; |
8 9 | dbms_output.put_line( 'LC$Ch1 = ' || LC$Ch1 ) ; |
Dans cet exemple, la variable LC$Ch1 déclarée dans le sous-bloc, n'existe plus dans le bloc principal
Dans le cas de blocs imbriqués ou une même variable est déclarée dans chaque bloc, la visibilité d'une variable se rapporte toujours à la plus proche déclaration
1.3 - La section de gestion des erreurs
Débutée par le mot clé EXCEPTION, elle contient le code mis en oeuvre pour la gestion des erreurs générées par la section d'exécution
Une erreur survenue lors de l'exécution du code déclenche ce que l'on nomme une exception. Le code erreur associé est transmis à la section EXCEPTION, pour vous laisser la possibilité de la gérer et donc de ne pas mettre fin prématurément à l'application.
Prenons l'exemple suivant :
Nous souhaitons retrouver la liste des employés dont la date d'entrée est inférieure au premier janvier 1970
Comme la requête ne ramène aucune ligne, l'exception prédéfinie NO_DATA_FOUND est générée et transmise à la section EXCEPTION qui peut traiter le cas et poursuivre l'exécution de l'application.
L'exception NO_DATA_FOUND (ORA_01403) correspond au code erreur numérique +100.
Il existe des milliers de code erreur Oracle et il serait vain de tous leur donner un libellé.
Voici la liste des exceptions prédéfinies qui bénéficient de ce traitement de faveur :
Exception prédéfinie | Erreur Oracle | Valeur de SQLCODE |
ACCESS_INTO_NULL | ORA-06530 | -6530 |
CASE_NOT_FOUND | ORA-06592 | -6592 |
COLLECTION_IS_NULL | ORA-06531 | -6531 |
CURSOR_ALREADY_OPEN | ORA-06511 | -6511 |
DUP_VAL_ON_INDEX | ORA-00001 | -1 |
INVALID_CURSOR | ORA-01001 | -1001 |
INVALID_NUMBER | ORA-01722 | -1722 |
LOGIN_DENIED | ORA-01017 | -1017 |
NO_DATA_FOUND | ORA-01403 | +100 |
NOT_LOGGED_ON | ORA-01012 | -1012 |
PROGRAM_ERROR | ORA-06501 | -6501 |
ROWTYPE_MISMATCH | ORA-06504 | -6504 |
SELF_IS_NULL | ORA-30625 | -30625 |
STORAGE_ERROR | ORA-06500 | -6500 |
SUBSCRIPT_BEYOND_COUNT | ORA-06533 | -6533 |
SUBSCRIPT_OUTSIDE_LIMIT | ORA-06532 | -6532 |
SYS_INVALID_ROWID | ORA-01410 | -1410 |
TIMEOUT_ON_RESOURCE | ORA-00051 | -51 |
TOO_MANY_ROWS | ORA-01422 | -1422 |
VALUE_ERROR | ORA-06502 | -6502 |
ZERO_DIVIDE | ORA-01476 | -1476 |
Toutes les autres exceptions doivent être interceptées via leur code erreur numérique.
En plus des erreurs Oracle, vous pouvez intercepter vos propres erreurs en déclarant des variables dont le type est exception et en provoquant vous-même le saut dans la section de gestion des erreurs à l'aide de l'instruction RAISE
Il n'est pas possible de déclarer la même exception deux fois dans le même bloc. Toutefois, dans le cas de blocs imbriqués, vous pouvez déclarer la même exception dans la section EXCEPTION de chaque bloc
Le peu d'exceptions prédéfinies vous oblige à traiter tous les autres cas dans la clause WHEN OTHERS en testant le code erreur SQL
Vous pouvez associer un code erreur Oracle à vos propres variables exception à l'aide du mot clé PRAGMA EXCEPTION_INIT, dans le cadre de la section déclarative de la façon suivante :
Nom_exception EXCEPTION ;
PRAGMA EXCEPTION_INIT(nom_exception, -code_error_oracle);
Exemple :
Lorsque l'on tente d'insérer plus de caractères dans une variable que sa déclaration ne le permet, Oracle déclenche une erreur -6502. Nous allons "nommer" cette erreur en LE$trop_long et l'intercepter dans la section exception
Le code erreur numérique Oracle ayant généré la plus récente erreur est récupérable en interrogeant la fonction SQLCODE.
Le libellé erreur associé est récupérable en interrogeant la fonction SQLERRM
Poursuite de l'exécution après l'interception d'une exception
Une fois dans la section EXCEPTION, il n'est pas possible de retourner dans la section exécution juste après l'instruction qui a généré l'erreur.
Par contre il est tout à fait possible d'encadrer chaque groupe d'instructions voire même chaque instruction avec les mots clé
BEGIN # EXCEPTION # END;
Cela permet de traiter l'erreur et de continuer l'exécution
Vous pouvez également définir vos propres messages d'erreur avec la procédure RAISE_APPLICATION_ERROR
DBMS_STANDARD.raise_application_error(numero_erreur, message[, {TRUE | FALSE}])
numero_erreur représente un entier négatif compris entre -20000 et -20999 message représente le texte du message d'une longueur maximum de 2048 octets
TRUE indique que l'erreur est ajoutée à la pile des erreurs précedentes
FALSE indique que l'erreur remplace toutes les erreurs précédentes
Du fait que cette procédure appartienne a un paquetage standard, il n'est pas nécessaire de préfixer cette procédure
L'appel de la procédure raise_application_error ne peut être exécuté que depuis une procédure stockée, et déclenche un retour immédiat au programme appelant en lui transmettant le code et le libellé de l'erreur
Propagation des exceptions
Si une exception n'est pas traitée au sein du bloc BEGIN # END; dans lequel elle est générée, elle remonte de bloc en bloc jusqu'à ce qu'elle soit traitée ou rende la main au programme appelant.
Dans cet exemple, l'exception A est traitée dans le bloc local.
Le traitement se poursuit dans le bloc parent
Dans cet exemple, l'exception B n'est pas traitée dans le bloc local.
Elle se propage dans le bloc parent dans lequel elle est traitée
Puis la main est rendue au programme appelant
Dans cet exemple, l'exception C n'est traitée ni dans le bloc local ni dans les blocs parents la main est rendue au programme appelant avec le code erreur
Commentaires dans les blocs PL/SQL
Pour mettre une ligne unique en commentaire, il faut la faire précéder d'un double tiret --
-- cette ligne seule est un commentaire
Pour mettre plusieurs lignes en commentaire, il faut les encadrer avec les symboles /* et */
/* toutes les lignes suivantes sont en commentaire
elles ne seront ni compilées ni exécutées
*/
2 - Les variables, types et littéraux
2.1 - Les variables
nom variable [CONSTANT] type [ [NOT NULL] := expression ] ;
nom variable représente le nom de la variable composé de lettres, chiffres, $, _ ou #
Le nom de la variable ne peut pas excéder 30 caractères
CONSTANT indique que la valeur ne pourra pas être modifiée dans le code du bloc PL/SQL NOT NULL indique que la variable ne peut pas être NULL, et dans ce cas expression doit être indiqué. type représente de type de la variable correspondant à l'un des types suivants :
(dans le premier tableau, les types Oracle sont en gras, les sous-types compatible ANSI/ISO en normal)
Types scalaires | |||||||||
BINARY_INTEGER | DEC | DECIMAL | DOUBLE PRECISION | FLOAT | |||||
INT | INTEGER | NATURAL | NATURALN | NUMBER | |||||
NUMERIC | PLS_INTEGER | POSITIVE | POSITIVEN | REAL | |||||
SIGNTYPE | SMALLINT | CHAR | CHARACTER | LONG | |||||
LONG RAW | NCHAR | NVARCHAR2 | RAW | ROWID | |||||
STRING | UROWID | VARCHAR | VARCHAR2 | ||||||
BOOLEAN | DATE | ||||||||
INTERVAL DAY TO SECOND(9i) | INTERVAL YEAR TO MONTH(9i) | TIMESTAMP(9i) | TIMESTAMP WITH LOCAL TIME ZONE(9i) | TIMESTAMP WITH TIME ZONE(9i) | |||||
Types composés | |||||||||
RECORD | TABLE | VARRAY | |||||||
Types références | |||||||||
REF CURSOR | REF type_objet | ||||||||
Types grands objets | |||||||||
BFILE | BLOB | CLOB | NCLOB | ||||||
Types suplémentaires | ||||
SYS.ANYDATA | SYS.ANYTYPE | SYS.ANYDATASET | ||
XMLTYPE | URITYPE | |||
MDSYS.SDO_GEOM | ETRY | |||
ORDSYS.ORDAUDIO | ORDSYS.ORDIMAGE | ORDSYS.ORDVIDEO | ORDSYS.ORDDOC |
ORDSYS.ORDIMAGESIGNATU
Vous pouvez également créer des sous-types :
SUBTYPE nom_sous-type IS type ;
SUBTYPE entier_court IS SMALLINT ;
i entier_court ;
Et utiliser les types dérivés
%TYPE
référence à un type existant qui est soit une colonne d'une table soit un type défini précédemment
nom_variable nom_table.nom_colonne%TYPE ; nom_variable nom_variable_ref%TYPE ;
%ROWTYPE
référence à une ligne d'une table ou d'un curseur
nom_variable nom_table%ROWTYPE ; nom_variable nom_curseur%ROWTYPE ;
2.2 - Types prédéfinis
2.2.1 - Types caractères
CHAR[(n)]
Chaîne de caractères de longueur fixe avec n compris entre 1 et 32767 (par défaut 1)
VARCHAR2(n)
Chaîne de caractères de longueur variable avec n compris entre 1 et 32767
Ces types PL/SQL ont une capacité supérieure à celle des colonnes de tables de même type.
(une colonne CHAR ne peut excéder 2000 caractères et une colonne de type VARCHAR2 4000 caractères)
LONG
Chaîne de caractères de longueur variable avec au maximum 32760 octets
RAW[(n)]
Chaîne de caractères ou données binaires de longueur variable avec n compris entre 1 et 32767. Le contenu d'une variable de ce type n'est pas interprété par PL/SQL (pas de gestion des caractères nationaux)
LONG RAW
Identique au type LONG qui peut contenir des données binaires
Jeux de caractères multi-octets
NCHAR[(n)]
Chaîne de caractères de longueur fixe avec n compris entre 1 et 32767 (par défaut 1)
NVARCHAR2[(n)]
Chaîne de caractères de longueur variable avec n compris entre 1 et 32767
Le nombre de caractères réellement stockés dépend du nombre d'octets utilisés pour coder chaque caractère
UROWID, ROWID
Permet de stocker l'adresse absolue d'une ligne dans une table sous la forme d'une chaîne de caractères Le format d'une telle variable est le suivant :
000000FFFBBBBBBRRR
000000 représente le numéro de l'objet qui possède cette ligne (dans le cas de cluster, plusieurs objets peuvent partager le même segment)
FFF représente le numéro du fichier qui contient la ligne
BBBBBB représente le numéro du bloc dans le fichier
RRR représente le numéro de ligne dans le bloc
2.2.2 - Types numériques
NUMBER[(e,d)]
Nombre réel avec e chiffres significatifs stockés et d décimales
BINARY_INTEGER
Nombre entier compris entre -2 147 483 647 et +2 147 483 647
(Utilise les fonctions de la librairie arithmétique)
(10g)BINARY_FLOAT
Nombre à virgule flottante simple précision au format IEEE 754 un littéral de ce type est écrit avec un f terminateur (ex. 3.125f)
(10g)BINARY_DOUBLE
Nombre à virgule flottante double précision au format IEEE 754 un littéral de ce type est écrit avec un d terminateur (ex. 3.12548d)
PLS_INTEGER
Nombre entier compris entre -2 147 483 647 et +2 147 483 647
(Plus rapide que BINARY_INTEGER car il utilise les registres du processeur)
2.2.3 - Types pour les grands objets
BFILE
Stocke la référence vers un fichier du système d'exploitation
BLOB
Permet de stocker un objet binaire jusqu'à 4 Go
CLOB
Permet de stocker un ensemble de caractères, jusqu'à 4 Go
NCLOB
Permet de stocker un ensemble de caractères, codés sur un ou plusieurs octets, jusqu'à 4 Go
2.2.4 - Types supplémentaires
SYS.ANYTYPE, SYS.ANYDATA
Une variable de ce type peut contenir un objet de n'importe quel type scalaire ou objet
Définie comme colonne d'une table, elle pourrait contenir une variable de type NUMBER dans une ligne, une variable de type VARCHAR2 dans une autre, une variable de type objet dans une troisième, etc.
Il faut utiliser les méthodes associées pour insérer la valeur correspondant au type désiré sur chaque ligne SYS.ANYDATA.CONVERT
SYS.ANYDATA.ConvertNumber(1500) pour insérer une variable numérique
SYS.ANYDATA.ConvertVarchar2('Hello') pour insérer une variable caractère
Liste des fonctions de conversion
• ConvertNumber(num IN NUMBER) RETURN AnyData
• ConvertDate(dat IN DATE) RETURN AnyData
• ConvertChar(c IN CHAR) RETURN AnyData
• ConvertVarchar(c IN VARCHAR) RETURN AnyData
• ConvertVarchar2(c IN VARCHAR2) RETURN AnyData
• ConvertRaw(r IN RAW) RETURN AnyData
• ConvertBlob(b IN BLOB) RETURN AnyData
• ConvertClob(c IN CLOB) RETURN AnyData
• ConvertBfile(b IN BFILE) RETURN AnyData
• ConvertObject(obj IN "(object_type)") RETURN AnyData
• ConvertRef(rf IN REF "(object_type)") RETURN AnyData
• ConvertCollection(col IN "(COLLECTION_1)") RETURN AnyData
Et les méthodes suivantes pour retrouver les valeurs insérées
• GetNumber(self IN AnyData, num OUT NOCOPY NUMBER) RETURN PLS_INTEGER
• GetDate(self IN AnyData, dat OUT NOCOPY DATE) RETURN PLS_INTEGER
• GetChar(self IN AnyData, c OUT NOCOPY CHAR) RETURN PLS_INTEGER
• GetVarchar(self IN AnyData, c OUT NOCOPY VARCHAR) RETURN PLS_INTEGER
• GetVarchar2(self IN AnyData, c OUT NOCOPY VARCHAR2) RETURN PLS_INTEGER
• GetRaw(self IN AnyData, r OUT NOCOPY RAW) RETURN PLS_INTEGER
• GetBlob(self IN AnyData, b OUT NOCOPY BLOB) RETURN PLS_INTEGER
• GetClob(self IN AnyData, c OUT NOCOPY CLOB) RETURN PLS_INTEGER
• GetBfile(self IN AnyData, b OUT NOCOPY BFILE) RETURN PLS_INTEGER
• GetObject(self IN AnyData, obj OUT NOCOPY "(object_type)") RETURN PLS_INTEGER
• GetRef(self IN AnyData, rf OUT NOCOPY REF "(object_type)") RETURN PLS_INTEGER • GetCollection(self IN AnyData, col OUT NOCOPY "(collection_type)") RETURN PLS_INTEGER Le type ANYDATA supporte également les méthodes suivantes:
• Procédure BEGINCREATE pour la création d'un nouveau type
• Procédure membre PIECEWISE pour définir le mode d'accès à la valeur courante
• Procédure membre SET Pour positionner les valeurs
• Procédure membre ENDCREATE Pour terminer la création d'un nouveau type
• Fonction membre GETTYPENAME Pour retrouver la définition complète du type
• Fonction membre GETTYPE Pour retrouver le type de l'objet
SYS.ANYDATASET
Ce type contient à la fois la description et un ensemble de données de même type.
Liste des fonctions attachées à ce type
• Procédure membre ADDINSTANCE Pour l'ajout d'une nouvelle instance de données
• Procédure BEGINCREATE pour la création d'un nouveau type
• Procédure membre PIECEWISE pour définir le mode d'accès à la valeur courante
• Procédure membre SET Pour positionner les valeurs
• Procédure membre ENDCREATE Pour terminer la création d'un nouveau type
• Fonction membre GETTYPENAME Pour retrouver la définition complète du type
• Fonction membre GETTYPE Pour retrouver le type de l'objet
• Fonction membre GETINSTANCE Pour retrouver l'instance suivante
• Fonctions membre GET Pour retrouver les valeurs
• Fonction membre GETCOUNT Pour retrouver le nombre d'instances du type
Types XML
Ces types sont utilisés pour stocker des objets XML
Le type XMLTYPE posséde des fonctions membres pour insérer, extraire et interroger les données XML via les expressions de type XPATH
Pour manipuler les données XML, Oracle met à disposition les fonctions
• XMLAGG
• XMLCOLATTVAL
• XMLCONCAT
• XMLDATA
• XMLELEMENT
• XMLFOREST
• XMLSEQUENCE
• XMLTRANSFORM
Ainsi que les paquetages
• DBMS_XMLDOM
• DBMS_XMLGEN
• DBMS_XMLPARSER
• DBMS_XMLQUERY
• DBMS_XMLSAVE
• DBMS_XMLSCHEMA
Les types URI (URITYPE, DBURITYPE, XDBURITYPE et HTTPURITYPE) permettent de gérer les données sous forme d'URL.
Pour manipuler les données XML, Oracle met à disposition le paquetage URIFACTORY
Type Spatial
MDSYS.SDO_GEOMETRY
Pour la manipulation d'objets Oracle Spatial
Types MEDIA
Ces types sont utilisés pour stocker des objets multi-média avec Oracle interMedia
ORDSYS.ORDAUDIO
Pour le stockage de données audio
ORDSYS.ORDIMAGE
Pour le stockage des images
ORDSYS.ORDIMAGESIGNATURE
Pour le stockage des propriétés des images
ORDSYS.ORDVIDEO
Pour le stockage des données vidéo
ORDSYS.ORDDOC
Pour le stockage de tout type de données multi-média
2.3 - Les Types et Sous-types définis par l'utilisateur
En plus des types prédéfinis, l'utilisateur peut définir ses propres types avec le mot clé TYPE ou SUBTYPE
• SUBTYPE nom_sous-type IS type_base[(précision)] [NOT NULL] nom_sous-type représente le nom du sous-type déclaré type_base représente le nom du type prédéfini précision représente une longueur pour les caractères et longueur + décimales pour les numériques
SUBTYPE chaine_courte IS VARCHAR2(10); le sous-type utilisateur chaine_courte définit un VARCHAR2(10) à la suite de cette définition, toute déclaration de variable de type chaine_courte sera égale à VARCHAR2(10) SUBTYPE chaine IS VARCHAR2(100); le sous-type utilisateur chaine définit un VARCHAR2(100)
SUBTYPE chaine_longue IS VARCHAR2(1000); le sous-type utilisateur chaine_longue définit un VARCHAR2(1000)
SUBTYPE NOM_EMP IS EMP.ename%Type; le sous-type NOM_EMP définit un type identique à la colonne ename de la table EMP
SUBTYPE REC_EMP IS EMP%ROWTYPE;
le sous-type REC_EMP définit un type identique à une ligne de la table EMP
TYPE tableau_numerique IS TABLE OF NUMBER; le type tableau_numerique définit un tableau de NUMBER
TYPE TAB_REC_EMP IS TABLE OF REC_EMP;
le type TAB_REC_EMP définit un tableau d'éléments de type REC_EMP
Lorsque vos nouveaux types et sous-types sont déclarés, vous pouvez les utiliser pour typer de nouvelles variables
2.4 - Les littéraux
Un littéral ou valeur constante désigne une valeur fixe.
Par exemple 'LUNDI', 'Montpellier', '2012' représentent des valeurs littérales de type caractère.
12.3, 25 représentent des valeurs littérales de type numérique
Ces valeurs peuvent apparaître dans des initialisations de variables, des calculs ou transmises à des procédures ou fonctions.
2.4.1 - Littéral de type caractère
Désigne une valeur fixe comme étant de type caractère
La valeur peut contenir n'importe quel caractère à l'exception d'une simple apostrophe
(pour saisir une apostrophe dans un littéral, il faut la doubler (''))
Il doit être encadré d'une paire d'apostrophes
Il peut être précédé du caractère N pour indiquer qu'il doit être transformé dans le jeu de caractères national
Il a les mêmes propriétés que les types CHAR et VARCHAR2
Sa longueur ne peut pas dépasser 4000 octets
'J''aime le PL/SQL'
'Cordialement'
'Select * From EMP'
2.4.2 - Littéral de type entier
Désigne une valeur fixe comme étant de type entier
Ne peut contenir que les chiffres de 0 à 9
Il peut être précédé des signes + ou -
Il peut contenir jusqu'à 38 chiffres de précision
-12
267589
+3
2.4.3 - Littéral de type décimal
Désigne une valeur fixe comme étant de type numérique
Ne peut contenir que les chiffres de 0 à 9
Il peut être précédé des signes + ou -
Il peut contenir jusqu'à 38 chiffres de précision
Il peut contenir le caractère e ou E qui indique que la valeur est spécifiée en notation scientifique. Les chiffres après le E indiquent l'exposant. Ce dernier est valide dans un intervalle de -130 à 125
-54
+3.1415
0.006
75E-12
2.4.4 - Littéral de type intervalle (9i)
Nouveauté 9i Spécifie une période de temps, déclinée en années et mois ou en jours, heures, minutes et secondes.
Les deux types de littéraux de type intervalle sont YEAR TO MONTH et DAY TO SECOND
Chaque type contient un préfixe et peut contenir un suffixe. Le préfixe désigne l'unité de base de date ou d'heure. Le suffixe définit les parties d'incrément associées à l'unité de base.
Si vos données sont sous forme numérique, vous pouvez utiliser les fonctions de conversion NUMTOYMINTERVAL ou NUMTODSINTERVAL pour les convertir en littéraux de type intervalle.
INTERVAL 'nombre_entier [-nombre_entier]' YEAR ou MONTH (précision) TO YEAR ou MONTH
Nombre_entier [-nombre_entier] spécifie une valeur entière pour le préfixe et éventuellement le suffixe du littéral. Si le préfixe est YEAR et le suffixe est MONTH, nombre_entier pour le mois doit être entre 0 et 11
Précision représente le nombre maximum de chiffres pour le préfixe compris entre 0 et 9. Par défaut sa valeur est 2
INTERVAL '12-3' YEAR TO MONTH : intervalle de 12 ans et 3 mois
INTERVAL '115' YEAR(3) : intervalle de 115 ans (la précision du suffixe doit être spécifiée YEAR(3) si elle est supérieure à la valeur par défaut)
INTERVAL '24' MONTH : intervalle de 24 mois
Il est possible d'additionner ou soustraire un littéral de type intervalle à un autre
INTERVAL '6-4' YEAR TO MONTH - INTERVAL '6' MONTH
• Intervalle de type DAY TO SECOND
INTERVAL 'nombre_entier' DAY ou HOUR ou MINUTE ou SECOND (précision) TO DAY ou HOUR ou MINUTE ou SECOND (fractions de secondes)
Nombre_entier peut représenter soit :
Un nombre de jours
Une heure au format HH[ :MI[ :SS[.fractions_de_secondes]]]
Précision représente le nombre de chiffres du préfixe, compris entre 0 et 9. Par défaut sa valeur est 2
Fractions_de_secondes représente le nombre de chiffres des fractions de secondes, compris entre 1 et 9. Par défaut sa valeur est 6
Les valeurs correctes pour les champs sont :
HOUR 0 à 23
MINUTE 0 à 59
SECOND 0 à 59.999999999
INTERVAL '6 4 :10 :22.356' DAY TO SECOND(3) : intervalle de 6 jours, 4 heures, 10 minutes, 22 secondes et 356 millièmes de secondes
INTERVAL '6 4 :10' DAY TO MINUTE : intervalle de 6 jours, 4 heures et 10 minutes
INTERVAL '365 12' DAY(3) TO HOUR : intervalle de 365 jours et 12 heures
INTERVAL '8 :10 :20.3333333' HOUR TO SECOND(7) : Intervalle de 8 heures, 10 minutes, 20.3333333 secondes
INTERVAL '18 :30' HOUR TO MINUTE : intervalle de 18 heures et 30 minutes
INTERVAL '20' MINUTE : intervalle de 20 minutes
INTERVAL '4.12345' SECOND(2,4) : intervalle arrondi à 4.1235 secondes car la précision demandée sur les fractions de secondes est de 4 chiffres
Il est possible d'additionner ou soustraire un littéral de type intervalle à un autre
INTERVAL '30' DAY - INTERVAL '18' HOUR
3 - Les fonctions natives
Ces fonctions SQL ne sont pas propres au PL/SQL et ne sont donc pas développées outre mesure dans ce
chapitre, notamment au niveau des formats et littéraux utilisables.
Reportez-vous à la documentation SQL pour davantage de précisions
3.1 - Les fonctions chaînes de caractères
2 syntaxes :
chaîne || chaîne
CONCAT( chaîne, chaîne )
Ces fonctions formatent une chaîne sur une longueur donnée par ajout de caractères avant (LPAD) ou après (RPAD) la chaîne passée en argument
LPAD( chaîne, longueur [, 'caractères'] ) RPAD( chaîne, longueur [, 'caractères'] )
chaîne représente le nom d'une colonne, d'une variable ou un littéral longueur représente le nombre total de caractères du résultat caractères représente le ou les caractères de remplissage
Si caractères n'est pas spécifié, le caractère par défaut est l'espace (CHR(32))
LTRIM( chaîne [, 'caractères'] ) RTRIM( chaîne [, 'caractères'] )
si caractères n'est pas spécifié, le caractère par défaut est l'espace (CHR(32))
TRIM
Cette fonction permet de cumuler les possibilités de LTRIM et RTRIM
chaîne représente la chaîne de caractères en entrée de la fonction si LEADING est spécifié, tous les premiers caractères identiques à caractère sont supprimés si TRAILING est spécifié, tous les derniers caractères identiques à caractère sont supprimés si BOTH ou rien est spécifié, tous les premiers et derniers caractères identiques à caractère sont supprimés si caractère n'est pas spécifié la valeur par défaut est l'espace
si seule chaîne est spécifiée tous les espaces en début et fin de chaîne sont supprimés si caractère ou chaîne est NULL, la fonction retourne NULL
LOWER( chaîne )
NLS_LOWER( chaîne [, nls_paramètre ] )
UPPER( chaîne )
NLS_UPPER( chaîne [, nls_paramètre ] )
INITCAP( chaîne )
NLS_INITCAP( chaîne [, nls_paramètre ] )
LENGTH( chaîne )
SUBSTR( chaîne, début [, 'nombre'] )
chaîne représente le nom d'une colonne, d'une variable ou un littéral début représente la position de départ de recherche dans la chaîne nombre représente le nombre de caractères à extraire
si nombre est omis, la fonction ramène tous les caractères à partir de la position début
si nombre est négatif l'extraction débute à partir de la fin de la chaîne
INSTR( chaîne, sous-chaîne [, début [,nombre occurrences] ] ) INSTRB( chaîne, sous-chaîne [, début [,nombre occurrences] ] )
chaîne représente le nom d'une colonne, d'une variable ou un littéral passé en argument sous-chaîne représente le nom d'une variable ou un littéral dont on cherche la position début (optionnel) représente la position de départ de la recherche dans chaîne nombre occurrences (si début renseigné) représente le nombre d'occurrences trouvées à ignorer
Lorsque sous-chaîne représente plusieurs caractères, la fonction retourne la position du premier caractère de la sous-chaîne
recherche de la première position de la sous-chaîne oracle
recherche de la deuxième position de la sous-chaîne oracle
si la sous-chaîne n'est pas trouvée, la fonction retourne 0
REPLACE( chaîne, chaîne source, chaîne cible )
chaîne représente le nom d'une colonne, d'une variable ou un littéral passé en argument chaîne source représente le nom d'une variable ou un littéral de recherche chaîne cible représente le nom d'une variable ou un littéral de remplacement
Elimination de caractères
TRANSLATE( chaîne, chaîne source, chaîne cible )
chaîne représente le nom d'une colonne, d'une variable ou un littéral passé en argument chaîne source représente le nom d'une variable ou un littéral de recherche chaîne cible représente le nom d'une variable ou un littéral de remplacement
Chaque caractère présent dans chaîne qui est également présent dans chaîne source est remplacé par le caractère qui occupe la même position dans chaîne cible
Dans l'exemple suivant, le caractère _ est remplacé par _ et tous les autres (interdit sous Unix) sont également remplacés par _
Elimination de caractères indésirables
Le premier caractère A de la chaîne source est un leurre qui indique à la fonction de remplacer toutes les occurrences de A par A et de remplacer les autres caractères (+|!) par rien.
3.2 - Les fonctions arithmétiques
ABS( valeur )
Valeur absolue d'un nombre
ABS( 200 ) = 200
ABS( -200 ) = 200
CEIL( valeur)
Entier supérieur ou égal à valeur
CEIL( 5 ) = 5
CEIL( 5.1 ) = 6
CEIL( -5 ) = -5
CEIL( -5.1 ) = -5
CEIL( -5.9 ) = -5
FLOOR( valeur )
Entier inférieur ou égal à valeur
FLOOR( 5 ) = 5
FLOOR( 5.1 ) = 5
FLOOR( -5 ) = -5
FLOOR( -5.1 ) = -6
FLOOR( -5.9 ) = -6
MOD( valeur, diviseur )
Reste d'une division
MOD( 10, 2 ) = 0
MOD( 10, 3 ) = 1
MOD( 10, .6 ) = 0.4
MOD( -10, 2 ) = 0
MOD( -10, .6 ) = -0.4
Lorsque diviseur est supérieur à valeur, la fonction retourne la valeur
MOD( 5, 12 ) = 5
Si valeur est un entier alors MOD( valeur, 1 ) = 0 (idéal pour tester que valeur est entier)
Si valeur est un entier pair alors MOD( valeur, 2 ) = 0
POWER( valeur, exposant )
Elévation d'un nombre à une puissance
POWER( 8, 2 ) = 64
POWER( 8, -2 ) = 0.015625
SQRT( valeur )
Racine carrée d'un nombre
SQRT( 64 ) = 8
EXP( valeur ) e (2,71828182845905) élevé à une puissance
EXP( 5 ) = 148.413159102577
LN( valeur )
Logarithme naturel, ou base e, d'une valeur
LN(148.413159102577 ) = 5
LOG( base, valeur )
Logarithme d'une valeur
LOG( 10, 2 ) = 0.301029995663981
LN( valeur ) est identique à LOG(2,71828182845905 (EXP( 1 ) ), valeur )
ROUND( valeur, précision )
Arrondi d'une valeur à un certain nombre de chiffres de précision
ROUND( 9.254, 1 )
9,3
ROUND( 9.259, 2 )
9,26
ROUND( 9.258, 0 )
9
ROUND( 9.9, 0 )
10
ROUND( 99.259, -1 )
100
TRUNC( valeur, précision )
Suppression d'une partie des chiffres de précision décimale
TRUNC( 9.259, 2 )
9,25
TRUNC( 9.9, 0 )
9
TRUNC( 99.259, -1 )
90
une précision négative est intéressante pour arrondir des nombres sur des tranches de milliers, millions, milliards, etc.
SIGN( valeur )
Signe d'une valeur
SIGN( 12 )
1
SIGN( -12 )
-1
SIN( valeur ), COS( valeur ), TAN( valeur )
Renvoie la valeur trigonométrique d'un angle exprimé en radians
SINH( valeur ), COSH( valeur ), TANH( valeur )
Renvoie la valeur trigonométrique hyperbolique d'un angle exprimée en radians
ASIN( valeur ), ACOS( valeur ), ATAN( valeur )
Renvoie respectivement l'arc sinus, cosinus et tangente en radians
Ces fonctions portent sur des groupes de lignes et sont utilisées dans les ordres select
(Bien sûr rien n'empêche de coder : AVG(40), mais cela n'a pas beaucoup de sens)
AVG( colonne )
Valeur moyenne des valeurs de colonne
(les valeurs NULL ne sont pas prises en compte)
select AVG( SAL ) from EMP
AVG(SAL)
----------
2073,21429
COUNT( colonne )
Nombre de valeurs de colonne (les valeurs NULL ne sont pas prises en compte)
select COUNT( ENAME ) from EMP;
COUNT(ENAME)
------------
14
MAX( colonne )
Valeur maximum des valeurs de colonne
select ENAME, SAL from emp where SAL = (select MAX( SAL) From EMP );
ENAME SAL
---------- ----------
KING 5000
MIN( colonne )
Valeur minimum des valeurs de colonne
Select MIN( SAL ) From EMP
SUM( colonne )
Somme des valeurs de colonne
Select SUM( SAL ) From EMP
Ces fonctions portent sur un ensemble de colonnes d'une seule ligne
Elles peuvent être utilisées avec de nombreuses valeurs qui peuvent apparaître sous forme de colonnes, de littéraux, de calculs ou de combinaison d'autres colonnes.
GREATEST( valeur1, valeur2, valeur3,# )
Valeur la plus grande de la liste
GREATEST( 1, 5, 15, 8 )
15
GREATEST( 'Elmer', 'Achille','Richard', 'Josianne' )
Richard
GREATEST( Length('Elmer'), Length('Achille'),Length('Richard'), Length('Josianne') ) 8
LEAST( valeur1, valeur2, valeur3,# )
Valeur la plus petite de la liste
LEAST( 1, 5, 15, 8 )
1
LEAST( 3, 5+5, 8, 12-6 )
3
3.3 - Les fonctions de conversion et de transformation
BIN_TO_NUM( bit [,bit[ ]] )
Conversion d'une suite de bits en nombre
BITAND( arg1, arg2 )
Applique un ET logique sur les deux arguments
CHARTOROWID( char )
Conversion d'une chaîne en ROWID
CONVERT( chaîne, jeu caract source, jeu caract cible ) Conversion d'une chaîne d'un jeu de caractères à un autre
DECODE( valeur, si1, alors1, si2, alors2,#.., sinon )
Substitution valeur par valeur
BIN_TO_NUM( bit [,bit[ ]] )
Conversion d'une suite de bits en nombre
DUMP( expr [,format_retour [,début [,longueur]]] )
Retourne le type interne, longueur en octets de l'expression passée en argument
format_retour peut prendre l'une des quatre valeurs suivantes :
• 8 octal
• 10 décimal
• 16 héxadécimal
• 17 caractères
On peut ajouter 1000 à l'argument format_retour pour forcer DUMP à afficher le jeu de caractères en cours
HEXTORAW( char )
Conversion d'un nombre hexadécimal en un nombre binaire
RAWTOHEX( raw )
Conversion d'un nombre binaire en nombre hexadécimal
ROWIDTOCHAR( rowid )
Conversion d'un ROWID en chaîne
TO_CHAR( date [, 'format' ] )
TO_CHAR( nombre [, 'format' ] )
Transformation d'un type DATE ou NUMBER en chaîne
TO_DATE( nombre [, 'format' ] )
TO_DATE( chaîne [, 'format' ] )
Transformation d'un type NUMBER ou CHAR ou VARCHAR2 en date
TO_DSINTERVAL( chaîne )(9i)
Transformation d'un type CHAR ou VARCHAR2 en INTERVAL DAY TO SECOND
TO_LOB( LONG )
TO_LOB( LONG RAW )
Conversion d'une valeur de type LONG ou LONG RAW en valeur de type LOB TO_CLOB( char )
TO_CLOB( colonne lob )
Conversion d'une valeur de type CHAR ou LOB en valeur de type CLOB
TO_MULTI_BYTE
Conversion d'une chaîne de caractères mono-octet en chaîne de caractères multi-octets
Cette fonction n'est nécessaire que si votre jeu de caractères contient à la fois des caractères mono-octets et des caractères multi-octets
TO_NUMBER( chaîne [, 'format' ] )
Transformation d'un type CHAR ou VARCHAR2 en nombre
TO_SINGLE_BYTE
Conversion d'une chaîne de caractères multi-octets en chaîne de caractères mono-octet
Cette fonction n'est nécessaire que si votre jeu de caractères contient à la fois des caractères mono-octets et des caractères multi-octets
TO_TIMESTAMP( chaîne )(9i)
Transformation d'un type CHAR ou VARCHAR2 en TIMESTAMP
select to_timestamp( '01/01/2004 01:00:00' ,'DD/MM/YYYY HH24:MI:SS') from dual ;
TO_TIMESTAMP('01/01/200401:00:00','DD/MM/YYYYHH24:MI:SS') ---------------------------------------------------------------------------
01/01/04 01:00:00,000000000
TO_TIMESTAMP_TZ( chaîne )(9i)
Transformation d'un type CHAR ou VARCHAR2 en TIMESTAMP + TIME ZONE
TO_YMINTERVAL( chaîne )(9i)
Transformation d'un type CHAR ou VARCHAR2 en INTERVAL YEAR TO MONTH
Chaîne représente un couple année-mois 'AA-MM'
VSIZE( argument )
Retourne le nombre d'octets nécessaires au stockage de l'argument
3.4 - Les fonctions sur les dates
ADD_MONTHS( date, nombre de mois )
Ajoute ou soustrait un nombre de mois à une date
EXTRACT (datetemps FROM valeur)(9i)
Extraction d'un segment d'une valeur de type date ou d'un littéral de type intervalle (Pour une raison inconnue, cette fonction ne permet pas d'extraire l'heure d'une date )
datetemps peut être l'un des arguments suivants valeur est l'un des arguments suivants
Extraction de la partie année d'une date :
Affichage des employés dont la date d'entée est supérieure à 1981
LAST_DAY( date )
Dernier jour du mois de la date passée en argument
MONTHS_BETWEEN( date2, date1 )
Nombre de mois qui séparent date2 de date1
NEXT_DAY( date, 'jour' )
Date du prochain jour après date ou jour est un jour de la semaine
NEW_TIME( date, fuseau1, fuseau2 )
Date et heure de date en time zone fuseau2 lorsque date est en time zone fuseau1
NUMTODSINTERVAL( nombre, 'type' )(9i)
Conversion d'un nombre en intervalle de type DAY TO SECOND
'type' peut prendre l'une des quatre valeurs suivantes :
• 'DAY' précise que nombre indique un nombre de jours
• 'HOUR' précise que nombre indique un nombre d'heures
• 'MINUTE' précise que nombre indique un nombre de minutes
• 'SECOND' précise que nombre indique un nombre de secondes
SQL> -- Ajout de 8 minutes à une date --
SQL> SELECT SYSDATE, SYSDATE + NUMTODSINTERVAL(8,'MINUTE') FROM DUAL ;
NUMTOYMINTERVAL( nombre, 'type' )(9i)
Conversion d'un nombre en intervalle de type YEAR TO MONTH
'type' peut prendre l'une des deux valeurs suivantes :
• 'YEAR' précise que nombre indique un nombre d'années
• 'MONTH' précise que nombre indique un nombre de mois
ROUND( date [, format] )
sans l'argument format, la date est arrondie au matin 00:00:00 si l'heure transmise dans date est située avant 12:00, sinon elle est arrondie au lendemain 00:00:00 TRUNC( date [, format] )
sans l'argument format, la date est arrondie au matin 00:00:00
SYS_EXTRACT_UTC( timestamp )(9i)
Conversion d'une date au fuseau Greenwich
4 - Procédures, Fonctions et paquetages
Une procédure est un ensemble de code PL/SQL nommé, défini par l'utilisateur et généralement stocké dans la BDD
Une fonction est identique à une procédure à la différence qu'elle retourne une valeur Un paquetage est le regroupement de plusieurs procédures et fonctions dans un objet distinct
Ces ensembles nommés sont stockés dans la base de données, offrant les avantages suivants :
• Le code relatif aux règles de gestion est centralisé. Cela permet de dissocier les fonctions au sein d'une équipe
La partie traitement des règles de gestion est confiée à une partie de l'équipe et la conception des interfaces
est confiée à l'autre partie
• Ces traitements stockés sont donc déportés des interfaces clientes, permettant le partage du code entre plusieurs applications
ainsi qu'une amélioration des performances, car le code stocké est pré-compilé
• Ces traitements sont accessibles par toute application tierce supportant l'appel des procédures stockées (Sql*Plus, Forms, Reports, Pro*C, Pro*Cobol, etc.)
• Cela permet également de tirer parti de la réutilisation des requêtes dans la base qui se trouvent dans le pool partagé de la zone SGA(System Global Area)
Pour créer un objet procédural, vous devez disposer du privilège système CREATE PROCEDURE pour votre schéma ou du privilège système CREATE ANY PROCEDURE pour la création dans un autre schéma
Pour autoriser un autre schéma à exécuter une procédure de votre schéma, vous devez lui octroyer le privilège EXECUTE
GRANT EXECUTE ON ma_procedure TO autre_schéma
4.1 - Les Procédures
Une procédure est un ensemble de code PL/SQL nommé, défini par l'utilisateur et généralement stocké dans la BDD
Une procédure est paramétrable afin d'en faciliter la réutilisation
CREATE indique que l'on veut créer une procédure stockée dans la base
La clause facultative OR REPLACE permet d'écraser une procédure existante portant le même nom nom procédure est le nom donné par l'utilisateur à la procédure AUTHID indique sur quel schéma la procédure s'applique :
• CURRENT_USER
Indique que la procédure utilise les objets du schéma de l'utilisateur qui appelle la procédure
• DEFINER(défaut)
Indique que la procédure utilise les objets du schéma de création de la procédure
nom paramètre est le nom donné par l'utilisateur au paramètre transmis
IN(valeur par défaut) indique que le paramètre transmis par le programme appelant n'est pas modifiable par la procédure
OUT indique que le paramètre est modifiable par la procédure
IN OUT indique que le paramètre est transmis par le programme appelant et renseigné par la procédure
NOCOPY indique que le paramètre est transmis par référence (pointeur) et non par copie de la valeur
Par défaut, les paramètres sont transmis par copie, c'est à dire qu'un espace mémoire est créé pour recevoir une copie de la valeur
avec la clause NOCOPY, aucun espace mémoire supplémentaire n'est créé, c'est donc l'adresse de l'espace mémoire initial qui est transmise, permettant d'une part de ne pas gaspiller la mémoire disponible (surtout lorsqu'il s'agit de grands objets (LOB) et également d'éviter le temps nécessaire à la gestion de ces nouveaux espace mémoire (empilement, dépilement, etc.) datatype représente le type SQL ou PL/SQL du paramètre
:= représente le symbole d'assignation d'une valeur par défaut DEFAULT identique à := expression représente la valeur par défaut du paramètre (doit être conforme au type du paramètre)
Créons une procédure permettant d'augmenter le salaire d'un employé
La procédure Augmentation reçoit deux paramètres
PN$Numemp en entrée (IN) de même type que la colonne empno de la table EMP qui reçoit le numéro d'employé
PN$Pourcent en entrée (IN) de type NUMBER qui reçoit le pourcentage d'augmentation
Faisons maintenant appel à cette procédure dans un bloc PL/SQL anonyme
Les paramètres sont passés lors de l'appel de la fonction
D'une façon générale, les procédures ne devraient pas exécuter d'instruction de fin de transaction (COMMIT, ROLLBACK, Ordre DDL)
La décision d'enregistrer ou annuler la transaction en cours relève du programme appelant
Si toutefois, le traitement impose un enregistrement en base, la procédure peut être déclarée Autonome, via la directive de compilation PRAGMA AUTONOMOUS_TRANSACTION
Imaginons que vous ayez besoin d'une procédure de trace qui utilise l'instruction INSERT pour enregistrer vos messages dans une table d'erreurs
Afin de dépister correctement la trace désirée, cette procédure doit enregistrer chaque insertion avec l'instruction
COMMIT
Cependant, nous voulons que cet enregistrement ne valide que les instructions de notre procédure de trace
Pour atteindre cet objectif, nous allons donc créer une procédure autonome
Nous avons besoin d'une table de trace
Cette table permettra de stocker l'utilisateur, la date et la ligne de trace
Nous allons créer maintenant notre procédure
Celle-ci pourra utiliser au choix la sortie du message sur écran avec la fonction DBMS_OUTPUT.PUT_LINE, ou bien l'insertion dans la table de trace
Au passage nous allons augmenter les possibilité natives
En effet la fonction DBMS_OUTPUT.PUT_LINE est limitée à 255 caractères, et une colonne VARCHAR2 à 4000
Qu'à cela ne tienne, nous allons contourner le problème en découpant le message en tranches, permettant d'afficher quelque soit la méthode jusqu'à 32767 caractères
Cette procédure accepte en premier paramètre la chaîne de caractères de trace (max 32767 caractères)
et en deuxième paramètre (facultatif) le type de sortie désiré E pour écran (défaut), différent de E pour table
La directive de compilation PRAGMA AUTONOMOUS_TRANSACTION en entête de la section déclarative indique que cette procédure s'exécute dans sa propre transaction.
Utilisons maintenant cette procédure pour notre système de trace sur écran
SQL> set linesize 100
SQL> Declare
2 LC$Ch Varchar2(32767) ;
3 Begin
4 LC$Ch := Rpad( '1', 300, '1' ) || Rpad( '2', 300, '2' ) ; -- trace de 600 caractères 5 Debug( LC$Ch ) ;
6 End ;
7 /
1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111
1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111
1111111111111111111111111111111111111111111111111111111
1111111111111111111111111111111111111111111112222222222222222222222222222222222222222222222222222222
2222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222
2222222222222222222222222222222222222222222222222222222
222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222 Procédure PL/SQL terminée avec succès. Puis sur table
Lorsqu'un paramètre est passé en mode OUT, la procédure peut le modifier.
Le programme appelant doit avoir défini une variable correspondante dans sa section déclarative
4.2 - Les Fonctions
Une fonction est identique à une procédure à la différence qu'elle retourne obligatoirement une valeur d'où le mot clé obligatoire RETURN
CREATE indique que l'on veut créer une fonction stockée dans la base
La clause facultative OR REPLACE permet d'écraser une fonction existante portant le même nom nom fonction est le nom donné par l'utilisateur à la fonction AUTHID indique sur quel schéma la fonction s'applique :
• CURRENT_USER
Indique que la fonction utilise les objets du schéma de l'utilisateur qui appelle la fonction
• DEFINER(défaut)
Indique que la fonction utilise les objets du schéma de création de la fonction
nom paramètre est le nom donné par l'utilisateur au paramètre transmis
IN(valeur par défaut) indique que le paramètre transmis par le programme appelant n'est pas modifiable par la fonction
OUT indique que le paramètre est modifiable par la procédure
IN OUT indique que le paramètre est transmis par le programme appelant et renseigné par la fonction NOCOPY indique que le paramètre est transmis par référence (pointeur) et non par copie de la valeur datatype représente le type SQL ou PL/SQL du paramètre
:= représente le symbole d'assignation d'une valeur par défaut DEFAULT identique à := expression représente la valeur par défaut du paramètre (doit être conforme au type du paramètre) PRAGMA AUTONOMOUS_TRANSACTION indique que la fonction sera exécutée dans une transaction autonome
Au chapitre sur les procédures, nous avons vu la procédure permettant de simuler une augmentation en retournant le nouveau salaire théorique dans une variable IN OUT
Transformons cette procédure en fonction
La valeur de retour de la fonction est directement utilisable, même sans déclaration d'une variable d'accueil
4.3 - Les Paquetages
Un paquetage est un ensemble de procédures et fonctions regroupées dans un objet nommé
Par exemple le paquetage Oracle DBMS_LOB regroupe toutes les fonctions et procédures manipulant les grands objets (LOBs)
Le paquetage UTL_FILE regroupe les procédures et fonctions permettant de lire et écrire des fichiers du système
d'exploitation
Un paquetage est organisé en deux parties distinctes
La déclaration de la partie spécification d'un paquetage s'effectue avec l'instruction CREATE [OR REPLACE] PACKAGE
Celle de la partie corps avec l'instruction CREATE [OR REPLACE] PACKAGE BODY
La spécification du paquetage est créée avec une variable globale et publique : GN$Salaire une procédure publique : PROCEDURE Test_Augmentation une fonction publique : FUNCTION F_Test_Augmentation
qui sont visibles depuis l'extérieur (le programme appelant)
Le corps du paquetage est créé avec une procédure privée : PROCEDURE Afiche_Salaires qui n'est visible que dans le corps du paquetage
Le corps définit également une variable globale au corps du paquetage : GR$Emp utilisée par la procédure privée L'accès à un objet d'un paquetage est réalisé avec la syntaxe suivante : nom_paquetage.nom_objet[(liste paramètres)]
Appel de la fonction F_Test_Augmentation du paquetage
Appel de la procédure Test_Augmentation du paquetage
Interrogation de la variable globale publique : GN$Salaire
4.4 - Fonctions sur des ensembles de lignes (PIPELINED) (9i)
Oracle 9i
Depuis la version 9i apparaît une nouvelle possibilité de PL/SQL de pouvoir définir des fonctions qui acceptent en argument des collections ou des références à un curseur, et qui retournent les données au fur et à mesure de l'exécution de la fonction.
Lors de la déclaration de la fonction, le mot clé PIPELINED est ajouté dans l'entête et les informations sont retournées à l'aide de la commande PIPE ROW.
Soit l'exemple suivant
L'instruction table(LigneSalaire(CURSOR(Select * from EMP))) indique que la fonction LigneSalaire retourne un ensemble de données.
Cet exemple est bien évidemment simpliste, mais on peut imaginer toutes sortes de traitements sur les lignes du curseur avant de renvoyer le résultat.
Pour faire une estimation de la masse salariale totale après une augmentation de salaire de 10% pour l'ensemble du personnel, il suffit d'interroger la fonction de la façon suivante :
Bien entendu un résultat équivalent pourrait être obtenu avec la requête : select sum(sal * 1.1) from emp;
mais, répétons-le le traitement effectué dans la fonction peut être beaucoup plus élaboré.
4.5 - Maintenance des objets procéduraux
Visualisation du code source
Le code source des objets procéduraux est visible par l'intermédiare des vues du dictionnaire de données
USER_SOURCE pour les objets appartenant au schéma
ALL_SOURCE pour les objets appartenant aux schémas accessibles
DBA_SOURCE pour les objets appartenant à tous les schémas
Pour dissocier le code des procédures, fonctions et paquetages, la restriction sur la colonne TYPE doit être la suivante :
• Procédure : TYPE = 'PROCEDURE'
• Fonction : TYPE = 'FUNCTION'
• Spécification de paquetage : TYPE = 'PACKAGE' • Corps de paquetage : TYPE = 'PACKAGE BODY'
Compilation des objets
• Procédure : ALTER PROCEDURE nom_procédure COMPILE
• Fonction : ALTER FUNCTION nom_fonction COMPILE
• Spécification de paquetage : ALTER PACKAGE nom_package COMPILE PACKAGE
• Corps de paquetage : ALTER PACKAGE nom_package COMPILE BODY
• Spécification + Corps de paquetage : ALTER PACKAGE nom_package COMPILE
Suppression des objets
• Procédure : DROP PROCEDURE nom_procédure
• Fonction : DROP FUNCTION nom_fonction
• Paquetage entier : DROP PACKAGE nom_package
• Corps de paquetage : DROP PACKAGE BODY nom_package
5 - Collections et enregistrements
Ces types de données n'existent qu'en PL/SQL et n'ont pas d'équivalent dans la base Oracle
Il n'est pas possible de stocker un enregistrement directement dans la base
Les collections
Une collection est un ensemble ordonné d'éléments de même type.
Elle est indexée par une valeur de type numérique ou alphanumérique
Elle ne peut avoir qu'une seule dimension ( mais en créant des collections de collections on peut obtenir des tableaux à plusieurs dimensions)
On peut distinguer trois types différents de collections :
Les collections de type NESTED TABLE et VARRAY doivent-être initialisées après leur déclaration, à l'aide de leur constructeur qui porte le même nom que la collection
(elles sont assignées à NULL lors de leur déclaration. Il est donc possible de tester leur nullité)
Les enregistrements
Un enregistrement ressemble à une structure d'un L3G
Il est composé de champs qui peuvent être de type différent
5.1 - Déclarations et initialisation
Elles sont de taille dynamique et il n'existe pas forcément de valeur pour toutes les positions
Déclaration d'une collection de type nested table
TYPE nom type IS TABLE OF type élément [NOT NULL] ;
Déclaration d'une collection de type index by
TYPE nom type IS TABLE OF type élément [NOT NULL] INDEX BY index_by_type ;
index_by_type représente l'un des types suivants :
• BINARY_INTEGER
• PLS_INTEGER(9i)
• VARCHAR2(taille)
• LONG
Ce type de collection possède une dimension maximale qui doit être précisée lors de sa déclaration
Elle possède une longueur fixe et donc la suppression d'éléments ne permet pas de gagner de place en mémoire
Ses éléments sont numérotés à partir de la valeur 1
Déclaration d'une collection de type VARRAY
TYPE nom type IS VARRAY (taille maximum) OF type élément [NOT NULL] ;
Déclaration d'un tableau VARRAY de 30 éléments de type varchar2(100)
TYPE nom type IS RECORD ( nom_champ type_élément [[ NOT NULL] := expression ] [, #.] ) ;
Nom_variable nom_type ;
Comme pour la déclaration des variables, il est possible d'initialiser les champs lors de leur déclaration
Bien sûr il est possible de gérer des tableaux d'enregistrements
Les éléments d'un enregistrement peuvent être des objets, des collections ou d'autres enregistrements.
A la différence des types VARRAY et (NESTED)TABLES, les types RECORD ne peuvent pas être créés et stockés dans la base.
Initialisation des collections
Les collections de type NESTED TABLE et VARRAY doivent être initialisées avant toute utilisation (à l'exception des collections de type INDEX-BY TABLE).
Pour initialiser une collection, il faut se référer à son constructeur. Celui-ci, créé automatiquement par Oracle porte le même nom que la collection.
Declare
-- Déclaration d'un type tableau VARRAY de 30 éléments de type Varchar2(100)
TYPE TYP_VAR_TAB is VARRAY(30) of varchar2(100) ;
-- Déclaration et initialisation d'une variable de type TYP_VAR_TAB tab1 TYP_VAR_TAB := TYP_VAR_TAB('','','','','','','','','','');
Il n'est pas obligatoire d'initialiser tous les éléments d'une collection. On peut même n'en initialiser aucun. Dans ce cas l'appel de la méthode constructeur se fait sans argument .
tab1 TYP_VAR_TAB := TYP_VAR_TAB();
Cette collection n'a aucun élément initialisé. On dit qu'elle est vide.
Une collection non initialisée n'est pas vide mais NULL.
L'initialisation d'une collection peut se faire dans la section instructions, mais dans tous les cas, elle ne pourra pas être utilisée avant d'avoir été initialisée.
5.2 - Accès aux éléments d'une collection
La syntaxe d'accès à un élément d'une collection est la suivante :
Nom_collection( indice )
L'indice doit être un nombre valide compris entre -2**31 et 2**31
Pour une collection de type NESTED TABLE, l'indice doit être un nombre valide compris entre 1 et 2**31
Pour une collection de type VARRAY, l'indice doit être un nombre valide compris entre 1 et la taille maximum du tableau
Dans le cas d'une collection de type INDEX-BY Varchar2 ou Long, l'indice représente toute valeur possible du type concerné.
Indice peut être un littéral, une variable ou une expression
1 | Declare |
2 | Type TYPE_TAB_JOURS IS TABLE OF PLS_INTEGER INDEX BY VARCHAR2(20) ; |
3 | jour_tab TYPE_TAB_JOURS ; |
4 | Begin |
Il est possible d'assigner une collection à une autre à condition qu'elles soient de même type
Les collections ne peuvent pas être comparées entre elles.
Les opérateurs d'égalité ou de comparaison ne peuvent pas être utilisés entre 2 collections
(10g)
Les collections de même type peuvent être comparées en égalité ou différence
(10g)
Il est possible d'appliquer certains opérateurs sur des tables imbriquées
5.3 - Méthodes associées aux collections
Les méthodes sont des fonctions ou des procédures qui s'appliquent uniquement aux collections.
L'appel de ces méthodes s'effectue en préfixant le nom de la méthode par le nom de la collection
Nom_collection.nom_méthode[(paramètre, #)]
Les méthodes ne peuvent pas être utilisées à l'intérieur de commandes SQL
Seule la méthode EXISTS peut être utilisée sur une collection NULL.
L'utilisation de toute autre méthode sur une collection NULL provoque l'exception COLLECTION_IS_NULL
EXISTS(indice)
Cette méthode retourne la valeur TRUE si l'élément indice de la collection existe et retourne la valeur FALSE dans le cas contraire
Cette méthode doit être utilisée afin de s'assurer que l'on va réaliser une opération conforme sur la collection
Le test d'existence d'un élément qui n'appartient pas à la collection ne provoque pas l'exception
SUBSCRIPT_OUTSIDE_LIMIT mais retourne simplement FALSE
COUNT
Cette méthode retourne le nombre d'éléments de la collection y compris les éléments NULL consécutifs à des suppressions
Elle est particulièrement utile pour effectuer des traitements sur l'ensemble des éléments d'une collection.
LIMIT
Cette méthode retourne le nombre maximum d'éléments permis d'une collection
Elle n'est utile que pour les collections de type VARRAY et retourne NULL pour les collections des autre types
FIRST
Cette méthode retourne le plus petit indice d'une collection.
Elle retourne NULL si la collection est vide
Pour une collection de type VARRAY cette méthode retourne toujours 1
LAST
Cette méthode retourne le plus grand indice d'une collection.
Elle retourne NULL si la collection est vide
Pour une collection de type VARRAY cette méthode retourne la même valeur que la méthode COUNT
PRIOR(indice)
Cette méthode retourne l'indice de l'élément précédent l'indice donné en argument
Elle retourne NULL si indice est le premier élément de la collection
NEXT(indice)
Cette méthode retourne l'indice de l'élément suivant l'indice donné en argument
Elle retourne NULL si indice est le dernier élément de la collection
EXTEND[(n[,i])]
Cette méthode permet d'étendre une collection par ajout de nouveaux éléments
Elle dispose de 3 syntaxes différentes
• EXTEND
Un seul élément NULL est ajouté à la collection
• EXTEND(n)
n éléments NULL sont ajoutés à la collection
• EXTEND(n,i)
n éléments sont ajoutés à la collection. Chaque élément ajouté contient une copie de la valeur contenue dans l'élément d'indice i
TRIM[(n)]
Cette méthode permet de supprimer un ou plusieurs éléments situés à la fin d'une collection
Elle dispose de 2 formes de syntaxe différentes
TRIM
Le dernier élément de la collection est supprimé
TRIM(n)
Les n derniers éléments de la collection sont supprimés
Si le nombre d'éléments que l'on veut supprimer est supérieur au nombre total d'éléments de la collection, une exception SUBSCRIPT_BEYOND_COUNT est générée
DELETE[(n[,m])]
Cette méthode permet de supprimer un, plusieurs, ou la totalité des éléments d'une collection
Elle dispose de 3 formes de syntaxe différentes
• DELETE
Suppression de tous les éléments d'une collection
• DELETE(n)
Suppression de l'élément d'indice n de la collection
On peut observer que l'élément d'indice 5 de la collection, une fois supprimé, ne peut plus être affiché.
Il convient, lorsque l'on supprime un ou plusieurs éléments d'une collection des tester l'existence d'une valeur avant de la manipuler
Il est important de noter le décalage entre la valeur retournée par la méthode COUNT et celle retournée par la méthode LAST
Dans l'exemple précédent LAST retourne la plus grande valeur d'indice de la collection soit 7, alors que
COUNT retourne le nombre d'éléments de la collection soit 6
Méfiez-vous de l'erreur facile consistant à penser que COUNT = LAST
• DELETE(n,m)
Suppression des l'éléments dont les indices sont compris entre n et m (inclus) Si m est plus grand que n, aucun élément n'est supprimé
Pour les collections de type VARRAY on ne peut supprimer que le dernier élément
Si l'élément à supprimer n'existe pas, aucune exception n'est générée
L'espace mémoire assigné aux éléments supprimés est conservé. Il est tout à fait permis de réassigner une nouvelle valeur à ces éléments.
Principales exceptions
5.4 - Utilisation des collections avec les données issues de la base
Prenons l'exemple d'une table des entêtes de factures qui stocke également les lignes des factures
Sous Sql*Plus définissons le type ligne de facture (TYP_LIG_FAC)
Définissons le type TYP_TAB_LIG_FAC comme étant une collection d'éléments du type TYP_LIG_FAC
Création de la table des factures
Chaque élément présent dans la colonne ligne est une collection de type NESTED TABLE qui va permettre de stocker les différentes lignes de la facture
Insertion de données dans la table FACTURE
Modification d'une facture
Utilisation d'un type enregistrement (RECORD) pour sélectionner une ligne de la table FACTURE ainsi que toutes les lignes rattachées via la NESTED TABLE
Le champ lignes de l'enregistrement est déclaré de type LIGNE%type donc de type TYP_LIG_FAC.
On récupère dans un enregistrement l'entête de la facture ainsi que toutes les colonnes des lignes attachées.
Ou l'on s'aperçoit que le type RECORD permet de stocker et manipuler des objets complexes.
Une variable de type RECORD peut être utilisée dans une clause RETURNING INTO
5.5 - Traitements en masse des collections
Les collections permettent le traitement des données en " masse "
Elles permettent de charger les données d'une table, de les traiter puis de les enregistrer dans la base
Afin de limiter les interactions coûteuses entre le moteur PL/SQL et le moteur SQL, les collections peuvent être traitées intégralement grâce à la copie des données par blocs
Cette copie des données par blocs autorise un ordre SQL à traiter toute la collection grâce aux instructions BULK COLLECT et FORALL.
Pour s'en convaincre, analysons le code suivant :
Les deux parties de code réalisent exactement la même opération soit l'insertion de 50000 lignes dans une table.
Cependant les temps d'exécutions respectifs sont sans commune mesure
La différence s'explique uniquement par la charge de travail générée par les passages entre le moteur PL/SQL et le moteur SQL
BULK COLLECT
(Select)(Fetch)(execute immediate) # BULK COLLECT Into nom_collection [,nom_collection, #] [LIMIT
nombre_lignes] ;
Ce mot clé demande au moteur SQL de retourner l'ensemble des lignes lues dans une ou plusieurs collections avant de rendre la main au moteur PL/SQL.
Cette fonctionnalité réduit donc considérablement les allers-retours entre les deux moteurs.
Dans le cas d'une instruction FETCH, la clause optionnelle LIMIT permet de restreindre le nombre de lignes ramenées.
Ce nombre de lignes doit être exprimé sous forme de littéral ou de variable
Dans l'exemple suivant, on alimente la collection par groupes de 3 lignes
On peut également utiliser le mot clé LIMIT pour effectuer par tranches, des opérations coûteuses pour le ROLLBACK SEGMENT
Le mot clé BULK COLLECT peut également être utilisé pour récupérer les résultats d'un ordre DML, lorsqu'il est associé à la clause RETURNING INTO.
Une attention particulière doit être portée sur l'utilisation des méthodes appliquées aux collections, notamment FIRST.
Dans l'exemple suivant, la procédure tombe en erreur car aucune ligne n'est retournée.
Dans ce cas nom_collection.FIRST ne vaut pas zéro mais NULL
Il convient de tester la nullité d'une méthode avant de l'utiliser :
FORALL
FORALL index IN borne_inférieure..borne_supérieure [SAVE EXCEPTION] ordre_sql
Bien que l'instruction FORALL précise une borne début et une borne fin, il ne peut pas être inclus dans une boucle
FOR # LOOP
L'instruction FORALL ne peut pas être utilisée dans le code PL/SQL coté client
L'ordre SQL doit être INSERT, UPDATE ou DELETE en relation avec au moins une collection
Il doit exister des éléments dans la collection pour toutes les valeurs d'indice de l'instruction FORALL
Il n'est pas possible d'exprimer l'indice sous forme d'un calcul
FORALL ne peut traiter qu'un seul ordre SQL à la fois sous peine de générer un message d'erreur :
La variable d'index I n'est plus connue en sortie de l'instruction FORALL
A partir d'oracle9i, les copies d'informations par blocs peuvent être effectuées directement dans les collections d'enregistrements
Il n'est pas possible de mettre à jour une ligne complète avec une collection d'enregistrements en conjonction avec l'instruction FORALL
Pour cela il faut utiliser une boucle
Ou utiliser des collections simples
La gestion des erreurs avec la commande FORALL
Sans gestion particulière des exceptions dans le bloc PL/SQL, toute erreur d'exécution provoque l'annulation de toutes les instructions réalisées par l'instruction FORALL (ROLLBACK)
En présence d'une section Exception dans le bloc PL/SQL, il sera possible de décider si l'on conserve les modifications valides jusqu'à l'erreur (COMMIT) ou si l'on annule toute l'instruction FORALL (ROLLBACK)
Il est également possible, lors d'erreur sur une instruction, de sauvegarder l'information concernant l'exception et de poursuivre le processus
Cette fonctionnalité est implémentée par l'ajout du mot clé SAVE EXCEPTION dans l'instruction FORALL
Toutes les exceptions levées en cours d'exécution sont sauvées dans l'attribut %BULK_EXCEPTIONS, qui est une collection d'enregistrements.
Chaque enregistrement est composé de 2 champs :
%BULK_EXCEPTIONS(n).ERROR_INDEX qui contient l'indice de l'itération qui a provoqué l'erreur
%BULK_EXCEPTIONS(n).ERROR_CODE qui contient le code d'erreur
Le nombre total d'exceptions générées par l'instruction FORALL est contenu dans l'attribut SQL%BULK_EXCEPTIONS.COUNT
L'attribut %BULK_ROWCOUNT
En plus des attributs de curseur %FOUND, %NOTFOUND, %ISOPEN et %ROWCOUNT, le curseur implicite SQL
dispose d'un attribut spécifique à l'instruction FORALL : %BULK_ROWCOUNT
Il s'agit d'une collection de type INDEX BY TABLE pour laquelle l'élément d'indice n contient le nombre de lignes affectées par l'exécution de l'ordre SQL numéro n
Si aucune ligne n'est affectée par l'instruction numéro n alors l'attribut SQL%BULK_ROWCOUNT(n) vaut 0
5.6 - Les collections et enregistrements en paramètres des procédures et fonctions
Le passage de ces types d'objets se fait de façon identique qu'avec les types scalaires.
Soit le package suivant :
8 | GN$Lig := 0 ; |
9 | For i IN Loop |
10 | GN$Lig := GN$Lig + 1 ; |
11 | If GN$Lig <= 10 Then |
12 | dbms_output.put_line( Rpad( Temp(i).ename, 25 ) || ' --> ' || To_char( Temp(i).sal ) ) |
; 13 | End if ; |
14 | End loop ; |
15 | End Affiche_lignes ; |
16 17 | PROCEDURE Affiche_ligne ( Temp IN OUT EMP%ROWTYPE ) |
18 | IS |
19 | Begin |
20 | GN$Lig := GN$Lig + 1 ; |
21 | := * 1.1 ; |
22 | If GN$Lig <= 10 Then |
23 | dbms_output.put_line( Rpad( Temp.ename, 25 ) || ' --> ' || To_char( ) ) ; |
24 | End if ; |
25 | End Affiche_ligne ; |
26 27 | PROCEDURE Affiche_ligne_nocopy ( Temp IN OUT NOCOPY EMP%ROWTYPE ) |
28 | IS |
29 | Begin |
30 | GN$Lig := GN$Lig + 1 ; |
31 | := * 1.1 ; |
32 | If GN$Lig <= 10 Then |
33 | dbms_output.put_line( Rpad( Temp.ename, 25 ) || ' --> ' || To_char( ) ) ; |
34 | End if ; |
35 | End Affiche_ligne_nocopy ; |
36 37 | PROCEDURE Modifie_lignes ( Temp IN OUT TYP_TAB_EMP ) |
38 | IS |
39 | Begin |
40 | GN$Lig := 0 ; |
41 | For i IN Loop |
42 | Temp(i).sal := Temp(i).sal * 1.1 ; |
43 | Affiche_ligne( Temp(i) ) ; |
44 | End loop ; |
45 | End Modifie_lignes ; |
46 47 | PROCEDURE Modifie_lignes_nocopy ( Temp IN OUT NOCOPY TYP_TAB_EMP ) |
48 | IS |
49 | Begin |
50 | GN$Lig := 0 ; |
51 | For i IN Loop |
52 | Temp(i).sal := Temp(i).sal * 1.1 ; |
53 | Affiche_ligne_nocopy( Temp(i) ) ; |
54 | End loop ; |
55 | End Modifie_lignes_nocopy ; |
56 57 | PROCEDURE Modifie_lignes2 ( Temp IN OUT TYP_TAB_EMP2 ) |
58 | IS |
59 | Begin |
60 | GN$Lig := 0 ; |
61 | For i IN Loop |
62 | Temp(i).sal := Temp(i).sal * 1.1 ; |
63 | Affiche_ligne( Temp(i) ) ; |
64 | --dbms_output.put_line( Rpad( Temp(i).ename, 25 ) || ' --> ' || To_char( Temp(i).sal ) ) ; |
65 | End loop ; |
66 | End Modifie_lignes2 ; |
67 68 | PROCEDURE Modifie_lignes_nocopy2 ( Temp IN OUT NOCOPY TYP_TAB_EMP2 ) |
69 | IS |
70 | Begin |
71 | GN$Lig := 0 ; |
72 | For i IN Loop |
73 | Temp(i).sal := Temp(i).sal * 1.1 ; |
74 | Affiche_ligne_nocopy( Temp(i) ) ; |
75 | --dbms_output.put_line( Rpad( Temp(i).ename, 25 ) || ' --> ' || To_char( Temp(i).sal ) ) ; |
76 | End loop ; |
77 | End Modifie_lignes_nocopy2 ; |
78 79 80 | FUNCTION Affiche_lignes Return TYP_TAB_EMP |
81 | IS |
82 | Tlignes PKG_TEST.TYP_TAB_EMP ; |
83 | Cursor C_EMP is Select * From EMP ; |
84 | Begin |
85 | Open C_EMP ; |
Collections en argument de procédure
Nous allons maintenant écrire un bloc PL/SQL anonyme qui utilise la fonction Affiche_lignes()
Une variable Tlignes est déclarée avec le type PKG_TEST.TYP_TAB_EMP qui est une collection d'enregistrements de type EMP%ROWTYPE
Cette collection est alimentée par le curseur C_EMP et transmise à la procédure qui en affiche une partie du contenu.
Vous pouvez également ne transmettre qu'une ligne de la collection
La procédure Affiche_ligne() reçoit en argument une variable de type EMP%ROWTYPE.
Dans l'appel, seule la deuxième ligne de la collection lui est transmise.
Pour pouvoir en modifier la valeurs des éléments, la collection doit être transmise en mode IN OUT
Lors du passage de collections ou éléments de collection à des procédures ou fonctions, les arguments sont passés par copie.
Une copie de l'objet est faite dans un espace mémoire particulier.
Dans le cas où des collections très volumineuses sont passées en argument, où de nombreux appels sont effectuées avec des collections ou éléments de collection, il est préférable de passer les arguments en mode NOCOPY.
En effet dans ce mode, aucun espace mémoire supplémentaire n'est alloué puisque la variable est passée par référence (Le pointeur sur la variable)
Voir la procédure PKG_TEST.Affiche_ligne_nocopy()
Collections en retour de fonction
Soit la fonction PKG_TEST.Affiche_lignes
Appelée par le bloc PL/SQL suivant :
La fonction Affiche_lignes retourne une collection de type PKG_TEST.TYP_TAB_EMP,
ouvre un curseur sur la table EMP pour remplir la collection et la retourne au bloc PL/SQL appelant qui peut en afficher les valeurs
Enregistrements
Lorsque l'on veut appeler une fonction retournant un type RECORD, il faut respecter la syntaxe suivante pour référencer un champ de l'enregistrement : Nom_fonction(argument).nom_champ
6 - Les déclencheurs
Un déclencheur est un bloc PL/SQL associé à une vue ou une table, qui s'exécutera lorsqu'une instruction du langage de manipulation de données (DML) sera exécutée
L'avantage principal du déclencheur réside dans le fait que le code est centralisé dans la base de données, et se déclenchera quel que soit l'outil utilisé pour mettre à jour ces données, donnant ainsi l'assurance qu'une utilisation d'un ordre DML depuis Sql*Plus, Forms ou n'importe quelle application tierce procurera un résultat identique sur les données
l'inconvénient principal du déclencheur réside dans le fait que son exécution utilise des ressources qui peuvent augmenter sensiblement les temps de traitement, notamment lors de modifications massives apportées sur une table
Un déclencheur s'exécute dans le cadre d'une transaction. Il ne peut donc pas contenir d'instruction COMMIT ou ROLLBACK ou toute instruction générant une fin de transaction implicite (ordre DDL)
Les ordres SQL (SELECT, INSERT, UPDATE, DELETE) contenus dans le bloc PL/SQL et qui se référent à la table sur laquelle s'exécute le déclencheur peuvent générer l'exception ORA-04091 TABLE IS MUTATING
(pour une explication détaillée du problème des tables en mutation, référez-vous à l'article Résolution du problème de la table mutante (ora-04091) par Pomalaix
Le bloc PL/SQL qui constitue le trigger peut être exécuté avant ou après la vérification des contraintes d'intégrité
Il peut être exécuté pour chaque ligne affectée par l'ordre DML ou bien une seule fois pour la commande
Seules les colonnes de la ligne en cours de modification sont accessibles par l'intermédiaire de 2 variables de type enregistrement OLD et NEW
OLD représente la valeur avant modification
OLD n'est renseignée que pour les ordres DELETE et UPDATE. Elle n'a aucune signification pour un ordre
INSERT, puisqu'aucune ancienne valeur n'existe
NEW représente la nouvelle valeur
NEW n'est renseignée que pour les ordres INSERT et UPDATE. Elle n'a aucune signification pour un ordre DELETE, puisqu'aucune nouvelle valeur n'existe
Ces deux variables peuvent être utilisées dans la clause WHEN du déclencheur et dans la section exécutable Dans cette section, elle doivent être préfixées comme des variables hôtes avec l'opérateur :
Les noms de ces deux variables sont fixés par défaut, mais il est possible de les modifier en précisant les nouveaux noms dans la clause REFERENCING
REFERENCING OLD AS nouveau_nom NEW AS nouveau_nom
Evt. DML représente l'évènement INSERT ou UPDATE ou DELETE
Evt. DDL représente un évènement utilisateur Evt. système représente un évènement système colonne nest. table représente le nom d'une colonne de table imbriquée référencement représente le renommage des valeurs OLD et NEW
Dans le cas d'un déclencheur BEFORE UPDATE ou AFTER UPDATE, la clause OF peut être ajoutée après le mot clé UPDATE pour spécifier la liste des colonnes modifiées.
Cela permet de restreindre l'activation du déclencheurs sur les seules colonnes visées.
Le mot clé WHEN(condition) permet également de restreindre le champs d'activation du déclencheur en ajoutant une clause restrictive
6.1 - Les déclencheurs sur TABLE
Créons un déclencheur très basique qui ne fait qu'afficher le numéro et le nom d'un employé que l'on veut supprimer de la table EMP
Supprimons maintenant un employé
La DRH annonce que désormais, tout nouvel employé devra avoir un numéro supérieur ou égal à 10000
Il faut donc interdire toute insertion qui ne reflète pas cette nouvelle directive
Tentons d'insérer un nouvel employé avec le numéro 9999
SQL> insert into emp (empno, ename, job) values( 9999, 'Burger', 'CLERK' ) ; insert into emp (empno, ename, job) values( 9999, 'Burger', 'CLERK' ) * ERREUR à la ligne 1 :
ORA-20010: Numéro employé inférieur à 10000
ORA-06512: à "SCOTT.TRG_BIR_EMP", ligne 3
ORA-04088: erreur lors d'exécution du déclencheur 'SCOTT.TRG_BIR_EMP'
L'ordre d'insertion est rejeté
Il est possible de gérer dans le même déclencheur des ordres DML différents en combinant les termes de la clause BEFORE avec le mot clé OR
Notez au passage que dans l'exemple de la suppression, les deux déclencheurs de type BEFORE DELETE ont été exécutés
6.2 - Les déclencheurs sur VUE
La syntaxe d'un déclencheur sur vue est identique à celle du déclencheur sur table, à la différence que la clause INSTEAD OF est ajoutée
Ce type de déclencheur est particulier dans la mesure ou son exécution remplace celle de la commande DML à laquelle il est associé
Ce type de déclencheur n'est définissable que sur les vues et lui seul peut être mis en place sur les vues
Nous mettons à la disposition de certains utilisateurs une vue permettant de sélectionner les employés qui ont le job CLERK
A travers cette vue, ces utilisateurs peuvent insérer des lignes
Cependant, ils ne peuvent pas voir leurs insertions car la colonne job (inutile dans ce cas) ne fait pas partie de la vue et donc de l'insertion !
Nous allons donc créer un déclencheur sur vue qui va résoudre ce problème
L'utilisateur peut désormais visualiser ses insertions
6.3 - Les déclencheurs sur évènements système ou utilisateur
depuis la version Oracle8i, il est désormais possible d'utiliser des déclencheurs pour suivre les changements d'état du système ainsi que les connexions/déconnexions utilisateur et la surveillance des ordres DDL et DML
Lors de l'écriture de ces déclencheurs, il est possible d'utiliser des attributs pour identifier précisément l'origine des évènements et adapter les traitements en conséquence
6.3.1 - Les attributs
• ora_client_ip_adress
• ora_database_name
• ora_des_encrypted_password
• ora_dict_obj_name
• ora_dict_obj_name_list
• ora_dict_obj_owner
• ora_dict_obj_owner_list
• ora_dict_obj_type
• ora_grantee
• ora_instance_num
• ora_is_alter_column
• ora_is_creating_nested_table
• ora_is_drop_column
• ora_is_servererror
• ora_login_user
• ora_privileges
• ora_revokee
• ora_server_error
• ora_sysevent
• ora_with_grant_option
6.3.2 - Les évènements système
CREATE TRIGGER nom_déclencheur {BEFORE|AFTER} évènement_système ON{DATABASE|SCHEMA} bloc PL/SQL
• STARTUP
• SHUTDOWN
• SERVERERROR
6.3.3 - Les évènements utilisateur
CREATE TRIGGER nom_déclencheur {BEFORE|AFTER} évènement_utilisateur ON{DATABASE|SCHEMA} bloc PL/SQL
• LOGON
• LOGOFF
• CREATE
• ALTER
• DROP
• ANALYZE
• ASSOCIATE STATISTICS
• AUDIT
• NOAUDIT
• COMMENT
• DDL
• DISSOCIATE STATISTICS
• GRANT
• RENAME
• REVOKE
• TRUNCATE
6.4 - Maintenance des déclencheurs
Activation/désactivation d'un déclencheur.
Il est possible de désactiver un déclencheur avec la commande suivante ALTER TRIGGER nom_déclencheur DISABLE
et de l'activer avec la commande suivante
ALTER TRIGGER nom_déclencheur ENABLE
De la même façon, on peut désactiver tous les déclencheurs définis sur une table ALTER TABLE nom_table DISABLE ALL TRIGGERS
et de les activer avec la commande suivante
ALTER TABLE nom_table ENABLE ALL TRIGGERS
Les informations sur les déclencheurs sont visibles à travers les vues du dictionnaire de données
USER_TRIGGERS pour les déclencheurs appartenant au schéma
ALL_TRIGGERS pour les déclencheurs appartenant aux schémas accessibles
DBA_TRIGGERS pour les déclencheurs appartenant à tous les schémas
La colonne BASE_OBJECT_TYPE permet de savoir si le déclencheur est basé sur une table, une vue, un schéma ou la totalité de la base
La colonne TRIGGER_TYPE permet de savoir s'il s'agit d'un déclencheur BEFORE, AFTER ou INSTEAD OF si son mode est FOR EACH ROW ou non
s'il s'agit d'un déclencheur évènementiel ou non
La colonne TRIGGERING_EVENT permet de connaître l'évèvement concerné par le déclencheur
La colonne TRIGGER_BODY contient le code du bloc PL/SQL
7 - Le paquetage DBMS_OUTPUT
Les procédures de ce paquetage vous permettent d'écrire des lignes dans un tampon depuis un bloc PL/SQL anonyme, une procédure ou un déclencheur.
Le contenu de ce tampon est affiché à l'écran lorsque le sous-programme ou le déclencheur est terminé.
L'utilité principale est d'afficher à l'écran des informations de trace ou de débogage
La taille maximum du tampon est de un million de caractères
La taille maximum d'une ligne est de 255 caractères
La capacité maximum d'une ligne étant de 255 caractères, voyez la procédure DEBUG, présentée au chapitre
Fonctions et procédure, qui permet de s'affranchir de cette limitation
Fonctions et procédures du paquetage
• DBMS_OUTPUT.ENABLE ( taille_tampon IN INTEGER DEFAULT 20000)
Cette procédure permet d'initialiser le tampon d'écriture et d'accepter les commandes de lecture et d'écriture dans ce tampon.
taille_tampon représente la taille maximum en octets allouée au tampon.
Les valeurs doivent être indiquées dans une plage de valeur allant de 2000 (minimum) et 1 million (maximum). Sa valeur par défaut est 20000.
Exceptions générées
ORA-20000: Buffer overflow, limit of (buffer_limit) bytes.
ORU-10027:
• DBMS_OUTPUT.DISABLE
Cette procédure désactive les appels de lecture et écriture dans le tampon et purge ce dernier.
Procédures d'écriture dans le tampon
• (item IN NUMBER)
• (item IN VARCHAR2)
• (item IN DATE)
• DBMS_OUTPUT.PUT_LINE (item IN NUMBER)
• DBMS_OUTPUT.PUT_LINE (item IN VARCHAR2)
• DBMS_OUTPUT.PUT_LINE (item IN DATE)
• DBMS_OUTPUT.NEW_LINE
item représente un littéral ou une variable
permet d'ajouter des informations dans la ligne en cours du tampon
DBMS_OUTPUT.PUT_LINE permet de générer une ligne entière dans le tampon. Un caractère fin de ligne est automatiquement ajouté en fin de ligne
DBMS_OUTPUT.NEW_LINE permet d'ajouter au tampon un caractère fin de ligne
Exceptions générées
ORA-20000 Buffer overflow, limit of (buf_limit) bytes.
ORU-10027:
ORA-20000 Line length overflow, limit of 255 bytes per line.
ORU-10028:
Procédures de lecture du tampon
• DBMS_OUTPUT.GET_LINE (ligne OUT VARCHAR2, statut OUT INTEGER)
ligne représente une ligne du tampon retournée, à l'exclusion du caractère NL final La longueur maximum de ligne est de 255 caractères
statut retourne la valeur 0 si la lecture s'est déroulée correctement et 1 s'il n'y a plus de lignes dans le tampon
• DBMS_OUTPUT.GET_LINES (lignes OUT tableau_char, nombre_lignes IN OUT INTEGER)
tableau_char représente un tableau de chaînes de caractères. La taille maximum de chaque ligne est de 255 caractères nombre_lignes en entrée représente le nombre de lignes du tampon que l'on souhaite lire. En sortie, il indique le nombre de lignes effectivement lues depuis le tampon
Exemple
Notez, sous Sql*Plus la commande SET SERVEROUTPUT ON qui permet de rendre actives les fonctions du paquetage DBMS_OUTPUT
8 - Le paquetage UTL_FILE
Les procédures et fonctions de ce paquetage vous permettent de lire et écrire dans des fichiers texte situés dans les répertoires du système d'exploitation.
Elles sont exécutées par le noyau Oracle, donc sur la partie serveur.
Pour bénéficier des mêmes fonctionnalités sur la partie cliente, il faut utiliser le paquetage TEXT_IO.
Sous Oracle 9i, l'accès à ces fichiers est restreint aux répertoires(DIRECTORIES) déclarés au niveau du serveur.
Dans les version antérieures, la description des répertoires autorisés était spécifiée dans le paramètre UTL_FILE_DIR du fichier d'initialisation , dont toute modification imposait évidement un arrêt et relance de la base
Pour créer un répertoire, il faut avoir le privilège CREATE DIRECTORY, accordé par défaut aux seuls schémas SYS et SYSTEM
Pour accéder en lecture aux répertoires déclarés dans les répertoires, l'utilisateur doit avoir le droit READ sur le ou les répertoires
Pour accéder en écriture aux répertoires déclarés dans les répertoires, l'utilisateur doit avoir le droit WRITE sur le ou les répertoires
Créons sous l'utilisateur SYSTEM deux répertoires pour les fichiers en entrée et ceux en sortie
Le répertoire contenant les fichiers en entrée se voit attribuer le droit de lecture (READ) pour tous les utilisateurs
Le répertoire contenant les fichiers en sortie se voit attribuer les droits de lecture (READ) et écriture (WRITE) pour tous les utilisateurs
Il n'y a pas de système de récursivité dans les sous-répertoires
CREATE DIRECTORY FICHIERS_IN AS 'd:\fichiers\in' n'autorise pas l'accès aux éventuels sous-répertoires
8.1 - Procédures et fonctions du paquetage
8.1.1 - Liste des procédures et fonctions version 8i
• Fonction IS_OPEN Teste si le pointeur de fichier se réfère à un fichier ouvert
• Procédure FCLOSE Fermeture d'un fichier
• Procédure FCLOSE_ALL Fermeture de tous les fichiers ouverts
• Fonction FOPEN Ouverture d'un fichier pour lecture ou écriture
• Procédure FFLUSH Ecriture physique des tampons sur le disque
• Procédure GET_LINE Lecture d'une ligne depuis un fichier ouvert
• Procédure PUT Ecriture d'une ligne (sans caractère fin de ligne) dans un fichier ouvert
• Procédure PUT_LINE Ecriture d'une ligne (avec caractère fin de ligne) dans un fichier ouvert
• Procédure PUTF Ecriture d'une ligne formatée
• Procédure PUTF Ecriture d'une ligne formatée
8.1.2 - Liste des procédures et fonctions version 9i
• Fonction IS_OPEN Test si le pointeur de fichier se réfère à un fichier ouvert
• Procédure FCLOSE Fermeture d'un fichier
• Procédure FCLOSE_ALL Fermeture de tous les fichiers ouverts
• Fonction FCOPY Copie d'un fichier sur le disque
• Fonction FOPEN Ouverture d'un fichier pour lecture ou écriture
• Fonction FOPEN_NCHAR Ouverture d'un fichier en unicode pour lecture ou écriture
• Procédure FFLUSH Ecriture physique des tampons sur le disque
• Procédure FGETATTR Lecture des attributs d'un fichier
• Fonction FGETPOS Retourne la position du pointeur de lecture/écriture
• Fonction FREMOVE Suppression d'un fichier sur le disque
• Fonction FRENAME Renommage d'un fichier
• Fonction FSEEK Déplacement du pointeur de lecture/écriture dans le fichier
• Procédure GET_LINE Lecture d'une ligne depuis un fichier ouvert
• Procédure GET_LINE_NCHAR Lecture d'une ligne en unicode depuis un fichier ouvert
• Procédure GET_RAW Lecture d'une ligne de type RAW depuis un fichier ouvert avec ajustement du pointeur de position
• Procédure NEW_LINE Ecriture d'un caractère fin de ligne dans un fichier ouvert
• Procédure PUT Ecriture d'une ligne (sans caractère fin de ligne) dans un fichier ouvert
• Procédure PUT_NCHAR Ecriture d'une ligne en unicode (sans caractère fin de ligne) dans un fichier ouvert
• Procédure PUT_RAW Ecriture d'une ligne de type RAW dans un fichier ouvert
• Procédure PUT_LINE Ecriture d'une ligne (avec caractère fin de ligne) dans un fichier ouvert
• Procédure PUT_LINE_NCHAR Ecriture d'une ligne en unicode (avec caractère fin de ligne) dans un fichier ouvert
• Procédure PUTF Ecriture d'une ligne formatée
• Procédure PUTF_NCHAR Ecriture d'une ligne en unicode formatée
8.2 - Syntaxe des procédures et fonctions
8.2.1 - IS_OPEN
Vérification de l'ouverture d'un fichier
UTL_FILE.IS_OPEN ( pointeur IN FILE_TYPE)
RETURN BOOLEAN
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR()
La fonction retourne TRUE si le fichier est ouvert, sinon FALSE
8.2.2 - FCLOSE
Fermeture d'un fichier UTL_FILE.FCLOSE (
pointeur IN OUT FILE_TYPE)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR()
Exceptions générées
WRITE_ERROR
INVALID_FILEHANDLE
8.2.3 - FCLOSE_ALL
Fermeture de tous les fichiers ouverts de la session en cours
UTL_FILE.FCLOSE_ALL
Exceptions générées
WRITE_ERROR
8.2.4 - FCOPY
Copie d'un fichier
UTL_FILE.FCOPY ( dir_source IN VARCHAR2, fichier_source IN VARCHAR2, dir_cible IN VARCHAR2, fichier_cible IN VARCHAR2, ligne_debut IN PLS_INTEGER DEFAULT 1, ligne_fin IN PLS_INTEGER DEFAULT NULL)
dir_source représente le répertoire Oracle du fichier source fichier_source représente le nom du fichier source avec son extension dir_cible représente le répertoire de destination fichier_cible représente le nom du fichier de destination ligne_debut représente le numéro de ligne de début de copie (par défaut 1, début du fichier) ligne_fin représente le numéro de ligne de fin de copie (par défaut NULL, fin du fichier)
Cette fonction permet de créer un fichier à partir d'un autre en recopiant tout ou partie du fichier source.
8.2.5 - FOPEN
Ouverture d'un fichier
Oracle 8i, 9i
UTL_FILE.FOPEN ( repertoire IN VARCHAR2, fichier IN VARCHAR2, mode IN VARCHAR2,
taille_ligne_maxi IN BINARY_INTEGER) RETURN UTL_FILE.FILE_TYPE
repertoire représente le chemin d'accès (8i) ou le répertoire (9i) fichier représente le nom du fichier avec son extension mode représente le mode d'ouverture du fichier qui peut prendre l'une des trois valeurs suivantes
• R le fichier est ouvert en lecture (Read)
• W le fichier est ouvert en écriture (Write) • A le fichier est ouvert en ajout (Append)
taille_ligne_maxi représente la taille maximum en octets d'une ligne lue ou écrite. La plage des valeurs acceptables est comprise entre 1 et 32767 (par défaut environ 1000)
La fonction retourne un enregistrement de type UTL_FILE.FILE_TYPE
Exceptions générées
Oracle 8i, 9i
INVALID_PATH: Nom de répertoire ou de fichier invalide.
INVALID_MODE: Mode d'ouverture invalide.
INVALID_OPERATION: Le fihcier ne peut être ouvert.
INVALID_MAXLINESIZE: La valeur de taille_ligne_maxi est trop grande ou trop petite.
8.2.6 - FOPEN_NCHAR
(9i)
Ouverture d'un fichier
Identique à la fonction FOPEN, mais traite des fichiers en mode unicode
UTL_FILE.FOPEN_NCHAR ( repertoire IN VARCHAR2, fichier IN VARCHAR2, mode IN VARCHAR2,
taille_ligne_maxi IN BINARY_INTEGER)
RETURN UTL_FILE.FILE_TYPE
8.2.7 - FFLUSH
Ecriture physique des tampons sur le disque
UTL_FILE.FFLUSH ( pointeur IN FILE_TYPE)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR()
Cette fonction permet de forcer l'écriture du tampon sur le disque
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.2.8 - FGETATTR
(9i)
Lecture des attributs d'un fichier
UTL_FILE.FGETATTR( repertoire IN VARCHAR2, fichier IN VARCHAR2, exists OUT BOOLEAN, taille_fichier OUT NUMBER, taille_bloc OUT NUMBER)
repertoire représente le répertoire Oracle fichier représente le nom du fichier avec son extension exists vaut TRUE si le fichier existe, sinon FALSE taille_fichier représente la taille du fichier en octets taille_bloc représente la taille d'un bloc système en octets
Cette fonction teste l'existence d'un fichier et récupère, dans l'affirmative, la taille du fichier et la taille du bloc système
8.2.9 - FGETPOS
Position du pointeur de lecture/écriture du fichier
UTL_FILE.FGETPOS (
pointeur IN file_type)
RETURN PLS_INTEGER
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR()
Cette fonction retourne la position en octets actuelle de pointeur du fichier ouvert
8.2.10 - FREMOVE
(9i)
Suppression d'un fichier sur disque
UTL_FILE.FREMOVE ( repertoire IN VARCHAR2, fichier IN VARCHAR2)
repertoire représente le répertoire Oracle fichier représente le nom du fichier avec son extension
8.2.11 - FRENAME
(9i)
Renommage d'un fichier sur disque
UTL_FILE.FRENAME ( dir_source IN VARCHAR2, fichier_source IN VARCHAR2, dir_cible IN VARCHAR2, fichier_cible IN VARCHAR2, remplacer IN BOOLEAN DEFAULT FALSE)
dir_source représente le répertoire Oracle du fichier source fichier_source représente le nom du fichier source avec son extension dir_cible représente le répertoire de destination fichier_cible représente le nom du fichier de destination remplacer positionné à TRUE permet d'écraser un fichier existant
Cette fonction permet de renommer un fichier avec possibilité de déplacement, comme de la commande Unix mv
8.2.12 - FSEEK
(9i)
Positionnement du pointeur de lecture/écriture dans le fichier
UTL_FILE.FSEEK (
pointeur IN utl_file.file_type,
déplacement_absolu IN PL_INTEGER DEFAULT NULL, déplacement_relatif IN PLS_INTEGER DEFAULT NULL)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() déplacement_absolu représente l'octet du fichier sur lequel on veut pointer déplacement_relatif représente un déplacement vers l'avant ou vers l'arrière par rapport à la position courante
si déplacement_relatif est positif, le déplacement s'effectue vers la fin du fichier si déplacement_relatif est négatif, le déplacement s'effectue vers le début du fichier
8.2.13 - GET_LINE
Lecture d'une ligne depuis un fichier
Oracle 8i
UTL_FILE.GET_LINE ( pointeur IN FILE_TYPE, tampon OUT VARCHAR2);
Oracle 9i
UTL_FILE.GET_LINE ( pointeur IN FILE_TYPE, tampon OUT VARCHAR2, longueur IN NUMBER, len IN PLS_INTEGER DEFAULT NULL)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable destinée à recevoir les données lues longueur représente le nombre maximum d'octets à lire
len représente le nombre d'octets à lire. Par défaut il est à NULL ce qui signifie qu'il vaut la taille maximum d'un
RAW
La variable tampon doit être suffisamment dimensionnée pour accueillir la ligne lue depuis le fichier sous peine de générer l'exception VALUE_ERROR longueur ne peut pas excéder la valeur définie par le paramètre taille_ligne_maxi de la fonction FOPEN()
Lorsque la lecture ne ramène aucune donnée (fin de fichier), l'exception NO_DATA_FOUND est générée
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
READ_ERROR
NO_DATA_FOUND
VALUE_ERROR
8.2.14 - GET_LINE_NCHAR
(9i)
Lecture d'une ligne en unicode depuis un fichier
UTL_FILE.GET_LINE_NCHAR ( pointeur IN FILE_TYPE, tampon OUT NVARCHAR2, len IN PLS_INTEGER DEFAULT NULL)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable de type NVARCHAR2 retournée par la procédure
len représente le nombre d'octets à lire. Par défaut il est à NULL ce qui signifie qu'il vaut la taille maximum d'un
RAW
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
READ_ERROR
NO_DATA_FOUND
VALUE_ERROR
8.2.15 - GET_RAW
(9i)
Lecture d'une ligne dans une variable RAW depuis un fichier
UTL_FILE.GET_RAW (
pointeur IN utl_file.file_type,
tampon OUT NOCOPY RAW,
len IN PLS_INTEGER DEFAULT NULL)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable de type RAW retournée par la procédure
len représente le nombre d'octets à lire. Par défaut il est à NULL ce qui signifie qu'il vaut la taille maximum d'un
RAW
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
READ_ERROR
NO_DATA_FOUND
VALUE_ERROR
8.2.16 - NEW_LINE
Ecriture d'un caractère fin de ligne dans un fichier
UTL_FILE.NEW_LINE ( pointeur IN FILE_TYPE, nombre_lignes IN NATURAL := 1)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR()
nombre_lignes représente le nombre de terminateurs fin de ligne que l'on souhaite écrire dans le fichier (par défaut 1)
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.2.17 - PUT
Ecriture d'une ligne (sans caractère fin de ligne) dans un fichier
( pointeur IN FILE_TYPE, tampon IN VARCHAR2)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable destinée à contenir les données à écrire
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.2.18 - PUT_NCHAR
(9i)
Ecriture d'une ligne en unicode (sans caractère fin de ligne) dans un fichier
UTL_FILE.PUT_INCHAR ( pointeur IN FILE_TYPE, tampon IN NVARCHAR2)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable de type NVARCHAR2 destinée à contenir les données à écrire
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.2.19 - PUT_RAW
(9i)
Ecriture d'une ligne de type RAW dans un fichier
UTL_FILE. PUT_RAW (
pointeur IN utl_file.file_type,
tampon IN RAW, autoflush IN BOOLEAN DEFAULT FALSE)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable de type RAW destinée à contenir les données à écrire autoflush, positionné à TRUE permet de forcer l'écriture du tampon sur disque.
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.2.20 - PUT_LINE
Ecriture d'une ligne (avec caractère fin de ligne) dans un fichier
Oracle 8i
UTL_FILE.PUT_LINE ( pointeur IN FILE_TYPE, tampon IN VARCHAR2)
Oracle 9i
UTL_FILE.PUT_LINE ( pointeur IN FILE_TYPE, tampon IN VARCHAR2, autoflush IN BOOLEAN DEFAULT FALSE)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable destinée à contenir les données à écrire autoflush, positionné à TRUE permet de forcer l'écriture du tampon sur disque.
Un caractère fin de ligne est ajouté en fin de tampon
8.2.21 - PUT_LINE_NCHAR
(9i)
Ecriture d'une ligne en unicode (avec caractère fin de ligne) dans un fichier
UTL_FILE.PUT_LINE_NCHAR ( pointeur IN FILE_TYPE, tampon IN NVARCHAR2, autoflush IN BOOLEAN DEFAULT FALSE)
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() tampon représente la variable de type NVARCHAR2 destinée à contenir les données à écrire
autoflush, positionné à TRUE permet de forcer l'écriture du tampon sur disque.
Un caractère fin de ligne est ajouté en fin de tampon
8.2.22 - PUTF
Ecriture d'une ligne formatée dans un fichier
( pointeur IN FILE_TYPE, format IN VARCHAR2,
[arg1 IN VARCHAR2 DEFAULT NULL,
. . .
arg5 IN VARCHAR2 DEFAULT NULL])
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() format représente une chaîne pouvant inclure les caractères %s et \n arg1.. arg5 représentent jusqu'à 5 paramètres dont chaque valeur remplace un caractère %s du format donné. Cette fonction ressemble à une version limitée de fprintf() du langage C
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.2.23 - PUTF_NCHAR
Ecriture d'une ligne unicode formatée dans un fichier
UTL_FILE.PUTF_NCHAR (
pointeur IN FILE_TYPE, format IN NVARCHAR2,
[arg1 IN NVARCHAR2 DEFAULT NULL,
. . .
arg5 IN NVARCHAR2 DEFAULT NULL])
pointeur représente une variable de type UTL_FILE.FILE_TYPE préalablement obtenue par un appel aux fonctions FOPEN() ou FOPEN_NCHAR() format représente une chaîne pouvant inclure les caractères %s et \n arg1.. arg5 représentent jusqu'à 5 paramètres dont chaque valeur remplace un caractère %s du format donné.
Exceptions générées
INVALID_FILEHANDLE
INVALID_OPERATION
WRITE_ERROR
8.3 - Exceptions générées par le paquetage
8.3.1 - Exceptions de la version 8i
• INVALID_PATH La directorie ou le nom de fichier est invalide
• INVALID_MODE Mode d'ouverture invalide pour la fonction FOPEN
• INVALID_FILEHANDLE Pointeur de fichier invalide
• INVALID_OPERATION Le fichier ne peut être ouvert ou manipulé
• READ_ERROR Erreur système pendant une opération de lecture
• WRITE_ERROR Erreur système pendant une opération d'écriture
• INTERNAL_ERROR Erreur PL/SQL non spécifiée
8.3.2 - Exceptions de la version 9i
• INVALID_PATH La directorie ou le nom de fichier est invalide
• INVALID_MODE Mode d'ouverture invalide pour la fonction FOPEN
• INVALID_FILEHANDLE Pointeur de fichier invalide
• INVALID_OPERATION Le fichier ne peut être ouvert ou manipulé
• READ_ERROR Erreur système pendant une opération de lecture
• WRITE_ERROR Erreur système pendant une opération d'écriture
• INTERNAL_ERROR Erreur PL/SQL non spécifiée
• CHARSETMISMATCH Utilisation de fonctions non NCHAR après une ouverture avec FOPEN_NCHAR
• FILE_OPEN L'opération a échoué car le fichier est ouvert
• INVALID_MAXLINESIZE La taille MAXLINESIZE pour la fonction FOPEN doit être entre 1 to 32767
• INVALID_FILENAME Nom de fichier invalide
• ACCESS_DENIED Vous n'avez pas les droits d'accès au fichier
• INVALID_OFFSET Le déplacement déclaré dans la fonction FSEEK() doit être supérieur à 0 et inférieur à la
taille du fichier
• DELETE_FAILED L'opération de suppression à échoué
• RENAME_FAILED L'opération de renommage a échoué
8.4 - Exemples concrets
• Ouverture d'un fichier en lecture et écriture du contenu dans un autre
• Extraction d'une table dans un fichier
Voici le code d'une procédure qui permet d'extraire le contenu d'une table dans un fichier
Cette procédure a besoin des 3 premiers paramètres pour fonctionner
PC$Table reçoit le nom d'une table Oracle
PC$Fichier reçoit le nom du fichier de sortie
PC$Repertoire reçoit le nom du chemin (8i) ou de la directorie (9i)
PC$Separateur reçoit le caractère de séparation voulu (défaut ,)
PC$DateFMT reçoit le format des dates (défaut : DD/MM/YYYY)
PC$Where reçoit une éventuelle clause WHERE PC$Order reçoit une éventuelle clause ORDER BY
le paramètre PC$Entetes permet les actions suivantes
• positionné à O, il indique une sortie des lignes de la table avec une ligne d'entête
• positionné à I, il indique la génération des ordres INSERT pour chaque ligne
• différent de O et I, il indique une sortie des lignes de la table sans ligne d'entête
Nous allons maintenant extraire les lignes de la table EMP dans le fichier
dont voici le contenu
EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO
7369,SMITH,CLERK,7902,18/12/1980,880,,20
7499,ALLEN,SALESMAN,7698,21/02/1981,1936,300,30
7521,WARD,SALESMAN,7698,23/02/1981,1375,500,30
7566,JONES,MANAGER,7839,03/04/1981,3273,,20
7654,MARTIN,SALESMAN,7698,29/09/1981,1375,1400,30
7698,BLAKE,MANAGER,7839,02/05/1981,3135,,30
7782,CLARK,MANAGER,7839,10/06/1981,2695,,10
7788,SCOTT,ANALYST,7566,20/04/1987,3300,,20
7839,KING,PRESIDENT,,18/11/1981,5500,,10
7844,TURNER,SALESMAN,7698,09/09/1981,1650,0,30
7876,ADAMS,CLERK,7788,24/05/1987,1210,,20
7900,JAMES,CLERK,7698,04/12/1981,1045,,30
7902,FORD,ANALYST,7566,04/12/1981,3300,,20
7934,MILLER,CLERK,7782,24/01/1982,1430,,10
9991,Dupontont,CLERK,,,,,
9992,Duboudin,CLERK,,,,,
9994,Schmoll,CLERK,,,2500,,20
Maintenant, utilisons cette procédure pour générer les ordres INSERT pour les employés ayant le job CLERK dans un fichier
dont voici le contenu
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (7369,'SMITH','CLERK',7902,to_date('18/12/1980','DD/MM/YYYY'),880,NULL,20 ); | ) | VALUES |
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (7876,'ADAMS','CLERK',7788,to_date('24/05/1987','DD/MM/YYYY'),1210,NULL,20 ); | ) | VALUES |
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (7900,'JAMES','CLERK',7698,to_date('04/12/1981','DD/MM/YYYY'),1045,NULL,30 ); | ) | VALUES |
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (7934,'MILLER','CLERK',7782,to_date('24/01/1982','DD/MM/YYYY'),1430,NULL,10 ); | ) | VALUES |
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (9991,'Dupontont','CLERK',NULL,NULL,NULL,NULL,NULL ); | ) | VALUES |
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (9992,'Duboudin','CLERK',NULL,NULL,NULL,NULL,NULL ); | ) | VALUES |
INSERT INTO EMP (EMPNO,ENAME,JOB,MGR,HIREDATE,SAL,COMM,DEPTNO (9994,'Schmoll','CLERK',NULL,NULL,2500,NULL,20 ); | ) | VALUES |
9 - Le paquetage DBMS_LOB
Ce paquetage permet de manipuler les grands objets Oracle (LOB) permanents ou temporaires
Il permet la lecture et l'écriture des grands objets de type
• BLOB
• CLOB
• NCLOB
Il permet la lecture des grand objets de type
• BFILE
Une colonne de type BFILE ne stocke qu'un pointeur vers le fichier enregistré au niveau du système d'exploitation
Types utilisés pour la gestion des LOB
• BLOB LOB binaire source ou destination.
• RAW Tampon de type RAW source ou destination (utilisé avec un BLOB)
• CLOB LOB caractères source ou destination (incluant NCLOB)
• VARCHAR2 Tampon de type caractères source ou destination (utilisé avec CLOB et NCLOB)
• INTEGER Specifie la taille d'un tampon ou d'un LOB, le décalage dans un LOB, ou la quantité à lire ou écrire • BFILE Objet binaire stocké en dehors de la base constantes utilisées pour la gestion des LOB
8i,9i
• file_readonly CONSTANT BINARY_INTEGER := 0;
• lob_readonly CONSTANT BINARY_INTEGER := 0;
• lob_readwrite CONSTANT BINARY_INTEGER := 1;
• lobmaxsize CONSTANT INTEGER := 4294967295;
• call CONSTANT PLS_INTEGER := 12;
• session CONSTANT PLS_INTEGER := 10;
• warn_inconvertible_char CONSTANT INTEGER := 1;
• default_csid CONSTANT INTEGER := 0;
• default_lang_ctx CONSTANT INTEGER := 0;
• no_warning CONSTANT INTEGER := 0;
10g
• file_readonly CONSTANT BINARY_INTEGER := 0;
• lob_readonly CONSTANT BINARY_INTEGER := 0;
• lob_readwrite CONSTANT BINARY_INTEGER := 1;
• lobmaxsize CONSTANT INTEGER := 18446744073709551615;
• call CONSTANT PLS_INTEGER := 12;
• session CONSTANT PLS_INTEGER := 10;
• warn_inconvertible_char CONSTANT INTEGER := 1;
• default_csid CONSTANT INTEGER := 0;
• default_lang_ctx CONSTANT INTEGER := 0;
• no_warning CONSTANT INTEGER := 0;
En 10g, la taille maximum d'un objet LOB est égale à la valeur du paramètre d'initialisation : db_block_size multiplié par 4294967295.
Cette taille maximum peut donc être comprise entre 8 et 128 teraoctets.
En 9i, la taille maximal d'un objet LOB est de 4 gigaoctets (2**32)
Soit 4294967295 caractères pour un BLOB ou CLOB mono-octet
Ou 4294967295 / 2 = 2147483647 caractères pour un CLOB bi-octets
Les LOBs temporaires sont stockés dans le TABLESPACE temporaire et ne survivent pas à la fin de session.
9.1 - Procédures et fonctions du paquetage
9.1.1 - Procédures et fonctions des versions 8i et 9i
• Procédure APPEND
• Procédure CLOSE
• Fonction COMPARE
• Procédure COPY
• Procédure CREATETEMPORARY
• Procédure ERASE
• Procédure FILECLOSE
• Procédure FILECLOSEALL
• Fonction FILEEXISTS
• Procédure FILEGETNAME
• Fonction FILEISOPEN
• Procédure FILEOPEN
• Procédure FREETEMPORARY
• Fonction GETCHUNKSIZE
• Fonction GETLENGTH
• Fonction INSTR
• Fonction ISOPEN
• Fonction ISTEMPORARY
• Procédure LOADFROMFILE
• Procédure OPEN
• Procédure READ
• Fonction SUBSTR
• Procédure TRIM
• Procédure WRITE
• Procédure WRITEAPPEND
9.1.2 - Procédures de la version 9i
• Procédure LOADBLOBFROMFILE
• Procédure LOADCLOBFROMFILE
9.1.3 - Procédures de la version 10g
• Procédure CONVERTTOBLOB
• Procédure CONVERTTOCLOB
9.2 - Syntaxe des procédures et fonctions
9.2.1 - APPEND
Cette fonction permet d'ajouter le contenu d'un LOB à un autre
DBMS_LOB.APPEND ( dest_lob IN OUT NOCOPY BLOB, src_lob IN BLOB)
DBMS_LOB.APPEND ( dest_lob IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, src_lob IN CLOB CHARACTER SET dest_lob%CHARSET)
dest_lob représente le BLOB ou CLOB de destination src_lob représente le BLOB ou CLOB source
Exceptions générées
VALUE_ERROR Le LOB source ou destination est NULL.
9.2.2 - CLOSE
Ferme un LOB préalablement ouvert
DBMS_LOB.CLOSE ( lob_loc IN OUT NOCOPY BLOB)
DBMS_LOB.CLOSE ( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS)
DBMS_LOB.CLOSE ( file_loc IN OUT NOCOPY BFILE)
9.2.3 - COMPARE
Comparaison de tout ou partie de 2 LOBs
Les 2 LOBs doivent être de même type
Cette fonction retourne 0 si les deux objets sont identiques, sinon une valeur différente de 0
Elle retourne NULL si
• amount < 1
• amount > LOBMAXSIZE
• déplacement_1 ou déplacement_2 < 1
• déplacement_1 ou déplacement_2 > LOBMAXSIZE DBMS_LOB.COMPARE ( lob_1 IN BLOB, lob_2 IN BLOB, amount IN INTEGER := 4294967295, déplacement_1 IN INTEGER := 1, déplacement_2 IN INTEGER := 1)
RETURN INTEGER
DBMS_LOB.COMPARE ( lob_1 IN CLOB CHARACTER SET ANY_CS, lob_2 IN CLOB CHARACTER SET lob_1%CHARSET, amount IN INTEGER := 4294967295, déplacement_1 IN INTEGER := 1, déplacement_2 IN INTEGER := 1)
RETURN INTEGER
DBMS_LOB.COMPARE (
lob_1 IN BFILE, lob_2 IN BFILE, amount IN INTEGER, déplacement_1 IN INTEGER := 1, déplacement_2 IN INTEGER := 1) RETURN INTEGER
lob_1 représente le premier LOB
lob_2 représente le deuxième LOB amount représente le nombre d'octets (BLOB) ou de caractères (CLOB) à comparer déplacement_1 représente le décalage en octets ou caractères à partir du début (défaut 1 ) du premier LOB déplacement_2 représente le décalage en octets ou caractères à partir du début (défaut 1 ) du deuxième LOB
Exceptions générées
UNOPENED_FILE Le fichier n'est pas ouvert
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur le répertoire
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
INVALID_OPERATION Fichier inexistant ou privilèges insuffisants
9.2.4 - CONVERTTOBLOB
(10g) Convertion d'une source CLOB ou NCLOB en format binaire BLOB
DBMS_LOB.CONVERTTOBLOB( dest_lob IN OUT NOCOPY BLOB, scr_clob IN CLOB CHARACTER SET ANY_CS, amount IN INTEGER,
dest_offset IN OUT INTEGER, src_offset IN OUT INTEGER, blob_csid IN NUMBER, lang_context IN OUT INTEGER, warning OUT INTEGER)
dest_lob représente le BLOB de destination src_clob représente le CLOB ou NCLOB source amount représente le nombre de caractères à convertir (défaut lobmaxsize) dest_offset représente le décalage en octets ou caractères à partir du début (défaut 1 ) du BLOB destination src_offset représente le décalage en octets ou caractères à partir du début (défaut 1 ) du CLOB source blob_csid ID du jeu de caractères (défaut default_csid ) du BLOB destination lang_context représente le contexte de language (défaut default_lang_ctx ) du BLOB destination warning représente le code avertissement retourné par la fonction
Exceptions générées
VALUE_ERROR L'un des paramètres est NULL ou invalide
INVALID_ARGVAL si
• src_offset ou dest_offset < 1.
• src_offset ou dest_offset > LOBMAXSIZE.
• amount < 1.
• amount > LOBMAXSIZE
9.2.5 - CONVERTTOCLOB
(10g) Convertion d'une source binaire BLOB en format CLOB
DBMS_LOB.CONVERTTOCLOB( dest_lob IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, src_blob IN BLOB, amount IN INTEGER, dest_offset IN OUT INTEGER, src_offset IN OUT INTEGER, blob_csid IN NUMBER, lang_context IN OUT INTEGER, warning OUT INTEGER)
dest_lob représente le CLOB de destination src_clob représente le BLOB source amount représente le nombre de caractères à convertir (défaut lobmaxsize) dest_offset représente le décalage en octets ou caractères à partir du début (défaut 1 ) du BLOB destination src_offset représente le décalage en octets ou caractères à partir du début (défaut 1 ) du CLOB source blob_csid ID du jeu de caractères (défaut default_csid ) du BLOB destination lang_context représente le contexte de language (défaut default_lang_ctx ) du BLOB destination warning représente le code avertissement retourné par la fonction
Exceptions générées
VALUE_ERROR L'un des paramètres est NULL ou invalide
INVALID_ARGVAL si
• src_offset ou dest_offset < 1.
• src_offset ou dest_offset > LOBMAXSIZE.
• amount < 1.
• amount > LOBMAXSIZE
9.2.6 - COPY
Copie de tout ou partie d'un LOB dans un autre
( dest_lob IN OUT NOCOPY BLOB, src_lob IN BLOB, amount IN INTEGER, dest_déplacement IN INTEGER := 1, src_déplacement IN INTEGER := 1)
( dest_lob IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, src_lob IN CLOB CHARACTER SET dest_lob%CHARSET, amount IN INTEGER, dest_déplacement IN INTEGER := 1, src_déplacement IN INTEGER := 1)
dest_lob représente le LOB destination src_lob représente le LOB source amout représente le nombre d'octets (BLOB) ou de caractères (CLOB) que l'on souhaite copier dest_déplacement représente le déplacement par rapport au début du LOB destination src_déplacement représente le déplacement par rapport au début du LOB source
Exceptions générées
VALUE_ERROR l'un des paramètres en entrée est NULL ou invalide INVALID_ARGVAL si:
- src_déplacement ou dest_déplacement < 1
- src_déplacement ou dest_déplacement > LOBMAXSIZE
- amount < 1
- amount > LOBMAXSIZE
9.2.7 - CREATETEMPORARY
Création d'un LOB temporaire dans le TABLESPACE temporaire
DBMS_LOB.CREATETEMPORARY ( lob_loc IN OUT NOCOPY BLOB, cache IN BOOLEAN, durée IN PLS_INTEGER := 10)
DBMS_LOB.CREATETEMPORARY ( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, cache IN BOOLEAN, duree IN PLS_INTEGER := 10)
cache spécifie si le lob doit être lu en cache durée spécifie le moment ou le LOB est vidé (10 = SESSION (défaut), 12 = CALL)
9.2.8 - ERASE
Effacement de tout ou partie d'un LOB
La taille du LOB n'est pas affectée par cette fonction. La partie effacée est en fait remplacée par des CHR(0) pour les BLOB et CHR(32) pour les CLOB
DBMS_LOB.ERASE ( lob_loc IN OUT NOCOPY BLOB, amount IN OUT NOCOPY INTEGER, déplacement IN INTEGER := 1)
DBMS_LOB.ERASE ( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, amount IN OUT NOCOPY INTEGER, déplacement IN INTEGER := 1)
amout représente le nombre d'octets (BLOB) ou de caractères (CLOB) a effacer déplacement représente le déplacement par rapport au début du LOB
Exceptions générées
VALUE_ERROR L'un des paramètres est NULL INVALID_ARGVAL si:
- amount < 1 ou amount > LOBMAXSIZE
- déplacement < 1 ou déplacement > LOBMAXSIZE
9.2.9 - FILECLOSE
Fermeture d'un objet BFILE préalablement ouvert
DBMS_LOB.FILECLOSE ( file_loc IN OUT NOCOPY BFILE)
Exceptions générées
VALUE_ERROR Le paramètre en entrée file_loc est NULL
UNOPENED_FILE Le fichier n'était pas ouvert
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur le répertoire
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
INVALID_OPERATION Fichier inexistant ou privilèges insuffisants
9.2.10 - FILECLOSEALL
Fermeture de tous les objet BFILE préalablement ouvert dans la session
DBMS_LOB.FILECLOSEALL
Exceptions générées
UNOPENED_FILE Aucun fichier ouvert dans la session
9.2.11 - FILEEXISTS
Vérifie que le pointeur stocké dans le BFILE correspond à un fichier existant du système de fichiers Cette fonction retourne 1 si le fichier physique existe, sinon elle retourne 0
DBMS_LOB.FILEEXISTS ( file_loc IN BFILE) RETURN INTEGER
Exceptions générées
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur le répertoire
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
9.2.12 - FILEGETNAME
Retourne le répertoire et le nom de fichier pointé par l'objet BFILE
En aucun cas elle ne teste l'existence physique du fichier
DBMS_LOB.FILEGETNAME (
file_loc IN BFILE, repertoire OUT VARCHAR2, fichier OUT VARCHAR2)
repertoire indique le répertoire Oracle fichier indique le nom du fichier
Exceptions générées
VALUE_ERROR L'un des paramètres en entrée est NULL ou invalide INVALID_ARGVAL Le paramètre repertoire ou fichier est NULL
Voir l'exemple 3 en fin de chapitre
9.2.13 - FILEISOPEN
Vérifie si le BFILE a été ouvert
Cette fonction retourne 1 si le fichier est ouvert, sinon elle retourne 0
DBMS_LOB.FILEISOPEN (
file_loc IN BFILE)
RETURN INTEGER
Exceptions gérées
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur la Directory
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
9.2.14 - FILEOPEN
Ouverture d'un BFILE en lecture seule
DBMS_LOB.FILEOPEN ( file_loc IN OUT NOCOPY BFILE, open_mode IN BINARY_INTEGER := file_readonly)
Exceptions générées
VALUE_ERROR Le paramètre file_loc ou open_mode est NULL
INVALID_ARGVAL open_mode différent de FILE_READONLY
OPEN_TOOMANY Trop de fichiers ouverts dans la session
NOEXIST_DIRECTORY le répertoire n'existe pas
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
INVALID_OPERATION Fichier inexistant ou privilèges insuffisants
Voir les exemples 1 et 2 en fin de chapitre
9.2.15 - FREETEMPORARY
Libération d'un BLOB ou CLOB du TABLESPACE temporaire
DBMS_LOB.FREETEMPORARY ( lob_loc IN OUT NOCOPY BLOB)
DBMS_LOB.FREETEMPORARY ( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS)
Voir l'exemple 2 en fin de chapitre
9.2.16 - GETCHUNKSIZE
Retourne la place utilisée dans le chunk pour stocker le LOB
Lorsqu'une table contenant une colonne LOB est créée, l'on peut indiquer le facteur de "chunking" qui doit être un multiple d'un bloc Oracle
Cet espace (chunk) est utilisé pour accéder ou modifier la valeur du LOB. Une partie de cet espace est réservé au système, l'autre au stockage de la valeur
La valeur retournée pour un BLOB est exprimée en octets, et en caractères pour un CLOB
DBMS_LOB.GETCHUNKSIZE ( lob_loc IN BLOB)
RETURN INTEGER
DBMS_LOB.GETCHUNKSIZE ( lob_loc IN CLOB CHARACTER SET ANY_CS)
RETURN INTEGER
9.2.17 - GETLENGTH
Retourne la longueur en octets d'un BLOB et en caractères d'un CLOB et la taille du fichier physique pour un BFILE
La valeur retournée est NULL si le LOB est NULL ou si le lob_loc est NULL
DBMS_LOB.GETLENGTH ( lob_loc IN BLOB)
RETURN INTEGER
DBMS_LOB.GETLENGTH ( lob_loc IN CLOB CHARACTER SET ANY_CS)
RETURN INTEGER
DBMS_LOB.GETLENGTH (
file_loc IN BFILE)
RETURN INTEGER
9.2.18 - INSTR
Indication de la position d'un caractère ou d'une chaîne dans un LOB
DBMS_LOB.INSTR ( lob_loc IN BLOB, pattern IN RAW, déplacement IN INTEGER := 1, nth IN INTEGER := 1)
RETURN INTEGER
DBMS_LOB.INSTR ( lob_loc IN CLOB CHARACTER SET ANY_CS, pattern IN VARCHAR2 CHARACTER SET lob_loc%CHARSET, déplacement IN INTEGER := 1, nth IN INTEGER := 1)
RETURN INTEGER
DBMS_LOB.INSTR (
file_loc IN BFILE, pattern IN RAW, déplacement IN INTEGER := 1, nth IN INTEGER := 1) RETURN INTEGER
pattern représente une variable de type RAW pour les BLOB et BFILE ou une variable de type VARCHAR2 pour les CLOB déplacement représente l'octet de départ (BLOB) ou le caractère de départ (CLOB) de la recherche (défaut 1) nth représente le numéro d'occurrence à rechercher (défaut 1)
Cette fonction retourne la position du premier octet ou caractère recherché, ou retourne la valeur 0 si pattern n'est pas trouvé
Elle retourne NULL pour les conditions suivantes :
• Un ou plusieurs paramètres en entrée sont NULL ou invalides
• déplacement < 1 ou déplacement > LOBMAXSIZE
• nth < 1
• nth > LOBMAXSIZE
Exceptions générées
UNOPENED_FILE Fichier non ouvert
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur le répertoire
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
INVALID_OPERATION Fichier inexistant ou privilèges insuffisants
9.2.19 - ISOPEN
Vérification de l'état d'ouverture d'un LOB
Cette fonction retourne la valeur TRUE si le LOB est temporaire, sinon elle retourne la valeur FALSE
DBMS_LOB.ISOPEN ( lob_loc IN BLOB)
RETURN INTEGER
DBMS_LOB.ISOPEN ( lob_loc IN CLOB CHARACTER SET ANY_CS)
RETURN INTEGER
DBMS_LOB.ISOPEN (
file_loc IN BFILE)
9.2.20 - ISTEMPORARY
Vérifie si le LOB est temporaire
DBMS_LOB.ISTEMPORARY ( lob_loc IN BLOB)
RETURN INTEGER
DBMS_LOB.ISTEMPORARY ( lob_loc IN CLOB CHARACTER SET ANY_CS)
RETURN INTEGER
9.2.21 - LOADFROMFILE
Copie de tout ou partie d'un fichier externe dans un LOB
DBMS_LOB.LOADFROMFILE ( dest_lob IN OUT NOCOPY BLOB,
src_file IN BFILE, amount IN INTEGER, dest_déplacement IN INTEGER := 1, src_déplacement IN INTEGER := 1)
dest_lob représente le LOB de destination src_file représente le BFILE source amount représente le nombre d'octets à lire dest_déplacement représente le décalage d'écriture dans le LOB destinataire (défaut 1) src_déplacement représente le décalage de lecture depuis le fichier externe (défaut 1)
Exceptions générées
VALUE_ERROR L'un des paramètres en entré est NULL ou invalide INVALID_ARGVAL si:
• src_déplacement ou dest_déplacement < 1
• src_déplacement ou dest_déplacement > LOBMAXSIZE
• amount < 1
• amount > LOBMAXSIZE
9.2.22 - LOADBLOBFROMFILE
Copie de tout ou partie d'un fichier externe dans un BLOB
DBMS_LOB.LOADBLOBFROMFILE ( dest_lob IN OUT NOCOPY BLOB,
src_bfile IN BFILE, amount IN INTEGER, dest_déplacement IN OUT INTEGER, src_déplacement IN OUT INTEGER)
les valeurs pour amount, dest_déplacement et src_déplacement sont exprimées en octets
Voir les exemples 1 et 2 en fin de chapitre
9.2.23 - LOADCLOBFROMFILE
Copie de tout ou partie d'un fichier externe dans un CLOB
DBMS_LOB.LOADCLOBFROMFILE ( dest_lob IN OUT NOCOPY BLOB,
src_bfile IN BFILE, amount IN INTEGER, dest_déplacement IN OUT INTEGER, src_déplacement IN OUT INTEGER, src_csid IN NUMBER, lang_context IN OUT INTEGER, warning OUT INTEGER)
les valeurs pour amount et src_déplacement sont exprimées en octets
dest_déplacement représente le décalage en caractères d'écriture dans le CLOB src_déplacement représente le décalage en octets de lecture depuis le fichier externe src_csid représente le jeu de caractères du fichier externe lang_context représente le code de la langue warning représente l'éventuel code d'erreur
Exceptions générées
VALUE_ERROR L'un des paramètres en entrée est NULL ou invalide INVALID_ARGVAL si:
• src_déplacement ou dest_déplacement < 1
• src_déplacement ou dest_déplacement > LOBMAXSIZE
• amount < 1
• amount > LOBMAXSIZE
Voir les exemples 1 et 2 en fin de chapitre
9.2.24 - OPEN
Ouverture d'un LOB
( lob_loc IN OUT NOCOPY BLOB, mode IN BINARY_INTEGER);
( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, mode IN BINARY_INTEGER);
( file_loc IN OUT NOCOPY BFILE, mode IN BINARY_INTEGER := file_readonly);
mode représente l'une des valeurs suivantes
• file_readonly
• lob_readonly
• lob_readwrite
9.2.25 - READ
Lecture de tout ou partie d'un LOB
( lob_loc IN BLOB, amount IN OUT NOCOPY BINARY_INTEGER, déplacement IN INTEGER, tampon OUT RAW)
( lob_loc IN CLOB CHARACTER SET ANY_CS, amount IN OUT NOCOPY BINARY_INTEGER, déplacement IN INTEGER, tampon OUT VARCHAR2 CHARACTER SET lob_loc%CHARSET)
(
file_loc IN BFILE,
amount IN OUT NOCOPY BINARY_INTEGER, déplacement IN INTEGER,
tampon OUT RAW)
amount représente le nombre d'octets (BLOB) ou de caractère (CLOB) à lire déplacement représente le décalage en octets (BLOB) ou en caractères (CLOB) tampon reçoit les octets (BLOB) ou caractères (CLOB) lus
Exceptions générées
VALUE_ERROR Le ou les paramètres lob_loc, amount, ou déplacement sont NULL INVALID_ARGVAL si:
• amount < 1
• amount > MAXBUFSIZE
• déplacement < 1
• déplacement > LOBMAXSIZE
• amount supérieur, en octets ou caractères, à la capacité du tampon
NO_DATA_FOUND Détection de fin de LOB
Exceptions générées pour BFILE
UNOPENED_FILE Fichier non ouvert
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur le répertoire
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
INVALID_OPERATION Fichier inexistant ou privilèges insuffisants
9.2.26 - SUBSTR
Extraction d'une partie d'un LOB
DBMS_LOB.SUBSTR ( lob_loc IN BLOB, amount IN INTEGER := 32767, déplacement IN INTEGER := 1)
RETURN RAW
DBMS_LOB.SUBSTR ( lob_loc IN CLOB CHARACTER SET ANY_CS, amount IN INTEGER := 32767, déplacement IN INTEGER := 1)
RETURN VARCHAR2 CHARACTER SET lob_loc%CHARSET
DBMS_LOB.SUBSTR (
file_loc IN BFILE, amount IN INTEGER := 32767, déplacement IN INTEGER := 1) RETURN RAW
amount représente le nombre d'octets (BLOB) ou de caractères (CLOB) à lire déplacement représente le décalage en octets (BLOB) ou en caractères (CLOB) depuis le début du LOB
Les valeurs retournées sont
RAW pour les BLOB ou BFILE
VARCHAR2 pour les CLOB
NULL si:
• Un paramètre en entrée est NULL
• amount < 1
• amount > 32767
• déplacement < 1
• déplacement > LOBMAXSIZE
Exceptions générées
UNOPENED_FILE Fichier non ouvert
NOEXIST_DIRECTORY le répertoire n'existe pas
NOPRIV_DIRECTORY Privilèges insuffisants sur le répertoire
INVALID_DIRECTORY le répertoire a été invalidé après l'ouverture du fichier
INVALID_OPERATION Fichier inexistant ou privilèges insuffisants
9.2.27 - TRIM
Réduction de la taille d'un LOB
( lob_loc IN OUT NOCOPY BLOB, newlen IN INTEGER) ( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, newlen IN INTEGER)
newlen représente la taille finale désirée exprimée en octets (BLOB) ou en caractères (CLOB)
Exceptions générées
VALUE_ERROR Le paramètre lob_loc est NULL INVALID_ARGVAL si:
• new_len < 0
• new_len > LOBMAXSIZE
9.2.28 - WRITE
Ecriture dans un LOB
DBMS_LOB.WRITE ( lob_loc IN OUT NOCOPY BLOB, amount IN BINARY_INTEGER, déplacement IN INTEGER, tampon IN RAW)
DBMS_LOB.WRITE (
lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, amount IN BINARY_INTEGER, déplacement IN INTEGER, tampon IN VARCHAR2 CHARACTER SET lob_loc%CHARSET)
amount représente le nombre d'octets (BLOB) ou de caractères (CLOB) à écrire déplacement représente le décalage en octets (BLOB) ou en caractères (CLOB) depuis le début du LOB tampon représente la variable contenant les données à écrire
Exceptions générées
VALUE_ERROR L'un des paramètres en entrée lob_loc, amount, ou déplacement sont NULL, hors plage, ou
invalides
INVALID_ARGVAL si:
• amount < 1
• amount > MAXBUFSIZE
• déplacement < 1
• déplacement > LOBMAXSIZE
9.2.29 - WRITEAPPEND
Ajout de données à la fin d'un LOB
DBMS_LOB.WRITEAPPEND (
lob_loc IN OUT NOCOPY BLOB, amount IN BINARY_INTEGER, tampon IN RAW)
DBMS_LOB.WRITEAPPEND ( lob_loc IN OUT NOCOPY CLOB CHARACTER SET ANY_CS, amount IN BINARY_INTEGER, tampon IN VARCHAR2 CHARACTER SET lob_loc%CHARSET)
amount représente le nombre d'octets (BLOB) ou de caractères (CLOB) à écrire tampon représente la variable contenant les données à écrire
Exceptions générés
VALUE_ERROR L'un des paramètres en entrée lob_loc, amount, ou déplacement sont NULL, hors plage, ou
invalides
INVALID_ARGVAL si:
• amount < 1
• amount > MAXBUFSIZE
9.3 - Exceptions générées par le paquetage
• invalid_argval 21560 Argument NULL invalide ou hors plage d'utilisation
• access_error 22925 Tentative d'écriture de trop de données dans le LOB. La taille maxi est limitée à 4 gigabytes
• noexist_directory 22285 Le répertoire désigné n'existe pas
• nopriv_directory 22286 Privilèges insuffisants sur le répertoire ou sur le fichier
• invalid_directory 22287 Le répertoire spécifié n'est pas valide ou a été modifiée par le DBA en cours
d'utilisation
• operation_failed 22288 L'opération demandée sur le fichier a échoué
• unopened_file 22289 Tentative d'opération sur un fichier non ouvert
• open_toomany 22290 Le nombre maximum de fichiers ouverts est atteint
9.4 - Exemples
• Exemple 1
Voici une procédure permettant de charger en table diverses colonnes LOB
Description de la table
La colonne ID stocke le numéro unique du document
La colonne TYP stocke le type du document
La colonne UTILISE stocke l'utilisateur qui modifie le document
La colonne LOB_TEXTE stocke un texte long
La colonne LOB_DATA stocke une image
La colonne LOB_FICHIER stocke un pointeur vers le fichier natif externe
Ainsi que les fichiers externes suivants
La procédure Insert_document() permet d'insérer une ligne dans la table et d'alimenter les colonnes LOB
Insérons une ligne dans la table
Dans cet exemple, nous initialisons les variables LOB par un select en table, qui implique que l'enregistrement existe, d'où l'instruction d'insertion en début de procédure
Nous pourrions tout aussi bien n'effectuer l'insertion en table qu'en fin de chargement des colonnes LOB
Dans ce cas, les variables LOB doivent avoir été préalablement initialisées avec la fonction CREATETEMPORARY comme dans l'exemple suivant
• Exemple 2
• Exemple 3
Utilisation de la procédure FILEGETNAME pour afficher la directorie et le nom du fichier pointés par la colonne BFILE
9.5 - Manipulations courantes des LOB de type caractères (CLOB)
La plupart des manipulations courantes sur les objets CLOB peuvent être effectuées avec les fonctions
SQL
LENGTH
SUBSTR
INSTR
UPPER
LIKE
Complément d'information
Vous pouvez également consulter l'article Les LOB par Helyos
Index de recherche
Liste alphabétique des mots clé
A
%ISOPEN
%FOUND
%NOTFOUND
%ROWCOUNT
%ROWTYPE
%TYPE
ABS
ACOS
ADD_MONTHS
AFTER
ALL_TRIGGERS
ALTER_FUNCTION
ALTER PACKAGE
ALTER TRIGGER
APPEND (DBMS_LOB)
ATAN
AUTONOMOUS_TRANSACTION
B
BEFORE
BEGIN
BFILE
BINARY_INTEGER
BIN_TO_NUM
BITAND
BLOB
BODY
BOOLEAN
BULK COLLECT
C
CASE
CEIL
CHAR
CHARTOROWID
CLOB
CLOSE
CLOSE (DBMS_LOB)
COMPARE (DBMS_LOB)
CONVERTTOBLOB (DBMS_LOB)
CONVERTTOCLOB (DBMS_LOB)
COMMIT
CONCAT
CONSTANT
CONVERT
COPY (DBMS_LOB)
COS
COSH
COUNT
.COUNT
CREATE FUNCTION
CREATE PACKAGE
CREATE PROCEDURE
CREATE TRIGGER
CREATE VIEW
CREATETEMPORARY (DBMS_LOB)
CURSOR
D
DATE
DBMS_LOB
DBMS_OUTPUT
DECLARE
DECODE
DEFAULT
DELETE
DISABLE
DISABLE (DBMS_OUTPUT)
DROP FUNCTION
DROP PACKAGE
DROP PROCEDURE
DROP TRIGGER
DUMP
E
ELSE
ELSIF
EMPTY_BLOB
EMPTY_CLOB
ENABLE
ENABLE (DBMS_OUTPUT)
END
ERASE (DBMS_LOB)
EXCEPTION
EXCEPTION_INIT
EXECUTE IMMEDIATE
.EXISTS
EXIT
EXP
.EXTEND
EXTRACT
F
FCLOSE
FCLOSE_ALL FETCH FFLUSH
FGETATTR
FGETPOS
FILECLOSE (DBMS_LOB)
FILECLOSEALL (DBMS_LOB)
FILEEXISTS (DBMS_LOB)
FILEGETNAME (DBMS_LOB)
FILEISOPEN (DBMS_LOB)
FILEOPEN (DBMS_LOB)
.FIRST
FLOOR
FOPEN
FOPEN_NCHAR
FOR (boucle)
FOR (curseur)
FOR EACH ROW
FORALL
FREETEMPORARY (DBMS_LOB)
FREMOVE
FRENAME
FSEEK
G
GETCHUNKSIZE (DBMS_LOB)
GETLENGTH (DBMS_LOB) GET_LINE (UTL_FILE)
GET_LINE (DBMS_OUTPUT)
GET_LINES (DBMS_OUTPUT)
GET_LINE_NCHAR
GET_RAW
GOTO
GREATEST
H
HEXTORAW
I
IF
IN
INITCAP
INSERT
INSTEAD OF
INSTR
INSTR (DBMS_LOB)
Intervalles
INTERVAL DAY TO SECOND
INTERVAL YEAR TO MONTH
IS_OPEN
ISOPEN (DBMS_LOB)
ISTEMPORARY (DBMS_LOB) L
.LAST
LAST_DAY
LEAST
LENGTH
LIMIT
LN
LOADFROMFILE
LOADBLOBFROMFILE
LOADCLOBFROMFILE
LONG
LONG RAW
LOOP
LOWER
LPAD
LTRIM
M
MAX
MIN
MOD
MONTHS_BETWEEN
N
NCHAR
NCLOB
NEW_LINE (UTL_FILE)
NEW_LINE (DBMS_OUTPUT)
NEW_TIME
.NEXT
NUMTODSINTERVAL
NUMTOYMINTERVAL
NVARCHAR2
O
OPEN
OPEN (DBMS_LOB)
OPEN FOR
OTHERS
P
PIPELINED
PLS_INTEGER
POWER
PUT (UTL_FILE)
PUT (DBMS_OUTPUT)
PUT_NCHAR PUT_RAW PUTF PUT_LINE (DBMS_OUTPUT)
PUT_LINE (UTL_FILE)
PUT_LINE_NCHAR (UTL_FILE)
PUTF
PUTF_NCHAR (UTL_FILE)
R
RAISE
RAW
ROWTOHEX
READ (DBMS_LOB)
REPLACE
RETURN
RETURNING INTO
REVERSE
ROLLBACK
ROUND
ROWIDTOCHAR
RPAD
RTRIM
S
SAVEPOINT
SELECT INTO SIGN
SIN
SINH
SQLCODE
SQLERRM
SQRT
SUBSTR
SUBSTR (DBMS_LOB)
SUBTYPE
SUM
SYS.ANYTYPE
SYS.ANYDATA
SYS.ANYDATASET
SYS_EXTRACT_UTC
T
TAN
TANH
THEN
TIMESTAMP
TO SAVEPOINT
TO_CHAR
TO_CLOB
TO_DATE
TO_DSINTERVAL
TO_MULTI_BYTE TO_NUMBER
TO_SINGLE_BYTE
TO_TIMESTAMP
TO_YMINTERVAL
TRANSLATE
TRIM
TRIM (DBMS_LOB)
TRUNC
U
UPDATE
UPPER
USING
UTL_FILE
V
VARCHAR2
VSIZE
W
WHEN
WHILE
WRITE (DBMS_LOB)
WRITEAPPEND (DBMS_LOB)
Remerciements
Chaleureux remerciements à , l'équipe SGBD en général et Pomalaix en particulier.