Добавление комментариев в инструкции SQL
Область применения: Databricks SQL Databricks Runtime
Примечания полезны для документирования кода SQL и временного отключения кода SQL.
Вы можете добавлять комментарии в код SQL до, после и в инструкциях. Комментарии игнорируются Azure Databricks, если они не распознаются как подсказки.
Поддерживаются следующие формы комментариев:
Простые комментарии
Простые примечания используются для покрытия всей строки текста или оставшейся части строки текста, начиная с --
Синтаксис
-- text
Параметры
-
text
: любой текст, за исключением символа конца строки (EOL), например\n
.
Примеры
> -- 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
Примечания с квадратными скобками
Примечания с квадратными скобками используются для покрытия нескольких строк текста или части строки текста.
Синтаксис
bracketed_comment
/* text [ bracketed_comment [...] ] text */
Параметры
-
text
: любой текст, включая символы конца строки (EOL), исключенные/*
и*/
.
Примеры
> /* 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 */