Compartilhar via


Instruções SQL de formato personalizado

Importante

Esse recurso está em Visualização Pública.

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 do SQL melhora a legibilidade e a manutenção de 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 workspace. Depois de salvar o arquivo, o código SQL é formatado automaticamente com base em suas preferências quando você executa ou formata código no editor ou em um bloco de anotações SQL.

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

Para configurar as opções de formatação do SQL pessoal:

  1. Clique no Ícone do workspaceWorkspace na barra lateral.
  2. Clique em Criar > Arquivo.
  3. Atribua um nome ao arquivo .dbsql-formatter-config.json.
  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.

Arquivo de configuração de exemplo

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 com suporte.

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