Поделиться через

Пользовательский формат SQL-запросов

  • Статья

Это важно

Эта функция доступна в общедоступной предварительной версии.

В этой статье объясняется, как настроить параметры автоматического форматирования SQL в пользовательском интерфейсе Azure Databricks.

Обзор

Форматирование SQL повышает удобство чтения и удобство обслуживания запросов. Стандартизируя отступы, регистр ключевых слов и другие стилистические настройки, хорошо отформатированный запрос проще понять, отладить и поделиться с командой.

В Azure Databricks можно настроить параметры форматирования с помощью файла, сохраненного .dbsql-formatter-config.json в домашнем каталоге рабочей области. После сохранения файла код SQL автоматически форматируется на основе настроек при запуске или форматировании кода в редакторе или записной книжке SQL.

Настройка параметров форматирования SQL

Чтобы настроить параметры форматирования личных данных SQL, выполните следующие действия.

  1. Щелкните значок рабочей областиРабочая область на боковой панели.
  2. Нажмите кнопку "Создать > файл".
  3. Назовите файл .dbsql-formatter-config.json.
  4. Добавьте нужные параметры в виде пар "ключ-значение" в формате JSON. См. параметры форматирования
  5. Чтобы применить последние параметры форматирования, обновите страницу.

Пример файла конфигурации

В следующем примере показана допустимая .dbsql-formatter-config.json конфигурация.

{
  "printWidth": 80,
  "indentationStyle": "spaces",
  "indentationWidth": 4,
  "keywordCasing": "uppercase",
  "shouldExpandExpressions": true
}

Параметры форматирования

В следующей таблице перечислены поддерживаемые параметры конфигурации.

Вариант Имя файла конфигурации Допустимые значения По умолчанию Описание
Ширина печати printWidth Любое целое число >= 0 100 Задает ширину целевой строки для отформатированного кода.
Стиль отступов indentationStyle 'spaces', 'tabs' 'spaces' Указывает, следует ли использовать пробелы или вкладки для отступа. Если задано, indentationWidth игнорируется.
Ширина отступа indentationWidth Целое число от 0 до 99 2 Количество пробелов, используемых, когда indentationStyle установлено в 'spaces'.
Регистр ключевых слов keywordCasing 'uppercase', 'lowercase', 'none' 'none' Управляет форматированием ключевых слов SQL. 'none' оставляет регистр без изменений.
Регистр имени функции functionNameCasing 'uppercase', 'lowercase', 'none' 'none' Управляет форматированием имен функций SQL. 'none' оставляет регистр без изменений.
Размещение запятых commaPosition 'beginning', 'end' 'end' Управляет размещением запятых в списках.
Разрывы строк между инструкциями numNewLinesBetweenStatements Целое число от 0 до 99 1 Количество новых строк, вставленных между операторами.
Разрывы строк между предложениями numNewLinesBetweenClauses Целое число от 0 до 99 0 Количество новых строк, вставленных между предложениями в операторе.
Раскройте логические выражения shouldExpandExpressions true, false true Переносит логические выражения на отдельные строки.
Развертывание инструкций CASE shouldExpandCaseStatements true, false true Развертывает каждое предложение в инструкции CASE на собственную строку.
Расширить списки IN shouldExpandInStatements true, false false Выводит элементы списков IN на отдельные строки.
Расширение условий между shouldExpandBetweenConditions true, false false Расширяет условия МЕЖДУ отдельными строками.
Условия останова JOIN shouldBreakOnJoinSections true, false true Разбивает JOIN условия на отдельные линии.