Форматировщик SQL
функциональныйПриведите запрос в порядок, не меняя его смысла. Форматировщик аккуратен по замыслу.
Форматтер настраиваемый, но намеренно осторожный. SQLly повторно разбивает свой вывод на лексемы и сравнивает его токен за токеном с вводом; при малейшем несовпадении ваш SQL остаётся нетронутым. Он умеет выправлять отступы, менять регистр ключевых слов и выравнивать предложения, не рискуя комментариями и литералами.
Форматировать SQL
Нажмите ⌥⇧F (Alt+Shift+F на Windows и Linux), выберите Редактировать › Форматировать документ, или клик правой кнопкой мыши › Форматировать документ чтобы отформатировать весь запрос, что бы ни было выделено. Чтобы отформатировать только выделение, нажмите ⌘K ⌘F (Ctrl+K Ctrl+F) для Форматировать выделенное. Оба ярлыка можно изменить в Настройки › Рабочее пространство › Сочетания клавиш. Вы также можете выбрать Запрос › Форматировать SQL, использовать кнопку на панели инструментов или выполнить из палитры команд: если выделен текст, форматируется только выделение. В противном случае форматируется весь запрос. Вот однострочный запрос с настройками по умолчанию:
-- before select o.OrderId, c.Name, sum(l.Qty * l.Price) as total from dbo.Orders o join dbo.Customers c on c.Id = o.CustomerId left join dbo.OrderLines l on l.OrderId = o.OrderId where o.Status = 'open' and o.Total > 100 group by o.OrderId, c.Name order by total desc -- after SELECT o.OrderId, c.Name, SUM(l.Qty * l.Price) AS total FROM dbo.Orders o JOIN dbo.Customers c ON c.Id = o.CustomerId LEFT JOIN dbo.OrderLines l ON l.OrderId = o.OrderId WHERE o.Status = 'open' AND o.Total > 100 GROUP BY o.OrderId, c.Name ORDER BY total DESC
Ключевые слова и функции пишутся заглавными буквами, каждая основная часть начинается с новой строки, списки SELECT располагаются один столбец на строку, таблицы после FROM (с их
JOIN) и условия после WHERE и HAVING
размещаются на отдельных строках с отступом, и AND/OR стоят в начале своих строк. Один оператор, умещающийся в 80 символов, остаётся на одной строке:
SELECT id, name FROM dbo.Users WHERE id = 1. Отступы следуют настройкам табуляции вашего редактора, если вы не выберете другое.


Форматирование на ходу
Этот Форматирование на ходу переключатель вверху Настройки › Редактор › Форматирование форматирует по мере ввода. Когда он включён, нажатие Enter переформатирует набираемый вами оператор, и курсор остаётся сразу после того же символа, что и раньше, так что вы продолжаете печатать с того же места. По умолчанию выключено; в этом случае форматируйте по требованию через Форматировать документ (⌥⇧F на macOS, Alt+Shift+F на Windows и Linux, можно переназначить через Настройки › Рабочее пространство › Сочетания клавиш).
Нажатие Enter оставляет текст без изменений, когда:
- выделен текст, или вы редактируете с несколькими курсорами;
- вкладка находится на подключении Redis, редактор которого содержит команды, а не SQL;
- оператор не начинается с ключевого слова оператора:
SELECT,INSERT,UPDATE,DELETE,WITH,CREATE,ALTER,DROP,MERGE,TRUNCATE,GRANT,REVOKE,BEGIN,DECLARE, илиEXEC.
Скрипты и пакеты GO
Скрипт с несколькими операторами форматируется по одному оператору за раз, каждый с новой строки, а однострочное сочетание клавиш применяется, только когда весь текст — один оператор. Операторы заканчиваются на ; а для SQL Server — на
GO разделителе пакетов. GO всегда занимает отдельную строку и пишется в том же регистре, что и ваши другие ключевые слова, вместе со счётчиком повторов (GO 5) или комментарием, который находится на той же строке:
-- before select 1 go select name from dbo.Users go -- after SELECT 1 GO SELECT name FROM dbo.Users GO
GO считается разделителем, только когда начинает строку, в которой нет ничего, кроме необязательного счётчика или комментария, и стоит между инструкциями, как
sqlcmd и SSMS. Столбец с именем
go в середине списка SELECT, [go], и
go внутри строки или комментария остаются обычным SQL. Когда у диалекта стоит «Автоопределение», GO строка помечает скрипт как SQL Server. Если диалектом выбран другой движок, GO не является разделителем.
Настройки
Всё в разделе Настройки › Редактор › Форматирование, который имеет живой предварительный просмотр: вставьте свой собственный SQL и наблюдайте за изменениями по мере настройки параметров. Самый быстрый старт — это предустановка:
| Предустановка | Стиль |
|---|---|
| По умолчанию | Показанный выше макет. |
| Компактный | Короткие конструкции и списки выборки остаются на одной строке, и AND/OR следуют за своими строками. |
| Развёрнутый | Ведущие запятые, пустая строка перед основными конструкциями, ON на своей строке, а также выравненные операторы, типы данных и псевдонимы. |
| Ключевые слова заглавными / Ключевые слова со строчными буквами | Макет по умолчанию с ключевыми словами и функциями в этом регистре. |
| Сохранять существующее | Сохраняет ваш регистр, запятые и порядок частей запроса, а остальное приводит в порядок. |
Выбор предустановки переписывает все настройки макета, но сохраняет ваши триггеры формата (Форматирование на ходу, Форматировать при сохранении, и Форматировать при вставке), поэтому выбор другой предустановки больше их не отключает. Последующее изменение любой отдельной настройки переключает её в Пользовательский. Отдельные разделы описывают регистр ключевых слов (общий или по группам — например, типы данных или JOIN), регистр и экранирование идентификаторов, расположение предложений, списки SELECT, стиль запятых, логические условия, CASE, операторы, JOIN, функции, подзапросы и CTE, DML, DDL, комментарии, отступы, длину строки (по умолчанию 120) и инструкции. Настройка Диалект SQL по умолчанию — Автоопределение, которое выводит диалект из самого текста SQL.
Форматировать при сохранении и Форматировать при вставке находятся под Форматировать триггеры. По умолчанию оба отключены.
Размещение FROM и WHERE
Два параметра в разделе Макет предложений можно выбрать, начинается ли тело предложения на строке с ключевым словом или на отдельной строке ниже, с отступом:
| Опция | Что оно делает |
|---|---|
| Таблица после FROM | Новая строка, с отступом (по умолчанию) помещает первую таблицу на отдельную строку ниже FROM, и выстилает его JOIN-ы по ней; ON на своей собственной строке сдвигается на один шаг дальше. Та же строка, что и ключевое слово держит таблицу на FROM линия, с JOINразмещены рядом с Макет JOIN настройка. |
| Первое условие после WHERE / HAVING | Новая строка, с отступом (по умолчанию) помещает первое условие на отдельную строку под WHERE или HAVING, на одной вертикали со строками AND/OR следующими строками. Та же строка, что и ключевое слово оставляет его на строке с ключевым словом. |
Этот Компактный и Сохранять существующее предустановки оставляют оба на строке с ключевым словом. Комментарий, написанный сразу после FROM или WHERE остается на этой строке.
CTE, DML и столбцы индекса
Эти параметры управляют тем, как компонуются типовые формы операторов:
| Опция | Что оно делает |
|---|---|
| Стиль CTE | Стопка (по умолчанию) помещает тело каждого CTE на отдельные строки. Встроенный для каждого CTE помещает name AS ( … ) на одной строке. CTE с -- комментарием, или которая оказалась бы длиннее максимальной длины строки, остаётся многострочной. |
| Стиль DML | Стандарт (по умолчанию) — обычная раскладка. Компактный ставит INSERT, UPDATE, DELETE, или MERGE на одной строке, если это помещается в максимальную длину строки. Развёрнутый ставит каждый INSERT столбец, каждый VALUES элемент, и каждый UPDATE SET присваивание на отдельной строке, и оно никогда не схлопывается Держать короткие запросы в одной строке. |
| Многострочные столбцы индекса | Когда индекс имеет более одного столбца, каждый ключевой столбец и каждый INCLUDE столбец CREATE INDEX идёт на своей строке. То же самое применяется к PRIMARY KEY, UNIQUE, INDEX, и KEY спискам столбцов внутри CREATE TABLE. FOREIGN KEY списки столбцов оставляются как есть. |
| Переносить концевые комментарии вместе с выражением | Работает вместе с Встроенные комментарии остаются на месте. Если оба включены, символ конца строки -- comment остаётся в конце строки кода после того, как форматтер заново разобьёт эту строку. |
Этот Компактный и Развёрнутый предустановки включают соответствующие параметры из этой группы. В CREATE INDEX … ON table (…), имя таблицы сохраняет регистр; оно больше не переводится в верхний регистр, как ключевое слово.
Автодополнение следует вашим настройкам
Когда вы принимаете IntelliSense
, SQLly вставляет его в том виде, в каком Format SQL оформил бы этот оператор: регистр ключевых слов и функций, регистр идентификаторов и их кавычки, JOIN и
ON размещение и остальные настройки форматирования. Например, с
Расположение предложения ON установлено в На новой строке,
предложение соединения ставит его
ON на отдельной строке. Укороченное выражение для Держать короткие запросы в одной строке остается на одной строке, так же как и при форматировании SQL. Если форматер не может выровнять результат с тем, что вы набрали, предложение вставляется как есть.
Оставляя SQL без изменений
Отметьте область, которую нужно оставить ровно как написано, когда форматеру лучше держаться подальше:
-- formatter:off SELECT weird , hand_aligned , columns -- left exactly as typed FROM t; -- formatter:on
Переключатель действует по одному оператору за раз. Оператор, который начинается после
-- formatter:off остаётся как есть, как и каждое выражение после него, до -- formatter:on. Маркер в середине выражения не защищает его часть, поэтому завершайте выражения ; или GO строка. Вы можете отключить маркеры с помощью Учитывать управляющие комментарии в разделе комментариев.
«Форматировать SQL» ничего не делает на подключениях Redis — их редактор работает с командами, а не с SQL.
Минифицировать SQL
В обратную сторону, одна компактная строка для лога, JSON-полезной нагрузки или командной строки,
Минифицировать SQL удаляет обычные комментарии и сводит все пробелы к одиночным, при этом оставляя неизменными строковые литералы, идентификаторы в кавычках и тела с долларовой кавычкой, так что компактный SQL выполняется точно так же, как и исходный.
-- sqlly директивные комментарии и /*+ hint */ подсказки оптимизатора сохраняются, разделитель SQL Server GO остаётся на отдельной строке, потому что этого требует сервер, а SQL, который не разбирается до конца, оставляют как есть, а не ломают.
Выберите SQL для сжатия, поставьте курсор внутрь инструкции или ничего не выделяйте, чтобы минифицировать весь запрос, и нажмите ⌘⌥⇧F (Ctrl+Alt+Shift+F на Windows и Linux), выберите Запрос › Минимизировать SQL, или запустите её из палитры команд. Результат вносится одной отменяемой правкой, поэтому одна отмена возвращает ваш SQL к прежнему виду.