SQL comments - MaxCompute - Centre de documentation Alibaba Cloud

Les commentaires SQL dans MaxCompute améliorent la lisibilité du code en annotant la logique directement dans le script. Cette rubrique décrit comment rédiger des commentaires sur une seule ligne et des commentaires multilignes dans les scripts SQL MaxCompute.

Limites

Les commentaires multilignes ne sont pas disponibles dans l'interface de développement de données DataWorks.
Pour utiliser les commentaires SQL dans le client local MaxCompute (odpscmd), vous devez disposer de la version 0.49.0 ou ultérieure d'odpscmd.
Dans le client MaxCompute (odpscmd) et Cloud Shell (odpscmd), un point-virgule (;) est requis pour terminer un commentaire sur une seule ligne. Les points-virgules ne sont pas pris en charge dans les commentaires multilignes.

Syntaxe

Commentaires sur une seule ligne

Commencez un commentaire sur une seule ligne par --. Tout ce qui suit -- jusqu'à la fin de la ligne est considéré comme un commentaire.

-- Comment content

Placez le commentaire sur sa propre ligne au-dessus du code, ou à la fin d'une ligne de code.

Remarque

Dans l'interface d'analyse SQL de la console MaxCompute ou dans l'interface de développement de données DataWorks, utilisez Ctrl+/ pour mettre une ligne de code en commentaire.

Commentaires multilignes

Utilisez /* pour ouvrir et */ pour fermer un commentaire multiligne. Cela permet de mettre en commentaire un bloc de contenu en une seule fois.

/*
Comment
content
*/

Important

MaxCompute prend également en charge /*+...*/ comme syntaxe Hint — par exemple, les hints MAPJOIN et les HINTS SKEWJOIN. Les hints ont priorité sur les commentaires multilignes. Pour éviter toute ambiguïté, utilisez /** au lieu de /* comme symbole d'ouverture pour les commentaires multilignes.

Exemples

Les exemples suivants utilisent my_table en tant que table existante.

Commentaire sur une seule ligne

L'exemple suivant montre un commentaire sur une seule ligne placé au-dessus d'une instruction et à la fin d'une ligne :

-- Single-line comment
DESC my_table; -- Single-line comment

Commentaire multiligne

L'exemple suivant montre un commentaire multiligne intégré dans une instruction SELECT :

SELECT /* Valid
multi-line
comment
*/ * FROM my_table;

Erreur courante : `/*+` interprété à tort comme un Hint

Ouvrir un commentaire multiligne avec /*+ amène MaxCompute à l'interpréter comme le début d'un Hint plutôt que comme un commentaire :

SELECT /*+ Invalid
multi-line
comment
*/ * FROM my_table;

Pour éviter cela, utilisez /** comme symbole d'ouverture pour les commentaires multilignes.