XMLCOMMENT

Syntaxe

Paramètres

Description

Cette fonction permet de produire un commentaire XML utilisé par l'expression spécifié.

Remarques

• La fonction XMLCOMMENT est utile lorsqu'on souhaite inclure des informations descriptives ou des annotations dans un document XML sans que celles-ci soient interprétées comme des données XML valides. Cela permet d'ajouter des explications ou des métadonnées destinées uniquement à la lecture humaine ou à l'analyse technique.
• L'élément produit par XMLCOMMENT suit la syntaxe standard des commentaires XML, c'est-à-dire qu'il est encadré par <!-- et -->. Ce format est conforme aux spécifications XML et garantit la compatibilité avec les analyseurs XML conformes à la norme W3C.
• XMLCOMMENT prend un seul paramètre, expression, qui détermine le texte du commentaire. Ce texte n'est pas interprété comme du XML, ce qui permet d'inclure des caractères étant normalement réservés ou nécessiteraient un échappement.
• Si l'expression fournie à XMLCOMMENT est NULL, la fonction retourne NULL plutôt qu'un commentaire vide. Cela évite d'introduire dans le document XML des commentaires sans contenu, qui peuvent être inutiles ou indésirables.
• L'utilisation de XMLCOMMENT est particulièrement pertinente lors de la génération dynamique de documents XML dans SQL, par exemple pour ajouter des indications sur la provenance des données ou sur la date de génération du fichier.
• La fonction ne modifie pas l'ordre des éléments dans le flux XML généré : le commentaire est inséré à l'endroit exact où il est appelé dans la requête, ce qui permet un contrôle précis sur la position de l'annotation.
• XMLCOMMENT ne peut pas contenir la séquence -- dans le texte du commentaire, conformément à la spécification XML, car cela provoquerait une erreur de syntaxe. Il faut donc filtrer ou remplacer cette séquence avant de l'insérer.
• Dans un contexte Oracle SQL, XMLCOMMENT peut être combinée avec d'autres fonctions XML, comme XMLELEMENT ou XMLFOREST, pour produire un document plus riche comprenant à la fois des données et des annotations.
• L'ajout de commentaires via XMLCOMMENT ne change pas la structure logique du document XML ni sa validation contre un schéma XSD ou DTD, puisque les commentaires sont ignorés par les moteurs de validation.
• Cette fonction est disponible depuis Oracle 9i Release 2 (version 9.2), ce qui la rend compatible avec une large base installée, mais elle est surtout utile dans les projets où l'export XML est conçu pour être consulté ou audité manuellement.
• L'un des avantages de XMLCOMMENT est de pouvoir intégrer des notes internes dans un fichier XML produit automatiquement, par exemple pour indiquer la version du script SQL, l'environnement d'exécution ou l'identité de l'utilisateur qui a généré le fichier.
• Bien que les commentaires produits par XMLCOMMENT soient invisibles pour les traitements XML automatisés, il est conseillé de ne pas y mettre d'informations confidentielles, car elles restent visibles dans le document final si celui-ci est ouvert en texte brut.

Voir également

Langage de programmation - XML (eXtensible Markup Language) - Accueil
Article - Les géants de l'informatique - Oracle