Compartilhar via

Instruções SQL de formato personalizado

Importante

Este recurso está no Public Preview.

Este artigo explica como personalizar as opções de formatação automática do SQL na interface do usuário do Azure Databricks.

Visão geral

A formatação SQL melhora a legibilidade e a manutenção das suas consultas. Ao padronizar o recuo, a caixa de palavras-chave e outras preferências estilísticas, uma consulta bem formatada é mais fácil de entender, depurar e compartilhar com sua equipe.

No Azure Databricks, você pode configurar opções de formatação usando um .dbsql-formatter-config.json arquivo salvo no diretório base do espaço de trabalho. Depois de salvar o arquivo, seu código SQL é formatado automaticamente com base em suas preferências quando você executa ou formata o código no editor ou em um bloco de anotações SQL.

Como definir configurações de formatação SQL

Para configurar suas opções pessoais de formatação SQL:

  1. Clique em Ícone do espaço de trabalhoEspaço de trabalho na barra lateral.
  2. Clique em Criar > arquivo.
  3. Dê o nome .dbsql-formatter-config.json ao ficheiro.
  4. Adicione as configurações desejadas como pares chave-valor no formato JSON. Veja as opções do Formatter
  5. Para aplicar as configurações de formatação mais recentes, atualize a página.

Exemplo de arquivo de configuração

O exemplo a seguir mostra uma configuração válida .dbsql-formatter-config.json .

{
  "printWidth": 80,
  "indentationStyle": "spaces",
  "indentationWidth": 4,
  "keywordCasing": "uppercase",
  "shouldExpandExpressions": true
}

Opções de Formatador

A tabela a seguir lista as opções de configuração suportadas.

Opção Nome do arquivo de configuração Valores permitidos Predefinido Descrição
Largura de impressão printWidth Qualquer inteiro maior ou igual a > 0 100 Define a largura da linha de destino para o código formatado.
Estilo de recuo indentationStyle 'spaces', 'tabs' 'spaces' Especifica se espaços ou tabulações devem ser usados para indentação. Se definido, indentationWidth é ignorado.
Largura de indentação indentationWidth Inteiro de 0 a 99 2 Número de espaços usados quando indentationStyle definido como 'spaces'.
Invólucro de palavra-chave keywordCasing 'uppercase', 'lowercase', 'none' 'none' Controla a formatação de palavras-chave SQL. 'none' deixa o invólucro inalterado.
Invólucro do nome da função functionNameCasing 'uppercase', 'lowercase', 'none' 'none' Controla a formatação de nomes de funções SQL. 'none' deixa o invólucro inalterado.
Colocação de vírgulas commaPosition 'beginning', 'end' 'end' Controla onde vírgulas são colocadas em listas.
Quebras de linha entre instruções numNewLinesBetweenStatements Inteiro de 0 a 99 1 Número de novas linhas inseridas entre as instruções.
Quebras de linha entre cláusulas numNewLinesBetweenClauses Inteiro de 0 a 99 0 Número de novas linhas inseridas entre cláusulas dentro de uma afirmação.
Expandir expressões booleanas shouldExpandExpressions true, false true Expande expressões booleanas em linhas separadas.
Expandir expressões CASE shouldExpandCaseStatements true, false true Expande cada cláusula CASE para uma linha própria.
Expandir listas IN shouldExpandInStatements true, false false Expande itens em listas "IN" para linhas separadas.
Expandir entre condições shouldExpandBetweenConditions true, false false Expande condições ENTRE em linhas separadas.
Condições de pausa JOIN shouldBreakOnJoinSections true, false true Quebra JOIN as condições em linhas separadas.