Como adicionar comentários a instruções SQL

  • Artigo

Aplica-se a: marca de seleção positiva SQL do Databricks verificação marcada como sim Runtime do Databricks

Os comentários são úteis para documentar o código SQL e para desabilitar temporariamente o código SQL.

Você pode adicionar comentários ao código SQL antes, após e dentro das instruções. Os comentários são ignorados pelo Azure Databricks, a menos que sejam reconhecidos como dicas.

Há suporte para os seguintes formatos de comentários:

Comentários simples

Comentários simples são usados para cobrir uma linha inteira de texto ou o restante de uma linha de texto começando com --

Sintaxe

-- text

Parâmetros

  • text: qualquer texto que exclua um caractere de EOL (fim de linha), como \n.

Exemplos

> -- This is a comment

> SELECT 1; -- This is also a comment
  1

> SELECT -- This is a comment
 1;
  1

> SELECT -- Comments are not limited to Latin characters: 评论 😊
 1;
  1

> SELECT '-- This is not a comment';
  -- This is not a comment

> SELECT -- This is a bad comment because the "one" should be on the next line... 1
 Syntax error

> SELECT -- this is a bad
comment because it contains an EOL character
  1;
 Syntax error

Comentários entre colchetes

Os comentários entre colchetes são usados para cobrir várias linhas de texto ou uma parte de uma linha de texto.

Sintaxe

bracketed_comment
  /* text [ bracketed_comment [...] ] text */

Parâmetros

  • text: qualquer texto que inclua caracteres de EOL (fim de linha), excluindo /* e */.

Exemplos

> /* This is a comment */

> SELECT 1; /* This is also a comment */

> SELECT /* This is a comment
  that spans multiple lines */ 1;

> SELECT /* Comments are not limited to Latin characters: 评论 😊 */ 1;

> SELECT /* Comments /* can be */ nested */ 1;

> SELECT /* Quotes in '/*' comments "/*" are not special */ */ */ 1;

> /* A prefixed comment */ SELECT 1;

> SELECT '/* This is not a comment */';
  /* This is not a comment */