Módulo 01 · lección 8
Comentarios y formato del SQL
Un mes después abres tu propia consulta y no recuerdas para qué era. Y un compañero no la entenderá en absoluto. El código se lee más veces de las que se escribe.
Por qué escribir con orden
El SQL se escribe una vez y se lee muchas: tú dentro de un mes y tus compañeros. Así que una consulta debe ser fácil de leer para una persona. (Ahora puede parecer innecesario, porque hasta aquí las consultas han sido sencillas, pero se vuelven más complejas.)
Comentarios
El SGBD ignora los comentarios, pero ellos explican la intención:
-- un comentario de una línea
/* un comentario
de varias líneas */
Formato
Una consulta bien formateada se lee de un vistazo:
-- Top 5 de productos por existencias
SELECT name, stock
FROM products
ORDER BY stock DESC
LIMIT 5;
-- Top 5 de productos por existencias
select name, stock FROM products
ORDER by stock desc LIMIT 5;
La primera consulta se lee mejor que la segunda, aunque en esencia son la misma.
Hábitos que ayudan:
- las palabras clave en mayúsculas (
SELECT,FROM,ORDER BY); - cada sección importante en una línea nueva;
- sangría para lo anidado.
Las mayúsculas de las palabras clave no afectan a cómo se ejecuta la consulta: son puramente para las personas. Pero hacen que la estructura destaque.
Te toca
Aquí tienes una consulta desordenada en una sola línea. Reescríbela limpia y añade un comentario que diga qué hace.
Resumen
--es un comentario de una línea;/* ... */, de varias.- Las palabras clave van en
MAYÚSCULASpor convención. - El formato no cambia el resultado, solo la legibilidad.