Comentários SQL - MaxCompute: Central de Documentação do Alibaba Cloud

Os comentários SQL no MaxCompute melhoram a legibilidade do código ao anotar a lógica diretamente nas linhas. Este tópico descreve como escrever comentários de linha única e de múltiplas linhas em scripts SQL do MaxCompute.

Limitações

A interface de desenvolvimento de dados do DataWorks não oferece suporte a comentários de múltiplas linhas.
Para usar comentários SQL no cliente local do MaxCompute (odpscmd), utilize a versão 0.49.0 ou superior do odpscmd.
No cliente MaxCompute (odpscmd) e no Cloud Shell (odpscmd), o ponto e vírgula (;) é obrigatório para encerrar um comentário de linha única. Comentários de múltiplas linhas não aceitam ponto e vírgula.

Sintaxe

Comentários de linha única

Inicie um comentário de linha única com --. Todo o conteúdo após -- até o final da linha é tratado como comentário.

-- Comment content

Posicione o comentário em uma linha própria acima do código ou ao final de uma linha de código.

Nota

Na interface de análise SQL do console do MaxCompute ou na interface de desenvolvimento de dados do DataWorks, selecione Ctrl+/ para comentar uma linha de código.

Comentários de múltiplas linhas

Use /* para abrir e */ para fechar um comentário de múltiplas linhas. Isso permite comentar um bloco inteiro de conteúdo de uma só vez.

/*
Comment
content
*/

Importante

O MaxCompute também aceita /*+...*/ como sintaxe de Hint — por exemplo, hints MAPJOIN e SKEWJOIN HINT. Os Hints têm precedência sobre os comentários de múltiplas linhas. Para evitar ambiguidades, use /** em vez de /* como símbolo de abertura para comentários de múltiplas linhas.

Exemplos

Os exemplos abaixo usam my_table como tabela existente.

Comentário de linha única

O exemplo a seguir mostra um comentário de linha única posicionado acima de uma instrução e ao final de uma linha:

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

Comentário de múltiplas linhas

O exemplo a seguir apresenta um comentário de múltiplas linhas inserido em uma instrução SELECT:

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

Erro comum: `/*+` interpretado incorretamente como Hint

Abrir um comentário de múltiplas linhas com /*+ faz o MaxCompute interpretar o trecho como início de um Hint, e não como comentário:

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

Para evitar esse problema, use /** como símbolo de abertura para comentários de múltiplas linhas.