Formateador de SQL

Sobre formatear SQL

El SQL llega como una sola línea enorme. Salido del registro de un ORM, de un informe de error, del portapapeles de alguien. Funciona perfectamente y es imposible de leer, y el trozo que buscas está en algún punto del medio.

Pégalo y vuelve maquetado: una cláusula por línea, las columnas indentadas bajo SELECT, los JOIN y sus condiciones ON alineados, de modo que la forma de la consulta se ve de un vistazo.

Cómo se usa

• Pega tu SQL en la caja de la izquierda — la versión formateada y con colores aparece a la derecha mientras escribes
• Ajusta la indentación, las mayúsculas de las palabras clave y la posición de las comas si quieres — el resultado se actualiza al instante
• Cópialo o descárgalo como archivo .sql
• Cambia a Minificar para dejarlo otra vez en una línea; ese modo se mantiene mientras sigues escribiendo

No hay ningún botón que pulsar para formatear. Los dos únicos botones que cambian el resultado

son Formatear y Minificar, y eligen cuál de los dos estás mirando.

El color viene de la misma lectura de la consulta

La salida se colorea pasando el mismo analizador léxico que la maquetó otra vez sobre el

texto terminado: palabras clave en cian, cadenas en amarillo, números en naranja, comentarios

en gris, signos en rosa, y tus propios nombres de tablas y columnas en color normal para que

destaquen del SQL que los rodea.

Eso importa más allá del aspecto. Como una sola lectura de la consulta produce tanto la

maquetación como el color, los dos nunca pueden contradecirse: lo que aparece pintado como

cadena es exactamente lo que el formateador trató como cadena. Si en algún sitio falta cerrar

una comilla, el color se derrama y te enseña dónde — normalmente más rápido que buscarlo a ojo.

Copiar y Descargar entregan el texto plano, nunca el marcado con colores.

Dos cosas con las que tiene cuidado

La mayoría de los formateadores rápidos de SQL trabajan con expresiones regulares, y estos dos puntos son justo donde ese enfoque se rompe.

• Nunca se mira dentro de las cadenas ni de los comentarios. Una consulta con WHERE note = 'from a, b' tiene una palabra clave, una coma y un espacio dentro de un literal de cadena. Un formateador con regex parte la línea ahí y cambia lo que hace la consulta. Este lee primero la consulta en tokens, así que el interior de un literal sale exactamente como entró, hasta los espacios
• Los identificadores conservan las mayúsculas que escribiste. Solo las palabras clave se pasan a mayúsculas o minúsculas. En un servidor que distingue mayúsculas, userId y userid son columnas distintas, y un formateador que las «ordena» ha roto la consulta para que quede más bonita

Se entienden todos los estilos de comillas: 'cadenas' con escape '', "identificadores entre comillas", acentos graves de MySQL, [corchetes] de SQL Server y $$ comillas de dólar $$ de PostgreSQL.

Las opciones

• Indentar con — 4 espacios, 2 espacios o un tabulador
• Palabras clave — MAYÚSCULAS, minúsculas o exactamente como las escribiste
• Comas — al final de la línea, o al principio, si ese es el estilo de tu equipo

Minificar

Minificar vuelve a dejar la consulta en una sola línea. Solo conserva un espacio donde quitarlo cambiaría el significado o crearía un token nuevo, así que el resultado es lo más corto que puede ser sin riesgo.

Los comentarios de línea se descartan, porque -- así se tragaría el resto de la línea una vez que todo está seguido. Los comentarios de bloque se conservan, exactamente como están escritos.

Para qué se usa

• Hacer legible una consulta sacada del registro de un ORM
• Ordenar el SQL antes de meterlo en una pull request o en una migración
• Entender una consulta larga que escribió otra persona
• Sacar una consulta de un informe de error con una forma con la que se pueda trabajar
• Dejar una consulta en una sola línea para un archivo de configuración o un comando de shell
• Unificar el estilo de una carpeta de archivos .sql antes de subirlos

Bueno saberlo

• Tu consulta se queda en esta página — no se envía a ninguna parte. Viene bien cuando lleva nombres reales de tablas y columnas
• Esto maqueta SQL; no comprueba que sea válido. Una consulta con un error de sintaxis se formatea lo mejor posible, no se rechaza
• Se admiten las comillas propias de cada dialecto, pero esto no reescribe de un dialecto a otro
• Las consultas muy grandes no son problema — es trabajo sencillo en tu propia máquina
• Funciona en todos los navegadores, también en el móvil

Herramientas relacionadas

• Formateador de JSON — el mismo trabajo para JSON
• CSV a JSON — convertir los datos que devolvió la consulta
• Buscar y reemplazar en muchos archivos — cambiar un nombre de tabla en toda una carpeta de .sql
• Comparador de textos — comparar dos versiones de una consulta
• Probador de regex — construir el patrón antes de buscar con él