Como formatar SQL com indentação e palavras-chave em maiúsculas

Para que serve formatar SQL?

O SQL Formatter serve para reorganizar texto SQL, melhorar a indentação e apresentar as palavras-chave SQL em maiúsculas. É útil quando pretende tornar uma consulta mais fácil de ler antes de a rever ou partilhar. A ferramenta trabalha sobre o texto fornecido: não deve ser tratada como um executor de SQL nem como uma ferramenta para confirmar os resultados de uma consulta.

Como formatar uma consulta SQL

1. Cole a consulta SQL no campo de entrada. O texto deve ser uma cadeia de caracteres. Se deixar o campo vazio ou fornecer apenas espaços em branco, o resultado formatado será vazio. Quando não é fornecido SQL, a entrada assume esse valor vazio por predefinição.

2. Defina a indentação pretendida. Para uma entrada com conteúdo, o valor é convertido para um número inteiro. Valores não convertíveis, inferiores a 0 ou superiores a 8 passam a usar 2; os restantes valores convertidos são utilizados. Selecione 2 para uma apresentação equilibrada, salvo se o seu padrão de projeto exigir outra opção.

3. Se existir um campo de dialeto, pode preenchê-lo, mas não conte com regras específicas desse dialeto: o valor é aceite, sem selecionar um tratamento de formatação próprio para cada variante de SQL.

4. Execute a formatação e reveja o texto devolvido. Quando a análise e a formatação têm sucesso, o resultado é reindentado e as palavras-chave SQL aparecem em maiúsculas. Se o texto contiver várias instruções reconhecidas, estas são unidas por ponto e vírgula e mudança de linha, com um ponto e vírgula final.

5. Se a ferramenta recusar o conteúdo, confirme primeiro se o valor é texto, se não ultrapassa 1 000 000 de bytes em UTF-8 e se contém instruções SQL que possam ser detetadas. A formatação também pode falhar se a biblioteca de análise não estiver disponível ou se ocorrer um erro durante o processamento.

Como interpretar o resultado

Um resultado formatado indica que o texto foi reorganizado de acordo com o caminho de análise disponível, não que a consulta foi executada ou validada. Verifique nomes de tabelas, colunas, filtros, junções e comentários por sua conta, sobretudo quando o SQL provém de outra ferramenta.

A opção de dialeto não confirma compatibilidade com uma variante específica. Do mesmo modo, a formatação pode alterar espaços, quebras de linha e a apresentação das instruções sem garantir a preservação literal do texto original. Para várias instruções, procure o separador entre cada uma e o ponto e vírgula colocado no fim do resultado.

Se uma entrada só tiver espaços, receber um resultado vazio é o comportamento previsto. Já uma entrada com conteúdo pode gerar uma falha quando não forem detetadas instruções SQL ou quando surgir um problema no processamento; nesse caso, simplifique o texto e reveja a sintaxe antes de tentar novamente.

Exemplo prático

Está a preparar duas consultas SQL para revisão e pretende que a estrutura e os separadores fiquem mais legíveis.

Cole select id, nome from clientes; select id from encomendas;, mantenha a indentação em 2 e execute a formatação.

O resultado esperado é texto SQL reindentado, com palavras-chave em maiúsculas; se forem fornecidas duas instruções reconhecidas, aparecem separadas por ponto e vírgula e mudança de linha, com um ponto e vírgula final.

Limitações

• O campo de dialeto não aplica regras específicas de cada dialeto, e a formatação pode falhar por problemas de análise, ausência de instruções detetáveis ou entrada superior a 1 000 000 de bytes em UTF-8.

Erros comuns

• Colar um valor que não é texto, exceder 1 000 000 de bytes em UTF-8 ou enviar conteúdo sem instruções SQL detetáveis pode impedir a formatação. Corrija o tipo e o tamanho da entrada e reduza o conteúdo a SQL analisável antes de repetir.

Perguntas frequentes

Que valor de indentação devo escolher?

Com uma entrada apenas de espaços em branco, o resultado é vazio. Com SQL não vazio, o valor é convertido para inteiro; valores inválidos ou fora do intervalo de 0 a 8 usam 2.

A ferramenta valida o dialeto SQL que selecionei?

O dialeto pode ser aceite como entrada, mas o formatador não aplica regras específicas de cada dialeto no caminho de formatação disponível.

A formatação confirma que a minha consulta funciona?

Não. O resultado é texto SQL reindentado e com palavras-chave em maiúsculas; a ferramenta não deve ser usada para executar a consulta ou confirmar os seus resultados.