Índice
- Opções de formato T SQL
- Visualização do impacto
- Perfis do formatador SQL
- Importação / exportação de perfis do formatador SQL
- Formatar o objeto em lote
- Formatar scripts T-SQL em lote
- Integração de host
- Suporte de alta resolução DPI e 4K
Ninguém gosta de verificar e ler uma tonelada de texto confuso e não formatado. Quando se trata de ler um código SQL complexo, esse problema pode se tornar ainda mais difícil, especialmente se você é quem precisa desemaranhá-lo.
O código SQL pode ser formatado com um estilo que torna a leitura dele mais fácil , especialmente se toda a equipe usar o mesmo. O código SQL limpo e bem formatado (consistente) pode ser lido muito mais rápido do que o código SQL escrito de forma inconsistente, seja a inconsistência entre os membros da equipe e objetos diferentes ou até mesmo dentro do mesmo script do próprio objeto. Um código SQL bem organizado e formatado pode ser revisado com mais eficiência. Transferir um projeto para outra equipe ou cliente com código SQL bem formatado será muito mais fácil e muito mais apreciado.
O principal problema com a formatação de script SQL é que não há estilo ou padrões de como o SQL o código deve ser formatado e tudo geralmente é uma questão de preferência. A melhor solução aqui é definir os padrões que você e sua equipe na empresa seguirão e, em seguida, garantir que sejam aplicados de maneira consistente.
Todo código SQL pode ser formatado manualmente, o que consome muito tempo mas existem ferramentas de terceiros que podem ser usadas para formatar de forma rápida e eficiente.
Este artigo irá descrever e apresentar algumas diretrizes básicas e expectativas sobre o que uma ferramenta de formatação de consulta SQL perfeita deve ter para atender a sua meta para estabelecer um estilo de formato consistente e padrão (padrão) e como aplicar esse estilo a um script T-SQL ou muitos scripts T-SQL ou objetos em um clique.
Uma dessas ferramentas de formatação é o Refactor ApexSQL, add-in que pode ser integrado no SQL Server Management Studio (SSMS) ou Visual Studio (VS). O ApexSQL Refactor tem mais de 200 opções e recursos de formatação de consulta SQL para aplicar um estilo em um ou em scripts T-SQL em massa de uma vez.
Opções
O primeiro objetivo é definir opções básicas. Uma das principais preocupações quando se trata de estabelecer padrões é quais palavras-chave T-SQL devem ou não ser capitalizadas no código.
Na guia Capitalização da janela Opções, as regras de capitalização podem ser definidas para o seguinte:
Para definir a regra apropriada para letras maiúsculas, as seguintes opções podem ser usadas: MAIÚSCULAS, minúsculas, inferiorCamelCase, SuperiorCamelCase , Caso adequado ou deixando as regras de layout de consulta SQL padrão, desmarcando a opção:
Alguns desenvolvedores preferem palavras-chave SQL, tipos de dados , etc. para estar em MAIÚSCULAS e outros desenvolvedores, no entanto, como as palavras-chave SQL em minúsculas.
A melhor solução ao escolher uma ferramenta é selecionar uma que possa lidar com todas essas preferências diferentes.
No primeiro exemplo, as palavras-chave são maiúsculas e os tipos de dados são minúsculos:
No segundo exemplo, as palavras-chave são minúsculas e da os tipos ta são maiúsculas:
O terceiro exemplo, palavras-chave e tipos de dados são maiúsculas:
Visualização do impacto do formatador SQL
Uma das coisas críticas que toda ferramenta de layout SQL deve ter é ser capaz de visualizar visualmente como o código SQL fica após adicionar algumas opções.
ApexSQL Refactor tem uma visualização do impacto do formato do código SQL que mostra uma visão clara do impacto de qualquer mudança de opção imediatamente quando você as faz. Se você não gosta de sua aparência, pode ser facilmente alterado e revertido sem salvar:
Definindo as regras para letras maiúsculas de palavras-chave SQL, tipos de dados, identificadores (nomes de objetos), funções de sistema, variáveis são apenas um item no conjunto do estilo.
Regras de layout de código SQL para apelidos, comentários, vírgulas, espaçamento, alinhamento, etc., também precisa ser definido para ter um código SQL bom, consistente, legível e bem formatado.
Para todas as coisas mencionadas acima, uma ferramenta de formatação precisa ter opções de configuração. Regras de estilo de consulta SQL.
ApexSQL Refactor tem todas essas opções para atender aos seus requisitos.Mais sobre as opções do formatador SQL podem ser encontradas nos links abaixo:
- Regras de formatação SQL – Vírgulas e espaçamento em T-SQL
- Regras de formatação SQL – Regular e delimitado Identificadores T-SQL
- Regras de formatação SQL – comentários de código SQL
- Regras de formatação SQL – convenções de nomenclatura SQL e regras de capitalização
- Regras de formatação SQL – Encerramento Instruções SQL com ponto e vírgula
Perfis do formatador de consulta SQL
Ser capaz de definir um estilo desejado, salvar esse estilo e compartilhar o estilo com os colegas é outra coisa que todo SQL Server ferramenta de formatação precisa ter. Além disso, tendo uma seleção predefinida de perfis pré-configurados, pronto para uso é muito útil.
Com o ApexSQL Refactor, os usuários podem:
- salvar preferencial Opções do formatador de consulta SQL para um perfil reutilizável
- agrupar e categorizar estilos de formatação
- modificar rapidamente perfis existentes
- evitar conflitos com outros usuários
Além disso, ApexSQL Refactor vem com quatro perfis embutidos
- ApexSQL – contém o que determinamos ser um bom padrão de formatador SQL
- Compact – opção de conjuntos de indentações para 0 (zero) espaço, todos os espaços adicionais são desmarcados e as linhas vazias são removidas para uma consulta onde o código SQL parece denso
- Estendido – é o oposto do perfil Compacto. Este perfil adiciona linhas vazias antes / depois de cada declaração, comentários. Adicione espaço em torno de operadores lógicos e aritméticos
- MSDN SQL BOL – imita o estilo usado no site de recursos do MSDN
Esses quatro perfis integrados não podem ser alterados de nenhuma forma , mas uma cópia desses perfis integrados do formatador de consulta SQL pode ser feita clicando no botão Copiar e, em seguida, pode ser alterada da maneira preferida:
Além disso, um novo perfil do formatador SQL pode ser criado clicando no botão Novo:
Importando / Exportando perfis de formato SQL
Depois de criar o perfil perfeito, é importante poder exportá-lo para torná-lo acessível a outras pessoas; bem como para os destinatários do perfil poderem importá-lo facilmente. ApexSQL Refactor fornece apenas esta funcionalidade
Para exportar perfis e compartilhar com colegas, pressione o botão Exportar na janela Opções:
Para importar perfis na janela Opções, pressione o botão Importar.
Mais sobre perfis ApexSQL Refactor podem ser encontrados na página Como personalizar perfis de formatação SQL.
Processando objetos em um lote
Depois que o perfil de formato é criado e as opções são definidas, a formatação do código SQL pode começar a sério, com um objeto ou script de cada vez. Mas que tal processar tudo em um banco de dados de uma vez?
Processar muitos objetos SQL, como procedimentos armazenados, individualmente pode ser uma tarefa muito difícil e demorada, é claro.
Então , outra coisa que podemos adicionar é que cada ferramenta de formatação deve ter um recurso que pode formatar vários objetos SQL com um único perfil SQL desejado de uma vez.
ApexSQL Refactor tem o recurso Formatar objetos SQL que permite exatamente que. No Pesquisador de Objetos, selecione um banco de dados onde estão localizados os objetos que se deseja formatar, clique com o botão direito e, no menu de contexto, escolha o comando Formatar objetos SQL:
Todos os objetos baseados em script, por exemplo visualização, os procedimentos armazenados serão listados na janela Formatar objetos SQL:
Na caixa de combinação Perfil, selecione o SQL desejado perfil do formatador (por exemplo, ApexSQL) e, na lista, escolha os objetos SQL que deseja formatar, clique no botão Criar script, que abrirá um script no editor de consultas, a seguir clique no botão Executar (F5):
Para confirmar se os objetos SQL estão formatados com o perfil desejado, volte para a janela Formatar objetos SQL, na caixa de combinação Perfil, escolha um perfil e, na lista de objetos SQL, na coluna OK com ícone de marca de seleção verde, os objetos SQL que estão formatados serão indicados, todos os outros objetos SQL serão marcados com o ícone x vermelho que indica que eles não estão formatados com o perfil selecionado :
Além disso, antes de formatar um script de objeto SQL com o perfil desejado, os mesmos scripts SQL podem ser mostrados para que o usuário pode ver e como ficará depois de processado. Desta forma, ele pode ser comparado selecionando um objeto SQL desejado na lista, clique com o botão direito e selecione o botão Comparar:
Scripts em lote Formato T-SQL
Mais uma coisa que precisa ser levada em consideração, ao escolher a ferramenta de layout SQL certa, é a possibilidade de formatar scripts SQL e scripts em pastas em lotes.
Em situações em que, na máquina, há muitos scripts SQL cujo código precisa ser verificado e esse código está uma grande bagunça, como na imagem abaixo:
Verificar o código nesses scripts SQL pode ser desafiador.
Uma solução para isso é abrir o script SQL no SSMS e formate-o com seu perfil preferido clicando no botão Formatar SQL:
Isso resolve um problema para um script SQL, mas para mais desses scripts SQL, uma solução mais rápida precisa ser fornecida.
O ApexSQL Refactor oferece o recurso Formatar scripts SQL como uma solução para esse tipo de problema. No menu ApexSQL Refactor, no submenu Outra formatação, selecione o comando Formatar scripts SQL:
O formato SQL abrirá a janela de scripts, na lista navegue e selecione os scripts SQL, escolha o perfil do formatador SQL desejado na caixa de combinação Perfil e pressione o botão OK:
Todo o código nos scripts SQL selecionados será formatado com o estilo do formatador SQL desejado, o que torna muito mais fácil revisar os scripts SQL.
Integração de host
Outro importante item ao escolher a ferramenta de estilo SQL certa é sua integração direta em aplicativos de host que você normalmente usa para codificação SQL como SSMS ou Visual Studio.
Felizmente, o ApexSQL Refactor oferece suporte à integração do SSMS 2012 e superior e à integração com o Visual Studio da versão VS 2010 e superior.
Isso significa que você pode adicionar poderosos recursos de formatador de SQL e melhorar sua produtividade de codificação sem nunca abandonar a casa do seu editor favorito
Integração perfeita com o host e experiência do usuário consistente
A integração em um aplicativo host é uma coisa. A integração perfeita com uma experiência consistente do usuário final é outra. Muitos suplementos são convidados ruins, ocupando espaço de menu, oferecendo cores e ícones desarticulados e geralmente sendo visualmente “barulhentos” e intrusivos. ApexSQL Refactor é um convidado educado que se integra perfeitamente em ambientes de host, quase como se fosse parte do próprio IDE. Esta experiência de usuário consistente inclui iconografia, estilo visual e temas.
Os temas de cores permitem que o usuário modifique a aparência visual para se adequar às suas preferências e uma boa ferramenta de terceiros deve corresponder a esse recurso. ApexSQL Refactor suporta SSMS e cores visuais temas, mas melhor ainda, mudarão automaticamente para se adaptar às configurações do tema do host.
Consulte este artigo para saber mais.
Tema de cor escura do Visual Studio:
Tema de cor azul SSMS:
Uma observação , ApexSQL Refactor suporta tema de cor escura SSMS:
Mesmo que o tema de cor ainda não seja oficial; para aqueles que desejam sabe como configurar o d O tema de cores ark no SSMS 17 pode ser encontrado na página Configurando o tema escuro no estúdio de gerenciamento do SQL Server.
Além disso, todos os ícones que aparecem em comandos, diálogos, modelos, etc. no ApexSQL Refactor são herdados da Biblioteca de Imagens do Visual Studio. Alguns dos ícones da biblioteca foram reprojetados para serem mais intuitivos, simples e são símbolos facilmente reconhecidos.
Mais podem ser encontrados no Dicionário de Linguagem Visual para Visual Studio para iconografia, cores e outros conceitos visuais aplicados em Página de ferramentas / suplementos do ApexSQL.
Suporte a alta resolução de DPI e 4K
ApexSQL Refactor oferece suporte a alta resolução de DPI e 4K, o que significa que quando o ApexSQL Refactor é executado, janelas (por exemplo, janela de opções ) em que você configura todas as opções do formatador SQL e a tela não fica desfocada no monitor de 4K:
Observação: VS lida muito bem com 4K e alto DPI, mas o SSMS não funciona tão bem em monitores 4K. Para o problema de 4K e alto DPI no SSMS 2016 e superior, há uma solução que pode ser vista na página Como habilitar o alto DPI no SSMS (SQL Server Management Studio) – Dicas, truques e problemas.
