Instructions SQL de format personnalisé

info

Aperçu

Cette fonctionnalité est en aperçu public.

Cet article explique comment personnaliser les options de formatage automatique SQL dans l'interface utilisateur de Databricks.

Présentation

Le formatage SQL améliore la lisibilité et la maintenabilité de vos requêtes. En standardisant l'indentation, la casse des mots-clés et d'autres préférences stylistiques, une query bien formatée est plus facile à comprendre, à déboguer et à partager avec votre équipe.

Dans Databricks, vous pouvez configurer les options de formatage à l’aide d’un fichier .dbsql-formatter-config.json enregistré dans le répertoire d’accueil de votre workspace. Après avoir enregistré le fichier, votre code SQL est automatiquement formaté selon vos préférences lorsque vous exécutez ou formatez du code dans l’éditeur ou un notebook SQL.

Comment configurer les paramètres de formatage SQL

Pour configurer vos options personnelles de formatage SQL :

1. Cliquez sur Workspace dans la barre latérale.
2. Cliquez sur Créer > Fichier .
3. Nommez le fichier .dbsql-formatter-config.json.
4. Ajoutez les paramètres souhaités sous forme de paires clé-valeur au format JSON. Voir Options du formateur
5. Pour appliquer les derniers paramètres de mise en forme, refresh la page.

Fichier de configuration d'exemple

L'exemple suivant montre une configuration de pipeline valide .dbsql-formatter-config.json.

JSON

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

Options du formateur

Le tableau suivant répertorie les options de configuration prises en charge.

Option	Nom du fichier de configuration	Valeurs autorisées	Par défaut	Description
Largeur d'impression	printWidth	Tout entier >= 0	100	Définit la largeur de ligne cible pour le code formaté.
Style d'indentation	indentationStyle	'spaces', 'tabs'	'spaces'	Spécifie s'il faut utiliser des espaces ou des tab pour l'indentation. Si défini, indentationWidth est ignoré.
Largeur de l'indentation	indentationWidth	Entier de 0 à 99	2	Nombre d'espaces utilisés lorsque indentationStyle est défini sur 'spaces'.
Casse des mots-clés	keywordCasing	'uppercase', 'lowercase', 'none'	'none'	Contrôle la mise en forme des mots-clés SQL. 'none' laisse la casse inchangée.
Casse du nom de la fonction	functionNameCasing	'uppercase', 'lowercase', 'none'	'none'	Contrôle la mise en forme des noms de fonctions SQL. 'none' laisse la casse inchangée.
Positionnement de la virgule	commaPosition	'beginning', 'end'	'end'	Contrôle où les virgules sont placées dans les listes.
Sauts de ligne entre les instructions	numNewLinesBetweenStatements	Entier de 0 à 99	1	Nombre de nouvelles lignes insérées entre les instructions.
Sauts de ligne entre les clauses	numNewLinesBetweenClauses	Entier de 0 à 99	0	Nombre de nouvelles lignes insérées entre les clauses dans une instruction.
Développer les expressions booléennes	shouldExpandExpressions	true, false	true	Développe les expressions booléennes sur des lignes distinctes.
Développer les déclarations CASE.	shouldExpandCaseStatements	true, false	true	Développe chaque clause d'une instruction CASE sur sa propre ligne.
Développer les listes IN	shouldExpandInStatements	true, false	false	Développe les éléments des listes IN sur des lignes séparées.
Développer les conditions BETWEEN	shouldExpandBetweenConditions	true, false	false	Développe les conditions BETWEEN sur des lignes distinctes.
Rompre les conditions JOIN	shouldBreakOnJoinSections	true, false	true	Sépare les conditions JOIN sur des lignes distinctes.

Option	Nom du fichier de configuration	Valeurs autorisées	Par défaut	Description
Largeur d'impression	printWidth	Tout entier >= 0	100	Définit la largeur de ligne cible pour le code formaté.
Style d'indentation	indentationStyle	'spaces', 'tabs'	'spaces'	Spécifie s'il faut utiliser des espaces ou des tab pour l'indentation. Si défini, indentationWidth est ignoré.
Largeur de l'indentation	indentationWidth	Entier de 0 à 99	2	Nombre d'espaces utilisés lorsque indentationStyle est défini sur 'spaces'.
Casse des mots-clés	keywordCasing	'uppercase', 'lowercase', 'none'	'none'	Contrôle la mise en forme des mots-clés SQL. 'none' laisse la casse inchangée.
Casse du nom de la fonction	functionNameCasing	'uppercase', 'lowercase', 'none'	'none'	Contrôle la mise en forme des noms de fonctions SQL. 'none' laisse la casse inchangée.
Positionnement de la virgule	commaPosition	'beginning', 'end'	'end'	Contrôle où les virgules sont placées dans les listes.
Sauts de ligne entre les instructions	numNewLinesBetweenStatements	Entier de 0 à 99	1	Nombre de nouvelles lignes insérées entre les instructions.
Sauts de ligne entre les clauses	numNewLinesBetweenClauses	Entier de 0 à 99	0	Nombre de nouvelles lignes insérées entre les clauses dans une instruction.
Développer les expressions booléennes	shouldExpandExpressions	true, false	true	Développe les expressions booléennes sur des lignes distinctes.
Développer les déclarations CASE.	shouldExpandCaseStatements	true, false	true	Développe chaque clause d'une instruction CASE sur sa propre ligne.
Développer les listes IN	shouldExpandInStatements	true, false	false	Développe les éléments des listes IN sur des lignes séparées.
Développer les conditions BETWEEN	shouldExpandBetweenConditions	true, false	false	Développe les conditions BETWEEN sur des lignes distinctes.
Rompre les conditions JOIN	shouldBreakOnJoinSections	true, false	true	Sépare les conditions JOIN sur des lignes distinctes.