Instruções SQL de formato personalizado

info

Visualização

Esse recurso está em Public Preview.

Este artigo explica como personalizar as opções de formatação automática do site SQL na UI do site Databricks.

Visão geral

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

Em Databricks, o senhor pode configurar as opções de formatação usando um arquivo .dbsql-formatter-config.json salvo no seu diretório pessoal workspace. Depois de salvar o arquivo, o código SQL é formatado automaticamente com base em suas preferências quando o senhor executa ou formata o código no editor ou em um Notebook SQL.

Como configurar as definições de formatação do SQL

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

1. Clique em workspace na barra lateral.
2. Clique em Criar arquivo > .
3. Nomeie o arquivo como .dbsql-formatter-config.json.
4. Adicione suas configurações desejadas como par key-value no formato JSON. Veja as opções do formatador
5. Para aplicar as configurações de formatação mais recentes, refresh a página.

Exemplo de arquivo de configuração

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

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	Padrão	Descrição
Largura de impressão	printWidth	Qualquer número inteiro > = 0	100	Define a largura da linha de destino para o código formatado.
Estilo de indentação	indentationStyle	'spaces', 'tabs'	'spaces'	Especifica se os espaços ou a tabulação devem ser usados para recuo. Se definido, indentationWidth será ignorado.
Largura de indentação	indentationWidth	Inteiro de 0 a 99	2	Número de espaços usados quando indentationStyle está definido como 'spaces'.
Caixa de palavras-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 dos nomes das funções SQL. 'none' deixa o invólucro inalterado.
Posicionamento da vírgula	commaPosition	'beginning', 'end'	'end'	Controla onde as vírgulas são colocadas nas listas.
Quebras de linha entre declarações	numNewLinesBetweenStatements	Inteiro de 0 a 99	1	Número de novas linhas inseridas entre as declarações.
Quebras de linha entre as cláusulas	numNewLinesBetweenClauses	Inteiro de 0 a 99	0	Número de novas linhas inseridas entre as cláusulas em uma declaração.
Expandir expressões booleanas	shouldExpandExpressions	true, false	true	Expande expressões booleanas em linhas separadas.
Expandir as declarações CASE	shouldExpandCaseStatements	true, false	true	Expande cada cláusula em uma declaração CASE em sua própria linha.
Expandir listas IN	shouldExpandInStatements	true, false	false	Expande os itens nas listas IN em linhas separadas.
Expandir ENTRE as condições	shouldExpandBetweenConditions	true, false	false	Expande as condições BETWEEN em linhas separadas.
Condições de junção de ruptura	shouldBreakOnJoinSections	true, false	true	Quebra as condições de união em linhas separadas.