Formatador SQL
funcionalOrganize uma consulta sem mudar o que ela significa. O formatador é cuidadoso de propósito.
O formatador é configurável, mas é deliberadamente cauteloso. SQLly re-analisa e compara sua saída token por token com a entrada; qualquer incompatibilidade deixa seu SQL intacto. Ele pode reindentar, alterar a capitalização de palavras-chave e alinhar cláusulas sem arriscar com comentários ou literais.
Formatar SQL
Pressione ⌥⇧F (Alt+Shift+F no Windows e Linux), escolha Editar › Formatar documento, ou clique com o botão direito › Formatar documento para formatar a consulta inteira, não importa o que esteja selecionado. Para formatar apenas a seleção, pressione ⌘K ⌘F (Ctrl+K Ctrl+F) para Formatar seleção. Os dois atalhos podem ser alterados em Configurações › Espaço de trabalho › Atalhos de Teclado. Você também pode escolher Consulta › Formatar SQL, use o botão da barra de ferramentas ou execute pela paleta de comandos: com texto selecionado, apenas a seleção é formatada. Caso contrário, a consulta inteira é. Aqui está uma consulta de uma linha com as configurações padrão:
-- before select o.OrderId, c.Name, sum(l.Qty * l.Price) as total from dbo.Orders o join dbo.Customers c on c.Id = o.CustomerId left join dbo.OrderLines l on l.OrderId = o.OrderId where o.Status = 'open' and o.Total > 100 group by o.OrderId, c.Name order by total desc -- after SELECT o.OrderId, c.Name, SUM(l.Qty * l.Price) AS total FROM dbo.Orders o JOIN dbo.Customers c ON c.Id = o.CustomerId LEFT JOIN dbo.OrderLines l ON l.OrderId = o.OrderId WHERE o.Status = 'open' AND o.Total > 100 GROUP BY o.OrderId, c.Name ORDER BY total DESC
Palavras-chave e funções estão em maiúsculas, cada cláusula principal inicia uma nova linha, listas de seleção são empilhadas com uma coluna por linha, as tabelas após FROM (com seus
JOIN) e as condições após WHERE e HAVING
ficam em suas próprias linhas com recuo, e AND/OR iniciam suas linhas. Uma única instrução que cabe em 80 caracteres permanece em uma linha:
SELECT id, name FROM dbo.Users WHERE id = 1. A indentação segue as configurações de tabulação do seu editor, a menos que você escolha outra coisa.


Formatação ao escrever
O Formatação ao escrever alternador no topo de Configurações › Editor › Formatação formata enquanto você digita. Com ele ativado, pressionar Enter reformata a instrução que você está digitando, e o cursor permanece logo após o mesmo caractere que seguia antes, para que você continue digitando de onde estava. Ele vem desativado por padrão; com ele desativado, formate sob demanda com Formatar Documento (⌥⇧F no macOS, Alt+Shift+F no Windows e Linux, reconfigurável em Configurações › Espaço de trabalho › Atalhos de Teclado).
Pressionar Enter mantém o texto inalterado quando:
- o texto está selecionado ou você está editando com múltiplos cursores;
- a aba está em uma conexão Redis, cujo editor mantém comandos em vez de SQL;
- a instrução não começa com uma palavra-chave de instrução:
SELECT,INSERT,UPDATE,DELETE,WITH,CREATE,ALTER,DROP,MERGE,TRUNCATE,GRANT,REVOKE,BEGIN,DECLARE, ouEXEC.
Scripts e lotes GO
Um script com várias instruções é formatado uma instrução por vez, cada uma começando na própria linha, e o atalho de uma linha só vale quando o texto inteiro é uma única instrução. As instruções terminam em ; e, para SQL Server, em um
GO separador de lote. GO sempre fica em uma linha própria, com a mesma capitalização das suas outras palavras-chave, junto com qualquer contagem de repetição (GO 5) ou comentário que compartilha a linha:
-- before select 1 go select name from dbo.Users go -- after SELECT 1 GO SELECT name FROM dbo.Users GO
GO conta como um separador somente quando inicia uma linha que não contém nada além de uma contagem ou comentário opcional, e fica entre instruções, como
sqlcmd e o SSMS esperam. Uma coluna chamada
go no meio de uma lista de seleção, [go], e
go dentro de uma string ou comentário ficam como SQL comum. Com o dialeto em Detecção Automática, uma GO linha marca o script como SQL Server. Com o dialeto definido para outro mecanismo, GO não é um separador.
Configurações
Tudo fica em Configurações › Editor › Formatação, que tem uma pré-visualização ao vivo: cole seu próprio SQL e veja-o mudar conforme você ajusta as configurações. O jeito mais rápido de começar é um predefinição:
| Predefinição | Estilo |
|---|---|
| Padrão | O layout mostrado acima. |
| Compacto | Cláusulas curtas e listas de seleção permanecem em uma linha, e AND/OR seguem suas linhas. |
| Expandido | Vírgulas no início da linha, uma linha em branco antes das cláusulas principais, ON em sua própria linha, e operadores, tipos de dados e aliases alinhados. |
| Palavras-chave em maiúsculas / Palavras-chave em minúsculas | O layout padrão com palavras-chave e funções neste caso. |
| Preservar existente | Mantém a sua capitalização, as vírgulas e o posicionamento das cláusulas, e arruma o resto. |
Selecionar um preset reescreve todas as configurações de layout, mas mantém seus gatilhos de formato (Formatação ao escrever, Formatar ao salvar, e Formatar ao colar), então tentar um preset diferente não os desliga mais. Mudar qualquer configuração individual depois muda para Personalizado. Seções individuais cobrem maiúsculas e minúsculas de palavras-chave (no geral ou por grupo, como tipos de dados ou JOINs), caixa e aspas de identificadores, layout de cláusulas, listas de seleção, estilo de vírgulas, condições booleanas, CASE, operadores, JOINs, funções, subconsultas e CTEs, DML, DDL, comentários, indentação, comprimento de linha (120 por padrão) e instruções. A configuração de Dialeto SQL tem como padrão Auto Detect, que identifica o dialeto a partir do próprio SQL.
Formatar ao salvar e Formatar ao colar ficam em Formatar gatilhos. Ambos vêm desligados por padrão.
Posicionamento de FROM e WHERE
Duas configurações em Layout da cláusula escolhem se o corpo de uma cláusula começa na linha da palavra-chave ou em sua própria linha indentada abaixo dela:
| Opção | O que faz |
|---|---|
| Tabela após FROM | Nova linha, indentada (o padrão) coloca a primeira tabela em sua própria linha abaixo de FROM, e alinha suas JOINs com ele; um ON em sua própria linha indenta mais um nível. Mesma linha da palavra-chave mantém a tabela na linha do FROM , com JOINcolocados por Layout de JOIN configuração. |
| Primeira condição após WHERE / HAVING | Nova linha, indentada (o padrão) coloca a primeira condição em sua própria linha abaixo de WHERE ou HAVING, alinhada com as AND/OR linhas que seguem. Mesma linha da palavra-chave mantém-na na linha da palavra-chave. |
O Compacto e Preservar existente predefinições mantêm ambas na linha da palavra-chave. Um comentário escrito logo após FROM ou WHERE permanece nessa linha.
CTEs, DML e colunas de índice
Essas opções controlam como os formatos comuns de instruções são organizados:
| Opção | O que faz |
|---|---|
| Estilo CTE | Empilhado (o padrão) coloca o corpo de cada CTE em suas próprias linhas. Em linha coloca cada CTE name AS ( … ) de CTE em uma única linha. Um CTE que contém um -- comentário, ou que ultrapassaria o comprimento máximo da linha, permanece empilhado. |
| Estilo DML | Padrão (o padrão) é o layout usual. Compacto coloca um INSERT, UPDATE, DELETE, ou MERGE em uma linha quando cabe no comprimento máximo da linha. Expandido coloca cada INSERT coluna, cada VALUES item e cada UPDATE SET atribuição em sua própria linha, e nunca é colapsado por Manter consultas curtas em uma linha. |
| Colunas de índice em várias linhas | Quando um índice tem mais de uma coluna, cada coluna-chave e cada INCLUDE coluna de um CREATE INDEX fica em sua própria linha. O mesmo vale para PRIMARY KEY, UNIQUE, INDEX, e KEY listas de colunas dentro CREATE TABLE. FOREIGN KEY listas de colunas permanecem como estão. |
| Mover comentários de fim de linha junto com a expressão | Funciona em conjunto com Manter comentários na mesma linha. Com ambos ativados, um fim de linha -- comment permanece no final da linha do código depois que o formatador reorganiza essa linha. |
O Compacto e Expandido predefinições ativam as opções correspondentes deste grupo. Em CREATE INDEX … ON table (…), o nome da tabela mantém sua capitalização; ele não é mais convertido para maiúsculas como uma palavra-chave.
O autocompletar segue suas configurações
Quando você aceita uma IntelliSense
sugestão, o SQLly a insere com a formatação que o Format SQL daria à instrução: caixa de palavras-chave e funções, caixa de identificadores e aspas, JOIN e
ON posicionamento, e o restante das suas configurações de formatação. Por exemplo, com
Posicionamento da cláusula ON definido para Em nova linha, um
sugestão de junção coloca seu
ON em sua própria linha. Uma instrução curta o suficiente para Manter consultas curtas em uma linha permanece em uma linha, assim como aconteceria com o Format SQL. Se o formatador não puder alinhar seu resultado com o que você digitou, a sugestão é inserida como está.
Sem mexer no SQL
Marque uma região para o formatador deixar exatamente como está quando ele precisar ficar de fora:
-- formatter:off SELECT weird , hand_aligned , columns -- left exactly as typed FROM t; -- formatter:on
O interruptor funciona uma instrução de cada vez. Uma instrução que começa após
-- formatter:off é mantida verbatim, e toda instrução depois dela também, até um -- formatter:on. Um marcador no meio de uma instrução não protege parte dela, então termine as instruções com ; ou um GO linha. Você pode desligar os marcadores com Respeitar comentários de controle na seção de Comentários.
Formatar SQL não faz nada em conexões Redis, cujo editor contém comandos, não SQL.
Minificar SQL
No sentido inverso, uma linha compacta para um log, um payload JSON ou uma linha de comando,
Minificar SQL remove comentários comuns e colapsa todos os espaços em branco em espaços simples, deixando literais de string, identificadores entre aspas e corpos entre cifrões inalterados, para que o SQL compacto ainda funcione exatamente como o original.
-- sqlly comentários de diretiva e /*+ hint */ as dicas de otimizador são mantidas, um SQL Server GO o separador mantém a própria linha porque o servidor exige, e o SQL que não é analisado de forma limpa fica inalterado em vez de ser corrompido.
Selecione o SQL para compactar, ou posicione o cursor em uma instrução, ou não selecione nada para reduzir toda a consulta, e pressione ⌘⌥⇧F (Ctrl+Alt+Shift+F no Windows e Linux), escolha Consulta › Minificar SQL, ou execute pela paleta de comandos. O resultado chega como uma única edição desfazível, então um desfazer só devolve seu SQL formatado.