Tabla de contenido
- T Opciones de formato SQL
- Vista previa de impacto
- Perfiles de formateador de SQL
- Importación / Exportación de perfiles de formateador de SQL
- Formatee el objeto en un lote
- Formatee los scripts de T-SQL en un lote
- Integración de host
- Compatibilidad con alta resolución DPI y 4K
A nadie le gusta revisar y leer un montón de texto desordenado y sin formato. Cuando se trata de leer un código SQL complejo, ese problema puede volverse aún más difícil, especialmente si eres tú quien tiene que desenredarlo.
El código SQL se puede formatear con un estilo que facilite la lectura. , especialmente si todo el equipo usa el mismo. El código SQL limpio, bien formateado (consistente) se puede leer mucho más rápido que el código SQL escrito de manera inconsistente, ya sea que la inconsistencia sea entre miembros del equipo y diferentes objetos o incluso dentro del mismo script del objeto mismo. El código SQL bien organizado y formateado se puede revisar de manera más eficiente. Pasar un proyecto a otro equipo o cliente con un código SQL bien formateado será mucho más sencillo y mucho más apreciado.
El principal problema con el formateo de scripts SQL es que no existe un estilo o estándares de cómo el SQL el código debe estar formateado y todo es una cuestión de preferencia. La mejor solución aquí es establecer los estándares que usted y su equipo en la empresa cumplirán, y luego asegurarse de que se apliquen de manera consistente.
Todo el código SQL se puede formatear manualmente, lo que lleva mucho tiempo pero existen herramientas de terceros y se pueden usar para formatear de manera rápida y eficiente.
Este artículo describirá e introducirá algunas pautas y expectativas básicas sobre lo que debe tener una herramienta de formateo de consultas SQL perfecta para alcanzar su objetivo para establecer un estilo de formato consistente y estándar (estándar) y cómo aplicar ese estilo a un script T-SQL o muchos scripts u objetos T-SQL con un solo clic.
Una de estas herramientas de formateo es ApexSQL Refactor, complemento que se puede integrar en SQL Server Management Studio (SSMS) o Visual Studio (VS). ApexSQL Refactor tiene más de 200 opciones de formateo de consultas SQL y características para aplicar un estilo en uno o scripts T-SQL masivos a la vez.
Opciones
El primer objetivo es establecer opciones básicas. Una de las principales preocupaciones cuando se trata de establecer estándares es qué palabras clave de T-SQL deben o no deben escribirse con mayúscula en el código.
En la pestaña Capitalización de la ventana Opciones, se pueden establecer reglas de capitalización para la siguiente:
Para establecer la regla apropiada para el uso de mayúsculas, se pueden usar las siguientes opciones: MAYÚSCULAS, minúsculas, lowerCamelCase, UpperCamelCase , Caso apropiado, o dejando las reglas de diseño de consultas SQL predeterminadas deseleccionando la opción:
Algunos desarrolladores prefieren palabras clave SQL, tipos de datos , etc. para estar en MAYÚSCULAS y otros desarrolladores, sin embargo, como las palabras clave SQL en minúsculas.
La mejor solución al elegir una herramienta es seleccionar una que pueda manejar todas esas diferentes preferencias.
En el primer ejemplo, las palabras clave están en mayúsculas y los tipos de datos en minúsculas:
En el segundo ejemplo, las palabras clave son minúsculas y da Los tipos ta están en mayúsculas:
El tercer ejemplo, las palabras clave y los tipos de datos están en mayúsculas:
Vista previa de Impact del formateador SQL
Una de las cosas críticas que toda herramienta de diseño SQL debería tener es poder obtener una vista previa visual cómo se ve el código SQL después de agregar algunas opciones.
ApexSQL Refactor tiene una vista previa de impacto de formato de código SQL que muestra una visión clara y una visión del impacto de cualquier cambio de opción inmediatamente cuando lo hace. Si no le gusta cómo se ve, se puede cambiar y revertir fácilmente sin guardar:
Establecer las reglas para el uso de mayúsculas de palabras clave SQL, tipos de datos, identificadores (nombres de objetos), funciones del sistema, variables es solo un elemento en el conjunto del estilo.
Reglas de diseño de código SQL para alias, comentarios, comas, espaciado, alineación, etc., también debe configurarse para tener un código SQL bueno, coherente, legible y bien formateado.
Para todas las cosas mencionadas anteriormente, una herramienta de formato debe tener opciones para configurar estos Reglas de estilo de consultas SQL.
ApexSQL Refactor tiene todas estas opciones para cumplir con sus requisitos.Puede encontrar más información sobre las opciones de formateador de SQL en los enlaces siguientes:
- Reglas de formateo de SQL – Comas y espacios en T-SQL
- Reglas de formateo de SQL – Regular y delimitado Identificadores T-SQL
- Reglas de formateo de SQL – comentarios de código SQL
- Reglas de formateo de SQL – Convenciones de nomenclatura de SQL y reglas de uso de mayúsculas
- Reglas de formateo de SQL – Terminación Declaraciones SQL con punto y coma
Perfiles del formateador de consultas SQL
Poder establecer un estilo deseado, guardar ese estilo y compartir el estilo con colegas es otra cosa que todo SQL Server la herramienta del formateador debe tener. Además, tener una selección preestablecida de perfiles preconfigurados, listos para usar, es muy útil.
Con ApexSQL Refactor, los usuarios pueden:
- guardar preferencias Opciones de formateador de consultas SQL a un perfil reutilizable
- agrupar y categorizar estilos de formato
- modificar rápidamente los perfiles existentes
- evitar conflictos con otros usuarios
Además, ApexSQL Refactor viene con cuatro perfiles integrados
- ApexSQL: contiene lo que determinamos que era un buen estándar de formateador SQL
- Compacto: establece la opción de sangría a 0 (cero) espacio, todos los espacios adicionales están desmarcados y las líneas vacías se eliminan para una consulta donde el código SQL parece denso
- Extendido – es opuesto al perfil compacto. Este perfil agrega líneas vacías antes / después de cada declaración, comentarios. Agregue espacio alrededor de operadores lógicos y aritméticos
- MSDN SQL BOL: imita el estilo utilizado en el sitio de recursos de MSDN
Esos cuatro perfiles integrados no se pueden cambiar de ninguna manera , pero se puede hacer una copia de estos perfiles de formateador de consultas SQL incorporados haciendo clic en el botón Copiar y luego se puede cambiar de la forma preferida:
Además, se puede crear un nuevo perfil de formateador SQL haciendo clic en el botón Nuevo:
Importación / exportación de perfiles en formato SQL
Una vez que haya creado el perfil perfecto, es importante poder exportarlo para que sea accesible a otros; así como para que los destinatarios del perfil puedan importarlo fácilmente. ApexSQL Refactor proporciona solo esta funcionalidad
Para exportar perfiles y compartir con colegas, presione el botón Exportar en la ventana Opciones:
Para importar perfiles en la ventana Opciones, presione el botón Importar.
Puede encontrar más información sobre los perfiles de ApexSQL Refactor en la página Cómo personalizar perfiles de formato SQL.
Procesamiento de objetos en un lote
Una vez que se crea el perfil de formato y se establecen las opciones, se puede comenzar a formatear el código SQL en serio, con un objeto o script a la vez. Pero, ¿qué pasa con procesar todo en una base de datos a la vez?
Procesar una gran cantidad de objetos SQL como procedimientos almacenados individualmente puede ser un trabajo muy difícil y que consume mucho tiempo, por supuesto.
Entonces , otra cosa que podemos agregar es que cada herramienta de formato debe tener una función que pueda formatear varios objetos SQL con un único perfil SQL deseado a la vez.
ApexSQL Refactor tiene la función Formatear objetos SQL que permite exactamente ese. En el Explorador de Objetos, seleccione una base de datos en la que se encuentran los objetos que se quieren formatear, haga clic derecho y, en el menú contextual, elija el comando Formatear objetos SQL:
Todos los objetos basados en script, p. ej. vista, los procedimientos almacenados se enumerarán en la ventana Formatear objetos SQL:
En el cuadro combinado Perfil, seleccione el SQL deseado perfil del formateador (por ejemplo, ApexSQL) y, de la lista, elija los objetos SQL que desea formatear, haga clic en el botón Crear script, que abrirá un script en el editor de consultas, luego haga clic en el botón Ejecutar (F5):
Para confirmar que los objetos SQL están formateados con el perfil deseado, regrese a la ventana Formatear objetos SQL, en el cuadro combinado Perfil, elija un perfil y, en la lista de objetos SQL, debajo de la columna OK con el icono de marca de verificación verde, se indicarán los objetos SQL que están formateados, todos los demás objetos SQL se marcarán con el icono rojo x que indica que no están formateados con el perfil seleccionado :
Además, antes de formatear un script de objeto SQL con el perfil deseado, se pueden mostrar los mismos scripts SQL para que el usuario puede ver e cómo se verá después de su procesamiento. De esta manera, se puede comparar seleccionando un objeto SQL deseado de la lista, haga clic derecho y seleccione el botón Comparar:
Formato T-SQL de scripts por lotes
Una cosa más que debe tenerse en cuenta, al elegir la herramienta de diseño SQL correcta, es la posibilidad de formatear scripts y scripts SQL en carpetas en lotes.
En situaciones en las que, en la máquina, hay muchos scripts SQL cuyo código necesita ser verificado y ese código está en un lío bastante grande como en la siguiente imagen:
Verificar el código en estos scripts SQL puede ser un desafío.
Una solución para esto es abrir el script SQL en SSMS y formatee con su perfil preferido haciendo clic en el botón Formatear SQL:
Esto resuelve un problema para un script SQL, pero para más de estos scripts SQL, se necesita proporcionar una solución más rápida.
ApexSQL Refactor ofrece la función de formato de scripts SQL como una solución para este tipo de problema. Desde el menú ApexSQL Refactor, en el submenú Otro formato, seleccione el comando Formatear scripts SQL:
El formato SQL Se abrirá la ventana de scripts, en la lista navegue y seleccione los scripts SQL, elija el perfil del formateador SQL deseado en el cuadro combinado Perfil y presione el botón OK:
Todo el código de los scripts SQL seleccionados se formateará con el estilo de formateador SQL deseado, lo que facilita la revisión de los scripts SQL.
Integración con el host
Otro aspecto importante El elemento al elegir la herramienta de estilo SQL correcta es su integración directa en aplicaciones host que normalmente usa para codificación SQL como SSMS o Visual Studio.
Afortunadamente, ApexSQL Refactor admite la integración de SSMS 2012 y superior y admite la integración en Visual Studio desde la versión VS 2010 y superior.
Esto significa que puede agregar potentes capacidades de formateador SQL y mejorar su productividad de codificación sin dejar en el hogar de su editor favorito
Integración perfecta con el host y una experiencia de usuario constante
Integrarse en una aplicación host es una cosa. La integración perfecta con una experiencia de usuario final coherente es otra. Muchos complementos son malos invitados, acaparan el espacio del menú, ofrecen colores e íconos inconexos y, en general, son visualmente «ruidosos» e intrusivos. ApexSQL Refactor es un invitado educado que se integra a la perfección en los entornos de host, casi como si fuera parte del propio IDE. Esta experiencia de usuario consistente incluye iconografía, estilo visual y temas.
Los temas de color permiten al usuario modificar la apariencia visual para adaptarse a sus preferencias y una buena herramienta de terceros debe coincidir con esta capacidad. ApexSQL Refactor admite SSMS y color visual temas, pero mejor aún, cambiará automáticamente para adaptarse a la configuración del tema del host.
Consulte este artículo para obtener más información.
Tema de color oscuro de Visual Studio:
Tema de color azul SSMS:
Una nota , ApexSQL Refactor admite el tema de color oscuro de SSMS:
Incluso que el tema de color aún no es oficial; para aquellos que quieran saber cómo configurar el d El tema ark color en SSMS 17 se puede encontrar en la página Configuración del tema oscuro en el estudio de administración de SQL Server.
Además, todos los íconos que aparecen en comandos, cuadros de diálogo, plantillas, etc.en ApexSQL Refactor son heredados de la biblioteca de imágenes de Visual Studio. Algunos de los íconos de la biblioteca se han rediseñado para que sean más intuitivos, simples y son símbolos fácilmente reconocibles.
Se puede encontrar más en el Diccionario de lenguaje visual para Visual Studio sobre iconografía, colores y otros conceptos visuales aplicados en Página de herramientas / complementos de ApexSQL.
Compatibilidad con alta resolución de DPI y 4K
ApexSQL Refactor admite alta resolución de DPI y 4K, lo que significa que cuando se ejecuta ApexSQL Refactor, ventanas (por ejemplo, ventana de Opciones ) en el que configura todas las opciones del formateador SQL y la pantalla no se verá borrosa en su monitor 4K:
Nota: VS maneja muy bien 4K y alto DPI, pero SSMS no funciona tan bien en monitores 4K. Para el problema de 4K y alto DPI en SSMS 2016 y superior, existe una solución que se puede ver en Cómo habilitar el alto DPI en SSMS (SQL Server Management Studio) – Página de consejos, trucos y problemas.
