Prácticas recomendadas de SQL: cómo escribir código de forma limpia y perfectamente organizada

Código limpio

En esta publicación, prestaremos atención al estilo de codificación. Hay muchas formas de escribir su código, pero solo unas pocas se consideran profesionales.

Cumplir con las reglas de estilo de codificación es crucial. Cuando avance en la programación, no solo en SQL sino en cualquier lenguaje, nunca trabajará por su cuenta. Siempre trabajarás en equipo. Incluso si eres un profesional independiente que trabaja en línea, siempre habrá alguien que leerá tu código en algún momento. Luego, descubrirá que hay una noción que no le dará un descanso: la noción de código limpio.

El código limpio es un código enfocado y comprensible, lo que significa que debe ser legible, lógico y modificable. Recuerde: un buen código no es el que las computadoras entienden; Es lo que los humanos pueden entender.

A menudo, un programa se puede crear de muchas maneras, y el código, en general, se puede organizar de varias maneras. La buena práctica implica que elegirá la versión que será más fácil de leer y comprender y será la que no impida a sus colegas actualizarla cuando sea necesario. Es probable que funcionen encima de su código, por lo que es mejor si no pierden el tiempo descubriendo ideas debajo de líneas complejas de código. Es por eso que se supone que, en su lugar de trabajo, siempre escribirá el código de forma limpia, lo más simple posible, perfectamente organizado, manteniendo un flujo lógico constante.

Buen estilo

Ahora, centrémonos en otro aspecto de la codificación con buen estilo. Al asignar nombres a variables u objetos SQL, elija siempre nombres más cortos y significativos, transmitiendo información específica. Por "significativo", nos referimos a nombres que se pueden pronunciar, donde se ha elegido una palabra por concepto. Por ejemplo, esa es la razón por la que elegimos "número de compra", no "número único de compra del cliente" en la tabla "Ventas".

En esa cuenta, no necesita apurarse para elegir nombres, ya que deben reflejar la mayor funcionalidad posible del objeto. Los nombres constituirán más del 80% de su código, por lo que importa con cuáles trabaje.

A menudo se discute si se deben usar letras mayúsculas o minúsculas al codificar. La verdad es que depende de su estilo o del estilo de la empresa para la que trabaja. Muy a menudo, los profesionales capitalizarán las palabras clave de SQL y escribirán los nombres de los objetos de una manera diferente.

Cuando un nombre comprende más de una palabra, como "número de compra", las palabras suelen estar separadas por un guión bajo o unidas entre sí, y cada palabra comienza con una letra mayúscula. Ambos enfoques se encuentran en la codificación profesional. Sin embargo, una cosa es segura: no puede dejar un espacio en blanco entre las palabras. MySQL mostrará un mensaje de error si intenta hacerlo.

Legibilidad de código

La tercera faceta en la que nos centraremos en esta publicación es la legibilidad de su código. Por un lado, esto se refiere a la organización horizontal y vertical del código, por otro lado, el color con el que se muestran las palabras.

Técnicamente, cualquier consulta SQL se puede escribir en una sola línea. Sin embargo, muchas consultas son demasiado largas y serán difíciles de leer si lo hacemos. Lo que debe hacerse en tales casos es organizar el código, no solo horizontalmente, sino también verticalmente.

Dependiendo de su significado en una consulta y de la forma en que queremos que se lean, las palabras se pueden escribir en diferentes colores. Las palabras clave SQL se escriben en azul, los nombres de los objetos en negro, los números en naranja, etc.

Mantener su código

A medida que avancemos en la publicación, desarrollará un ojo para una organización impecable del código que escribe. Por ahora, recuerde que hay tres formas principales de mantener bien su código:

1. Los profesionales usan software ad-hoc que reorganiza el código y colorea diferentes palabras de manera consistente. En un entorno de codificación más dinámico, el tiempo será un factor y la unificación del estilo de codificación será una prioridad. Es imposible tener 50 programadores en su empresa, todos escribiendo en el mismo estilo. No es profesional fusionar el código escrito en el mismo idioma pero con un estilo diferente. Entonces, cuando se completa, las piezas de código de trabajo pasan por la verificación de dicho software, y su jefe tendrá un montón de código escrito en el mismo estilo.

2. Utilice la herramienta analógica relevante provista en Workbench. Este pequeño pincel embellece tu código. La combinación de teclas de acceso directo para aplicar esta función a la consulta donde se encuentra el cursor es Ctrl y B. ¿Ves? ¡Increíble!

3. Si prefiere limpiar su código de manera diferente, debe intervenir manualmente y ajustarlo a su gusto.

Ejercicio

En esta línea simple, crearemos una tabla de prueba con dos columnas: "Números" y "Palabras".

Hemos escrito el código en una línea con letras minúsculas. Observe cómo MySQL cambió el color de las palabras clave, los tipos de datos y los números. Ahora, no trataremos con un software ad-hoc, ya que nos estamos centrando en Workbench. Después de haber colocado el cursor en algún lugar de esta consulta, puede presionar el pequeño icono de pincel para volver a formatear el script. Para hacer la misma operación más rápido, recuerde el atajo Ctrl y B.

¡Guauu! Funcionó.

Las palabras clave están en mayúsculas y los datos para cada columna de la tabla comienzan en una nueva línea. ¡Excelente!

Estilo de sangría

Imagine que tiene una preferencia adicional con respecto a la organización horizontal de este código y la alineación de todos los tipos de datos. Usando el botón de tabulación de su teclado, puede configurar INT y VARCHAR para comenzar en el mismo punto horizontal. Según algunos usuarios, este truco mejora aún más la legibilidad del código.

El término técnico se llama sangría. Decimos que los nombres de columna y sus tipos de datos se sangraron a la derecha.

Comentarios

Otro aspecto de mantener un buen estilo de codificación es usar comentarios. Estas son líneas de texto que Workbench no ejecutará como código; transmiten un mensaje a alguien que lee nuestro código. Técnicamente, en MySQL, puede comenzar un comentario escribiendo una barra diagonal y una estrella y cerrarlo recíprocamente con una estrella y una barra diagonal. Este enfoque se utiliza principalmente para comentarios grandes.
Para comentarios de una línea, puede usar dos guiones o uno o más signos hash. Además, para diferenciarlos del mero código, MySQL Workbench marca todos los comentarios en gris.

¡Fantástico!

Código de ejecución

Finalmente, me gustaría profundizar en el símbolo del rayo, que le ayuda a ejecutar su código.

Comencemos por el hecho de que su código está separado en bloques, como lo marca el separador de punto y coma. Okay.

Entonces, si coloca el cursor en un bloque y luego presiona el icono del rayo o la combinación Ctrl, Shift, Enter, SQL ejecutará las consultas seleccionadas y todas las consultas restantes.

Por eso, si hago clic en FROM y ejecuto el código de esta manera, veré el resultado de la instrucción SELECT y descartaré la tabla de prueba.

Si desea ejecutar solo la instrucción debajo del cursor, debe presionar el icono adyacente, donde se representan un rayo y un cursor. La combinación de teclado correspondiente es Ctrl e Enter.

Puedo prometerle que no dejará de usar esta combinación de teclado, ya que le permite ver rápidamente la salida de una determinada consulta, sin tener que ejecutar todo el código SQL.

Bueno… ¡espero que les haya gustado esta publicación! Estaba destinado a hacerle saber la noción de codificación limpia y codificación con buen estilo. Consideramos que estas herramientas son esenciales para una buena codificación profesional, por lo que estaríamos felices si puede sentir que comenzó a desarrollar buenos hábitos de estilo de codificación.