Commentaires en SQL

Il peut être intéressant d’insérer des commentaires dans les requêtes SQL pour mieux s’y retrouver lorsqu’il y a de grosses requêtes complexes. Il y a plusieurs façon de faire des commentaires dans le langage SQL, qui dépendent notamment du Système de Gestion de Base de Données utilisées (SGBD) et de sa version.

Commentaire double tiret : —

Le double tiret permet de faire un commentaire jusqu’à la fin de la ligne.

Exemple :

SELECT *    -- tout sélectionner
FROM table1 -- dans la table "table1"

Compatibilité :

  • Depuis la version 3.23.3 de MySQL
  • PostgreSQL
  • Oracle
  • SQLite

Commentaire dièse : #

Le symbole dièse permet de faire un commentaire jusqu’à la fin de la ligne.

Exemple :

SELECT *    # tout sélectionner
FROM table1 # dans la table "table1"

Compatibilité :

  • MySQL

Commentaire multi-ligne : /* et */

Le commentaire multi-ligne à l’avantage de pouvoir indiquer où commence et où se termine le commentaire. Il est donc possible de l’utiliser en plein milieu d’une requête SQL sans problème.


Exemple :

SELECT *    /* tout sélectionner */
FROM table1 /* dans la table "table1" */
WHERE 1 = /* exemple en milieu de requete */ 1

Compatibilité :

  • MySQL
  • PostgreSQL
  • Oracle
  • SQL Server
  • SQLite

Bug potentiel pour les commentaires sur une ligne

Attention, dans certains contextes, si vous utilisez un système qui va supprimer les retours à la ligne, votre requête sera uniquement sur une ligne. Dans une telle situation, un commentaire effectué avec « — » dans une requête peut donc créer un bug.

Requête SQL sur plusieurs lignes :

SELECT *    -- tout sélectionner
FROM table1 -- dans la table "table1"

Même requête SQL sur une ligne :

SELECT * -- tout sélectionner FROM table1 -- dans la table "table1"

En conséquent il faut se méfier de librairies externes qui peuvent ré-écrire les requêtes SQL ou alors tout simplement se méfier de copier/coller.

Partager