SQL ordenado con SQL completo

En este artículo, hablaremos sobre cómo mantener el código SQL limpio y bien legible. También discutiremos cómo dejar de sufrir código sucio y sin formato. Además, hablaremos sobre cómo lograr que todos los miembros del equipo se adhieran a los estándares de codificación generalmente aceptados sin mucho esfuerzo.

Índice

    Mejorar la legibilidad del código

    Hay momentos en que los desarrolladores de SQL depuran el código o realizan mejoras en el código existente o desactualizado. Por ejemplo, al iniciar el proceso de revisión del código, los desarrolladores se enfrentan a diferentes estilos y técnicas de codificación. Algunos tienen estándares de codificación y básicamente se ajustan a cómo se escriben todos los guiones. Algunos no tienen estándares de codificación y escriben código por su propia cuenta. Esto requiere que el navegador desplace el código horizontalmente varias veces para leer el código por completo.

    Es mucho más fácil entender el curso del código si está bien formateado y tiene un buen grado de consistencia.

    Si el código parece ilegible, preferiría usar algún tipo de herramienta SQL.

    Mi herramienta favorita para formatear código aleatorio es dbForge SQL Complete, un excelente complemento para Microsoft Visual Studio y SSMS. Junto con las funciones de formato de código automático, SQL Complete proporciona una excelente funcionalidad similar a IntelliSense, lo que hace que su trabajo sea mucho más productivo en comparación con la codificación manual.

    Veamos cómo la herramienta formatea el código.

    La siguiente figura muestra un ejemplo real (tomado de producción) de código SQL sin formato. Además del problema de formato, puede notar que las palabras clave aparecen en diferentes registros en el texto.

    desordenado-sql-antes
    Bueno, no es fácil averiguar qué hace el código.
    Afortunadamente, SQL Complete nos brinda la capacidad de formatear código SQL sucio usando un atajo muy conocido. hagamos clic CTRL + K + D y mira la salida.

    desordenado-sql-después

    Administrar formato de código

    Ahora se ve mucho mejor, ¿no? El siguiente paso es decidir si la salida de formato estándar cumple con sus requisitos. Si no, puede personalizarlo fácilmente ajustando las opciones de formato. Para hacer esto, vaya al menú SQL Complete y haga clic en Opciones. Ir Perfiles de formato.

    Hay tres perfiles de formato predefinidos que le brindan diferentes opciones de formato. Prueba a elegir diferentes perfiles y verás el resultado.

    En caso de que esto no funcione para usted, es fácil crear un nuevo perfil y personalizarlo a su gusto.

    formatear_perfil_nuevo

    Una vez que haya creado un nuevo perfil, puede seleccionarlo y editarlo.

    Configuremos un nuevo perfil de formato para agregar más estructura a una pieza de código SQL existente y mejorar su legibilidad.

    El Asistente de edición de perfiles de formato le ofrece más de cien opciones de formato que cubren cualquier necesidad. Puede usar la función de búsqueda para encontrar la configuración deseada en el árbol. Además, tiene un panel de vista previa rápida que agrega más comodidad al proceso.

    Editar-FromattingProfile

    En primer lugar, coloquemos cada declaración en una línea separada, agreguemos un salto de línea después de DONDE y sangremos un poco.

    Vamos a desmarcarlo Pon una coma delante sujeto en la lista superpuesta opción. Limpiar para subconsulta Use el mismo formato que en SELECCIONAR marque la casilla y seleccione Salto de línea después del paréntesis de apertura. Además, agregue saltos de línea después de DONDE y DESDE.

    Una vez que haya completado el proceso de configuración, vuelva a formatear el código para evaluar el resultado.

    Resultado final del formato SQL

    Si el código SQL está bien formateado, no necesita esforzarse demasiado en leerlo y analizarlo.

    Cumplimiento de los estándares de codificación

    El perfil de formato no es más que un simple archivo XML. Puede resumir el archivo en su comando. De esta manera, cada desarrollador de SQL podrá escribir código SQL en un proyecto que esté formateado de acuerdo con las reglas aceptadas.

    Conclusión

    Como puede ver, dbForge SQL Complete es una herramienta bastante simple e intuitiva que brinda capacidades avanzadas de formato de código. Además, la herramienta le brinda una serie de funciones, como fragmentos de código, finalización automática de código, refactorización de SQL, que aumentan su productividad al desarrollar código SQL.

    Artículos de interés

    Subir