Formateador SQL

funcional

Ordena una consulta sin cambiar su significado. El formateador es prudente a propósito.

El formateador es configurable, pero deliberadamente cauteloso. SQLly vuelve a lexar y compara su salida token por token con la entrada; cualquier discrepancia deja tu SQL intacto. Puede reindentarlo, cambiar las mayúsculas y minúsculas de las palabras clave y alinear las cláusulas sin arriesgar comentarios ni literales.

Formatear SQL

Presiona ⌥⇧F (Alt+Shift+F en Windows y Linux), elige Editar › Formatear documento, o haz clic derecho › Formatear documento para formatear toda la consulta, sea cual sea la selección. Para formatear solo la selección, presiona ⌘K ⌘F (Ctrl+K Ctrl+F) para Formatear selección. Ambos atajos se pueden cambiar en Ajustes › Espacio de trabajo › Atajos de teclado. También puedes elegir Consulta › Formatear SQL, usar el botón de la barra de herramientas o ejecutarlo desde la paleta de comandos: con texto seleccionado solo se formatea la selección; si no, se formatea toda la consulta. Aquí tienes una consulta de una sola línea con los ajustes predeterminados:

-- 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

Las palabras clave y las funciones van en mayúsculas, cada cláusula principal empieza en una línea nueva, las listas de selección se apilan una columna por línea, las tablas después de FROM (con sus JOINs) y las condiciones después de WHERE y HAVING se colocan en sus propias líneas con sangría, y AND/OR dirigen sus líneas. Una sola instrucción que cabe en 80 caracteres se mantiene en una línea: SELECT id, name FROM dbo.Users WHERE id = 1. La sangría sigue los ajustes de tabulación de tu editor, salvo que digas lo contrario.

SQLly
Editor mostrando una consulta de Orders con varios joins tras aplicar Formatear SQL, con las palabras clave en mayúsculas y las cláusulas en líneas separadasEditor mostrando una consulta de Orders con varios joins tras aplicar Formatear SQL, con las palabras clave en mayúsculas y las cláusulas en líneas separadas
Una consulta de varios joins después de Formatear SQL: palabras clave en mayúsculas, una columna por línea y cláusulas alineadas.

Formatear mientras escribes

La Formatear mientras escribes interruptor en la parte superior de Ajustes › Editor › Formato formatea mientras escribes. Con la opción activada, al presionar Enter reformatea la instrucción mientras escribes, y el cursor queda justo después del mismo carácter que lo precedía, así que sigues escribiendo donde estabas. Viene desactivado por defecto; con él desactivado, formatea a demanda con Formatear documento (⌥⇧F en macOS, Alt+Shift+F en Windows y Linux, reasignable en Ajustes › Espacio de trabajo › Atajos de teclado).

Presionar Enter deja el texto sin cambios cuando:

  • hay texto seleccionado, o estás editando con varios cursores;
  • la pestaña está en una conexión Redis, cuyo editor contiene comandos en lugar de SQL;
  • la instrucción no comienza con una palabra clave de instrucción: SELECT, INSERT, UPDATE, DELETE, WITH, CREATE, ALTER, DROP, MERGE, TRUNCATE, GRANT, REVOKE, BEGIN, DECLARE, o EXEC.

Scripts y lotes GO

Un script con varias instrucciones se formatea una instrucción a la vez, cada una en su propia línea, y el atajo de una sola línea solo se aplica cuando todo el texto es una sola instrucción. Las instrucciones terminan en ; y, para SQL Server, en un GO separador de lotes. GO siempre mantiene una línea propia, con las mayúsculas y minúsculas de tus otras palabras clave, junto con cualquier número de repeticiones (GO 5) o comentario que comparta su línea:

-- before
select 1
go
select name from dbo.Users
go

-- after
SELECT
    1
GO
SELECT
    name
FROM dbo.Users
GO

GO cuenta como un separador solo cuando comienza una línea que no contiene nada más que un conteo opcional o comentario, y se encuentra entre instrucciones, como sqlcmd y espera SSMS. Una columna llamada go en medio de una lista de selección, [go], y go dentro de una cadena o un comentario se dejan como SQL normal. Con el dialecto en Detección automática, una GO línea marca el script como SQL Server. Con el dialecto configurado en otro motor, GO no es un separador.

Ajustes

Todo vive en Ajustes › Editor › Formato, que tiene una vista previa en vivo: pega tu propio SQL y mira cómo cambia mientras lo vas ajustando. El inicio más rápido es un preajuste:

PreajusteEstilo
PredeterminadoEl diseño mostrado arriba.
CompactaLas cláusulas cortas y las listas de selección quedan en una sola línea, y AND/OR siguen sus líneas.
ExpandidoComas iniciales, una línea en blanco antes de cláusulas principales, ON en su propia línea, y operadores, tipos de datos y alias alineados.
Palabras clave en mayúsculas / Palabras clave en minúsculasEn ese caso, el diseño predeterminado con palabras clave y funciones.
Conservar existenteConserva tus mayúsculas y minúsculas, tus comas y la posición de las cláusulas, y ordena el resto.

Elegir un ajuste predefinido reescribe todos los ajustes de diseño, pero conserva tus activadores de formato (Formatear mientras escribes, Formatear al guardar, y Formatear al pegar), así que probar un preajuste distinto ya no los desactiva. Cambiar después cualquier ajuste individual lo pasa a Personalizado. Las secciones individuales cubren el uso de mayúsculas en las palabras clave (general o por grupo, como tipos de datos o JOIN), las mayúsculas y comillas de los identificadores, la disposición de las cláusulas, las listas de selección, el estilo de las comas, las condiciones booleanas, CASE, operadores, JOINs, funciones, subconsultas y CTEs, DML, DDL, comentarios, sangría, longitud de línea (120 por defecto) e instrucciones. El Dialecto SQL se establece por defecto en «Detección automática», que deduce el dialecto a partir del propio SQL.

Formatear al guardar y Formatear al pegar están bajo Activadores de formato. Ambos están desactivados por defecto.

Ubicación de FROM y WHERE

Dos ajustes en Diseño de cláusulas elige si el cuerpo de una cláusula comienza en la línea de la palabra clave o en su propia línea indentada debajo de ella:

OpciónLo que hace
Tabla después de FROMNueva línea, con sangría (el predeterminado) pone la primera tabla en su propia línea debajo de FROM, y alinea sus JOINcon ella; un ON en su propia línea se indenta un paso más. Misma línea que la palabra clave mantiene la tabla en la FROM línea, con JOINs realizados por el Diseño de JOIN ajuste.
Primera condición después de WHERE / HAVINGNueva línea, con sangría (el predeterminado) pone la primera condición en su propia línea debajo de WHERE o HAVING, alineada con las líneas de AND/OR líneas que siguen. Misma línea que la palabra clave lo mantiene en la línea de la palabra clave.

La Compacta y Conservar existente los preajustes mantienen ambos en la línea de la palabra clave. Un comentario escrito justo después de FROM o WHERE se queda en esa línea.

CTEs, DML y columnas de índice

Estas opciones controlan cómo se distribuyen los patrones más comunes de las instrucciones:

OpciónLo que hace
Estilo de CTEApilado (el predeterminado) pone el cuerpo de cada CTE en sus propias líneas. En línea pone de cada CTE name AS ( … ) en una línea. Un CTE que contiene un -- comentario, o que supere la longitud máxima de línea, permanece apilado.
Estilo DMLEstándar (el predeterminado) es la disposición habitual. Compacta pone un INSERT, UPDATE, DELETE, o MERGE en una línea cuando cabe en la longitud máxima de línea. Expandido pone cada INSERT columna, cada VALUES elemento y cada UPDATE SET asignación en su propia línea, y nunca se colapsa por Mantener consultas cortas en una línea.
Columnas de índice de varias líneasCuando un índice tiene más de una columna, cada columna clave y cada INCLUDE columna de un CREATE INDEX va en su propia línea. Lo mismo se aplica a PRIMARY KEY, UNIQUE, INDEX, y KEY listas de columnas dentro CREATE TABLE. FOREIGN KEY las listas de columnas se dejan tal como están.
Mover los comentarios finales con la expresiónFunciona junto con Mantener los comentarios en línea en su sitio. Con ambos activados, un fin de línea -- comment se queda al final de la línea de su código cuando el formateador vuelve a dividirla.

La Compacta y Expandido los ajustes preestablecidos activan las opciones correspondientes de este grupo. En CREATE INDEX … ON table (…), el nombre de la tabla conserva sus mayúsculas y minúsculas; ya no se pone en mayúsculas como una palabra clave.

El autocompletado sigue tu configuración

Cuando aceptas una IntelliSense sugerencia, SQLly la inserta con la presentación que Formatear SQL daría a esa instrucción: mayúsculas de palabras clave y funciones, de identificadores y entrecomillado, JOIN y ON colocación y el resto de tus ajustes de formato. Por ejemplo, con Ubicación de la cláusula ON establecido en En una nueva línea, un sugerencia de unión pone su ON en su propia línea. Una instrucción lo bastante corta para Mantener consultas cortas en una línea permanece en una línea, tal como lo haría con Formatear SQL. Si el formateador no puede alinear su resultado con lo que escribiste, la sugerencia se inserta tal cual.

Sin tocar SQL

Marca una región para que el formateador la deje exactamente como está escrita:

-- formatter:off
SELECT weird , hand_aligned
       , columns   -- left exactly as typed
FROM t;
-- formatter:on

El interruptor funciona una instrucción a la vez. Una instrucción que comienza después -- formatter:off se mantiene tal cual, y cada instrucción posterior también, hasta un -- formatter:on. Un marcador en mitad de una instrucción no protege una parte de esta, así que termina las instrucciones con ; o una GO línea. Puedes desactivar los marcadores con Respetar comentarios de control en la sección de Comentarios.

No puede romper el SQL. La comprobación de tokens convierte un error de formato en una operación nula, no en SQL corrupto. El SQL que no se tokeniza limpiamente, como una cadena o un comentario sin cerrar, se devuelve sin cambios en lugar de reformatearse. Los comentarios nunca se eliminan.

Formatear SQL no hace nada en conexiones Redis: su editor contiene comandos, no SQL.

Minificar SQL

En el otro sentido, una línea compacta para un registro, una carga JSON o una línea de comandos, Minificar SQL elimina los comentarios ordinarios y colapsa todos los espacios en blanco a espacios simples mientras deja intactos los literales de cadena, identificadores entre comillas y cuerpos entre signos de dólar, de modo que el SQL compacto aún se ejecute exactamente como el original. -- sqlly se mantienen los comentarios de directiva y /*+ hint */ las sugerencias del optimizador se conservan, un separador de SQL Server GO mantiene su propia línea porque el servidor lo requiere, y el SQL que no se analiza correctamente se deja sin cambios en lugar de estropearse.

Selecciona el SQL que quieras compactar, coloca el cursor en una instrucción o no selecciones nada para minificar toda la consulta, y presiona ⌘⌥⇧F (Ctrl+Alt+Shift+F en Windows y Linux), elige Consulta › Minificar SQL, o ejecútalo desde la paleta de comandos. El resultado queda como una única edición deshacible, así que con un deshacer recuperas tu SQL formateado.