Partager via

Instructions SQL de format personnalisé

Important

Cette fonctionnalité est disponible en préversion publique.

Cet article explique comment personnaliser les options de mise en forme automatique SQL dans l’interface utilisateur Azure Databricks.

Aperçu

La mise en forme SQL améliore la lisibilité et la maintenance de vos requêtes. En standardisant la mise en retrait, la casse des mots clés et d’autres préférences stylistiques, une requête bien mise en forme est plus facile à comprendre, déboguer et partager avec votre équipe.

Dans Azure Databricks, vous pouvez configurer des options de mise en forme à l’aide d’un .dbsql-formatter-config.json fichier enregistré dans le répertoire d’accueil de votre espace de travail. Après avoir enregistré le fichier, votre code SQL est automatiquement mis en forme en fonction de vos préférences lorsque vous exécutez ou mettez en forme du code dans l’éditeur ou dans un bloc-notes SQL.

Comment configurer les paramètres de mise en forme SQL

Pour configurer vos options de mise en forme SQL personnelles :

  1. Cliquez sur l’icône d’espace de travailEspace de travail dans la barre latérale.
  2. Cliquez sur Créer un > fichier.
  3. Nommez le fichier .dbsql-formatter-config.json.
  4. Ajoutez vos paramètres souhaités en tant que paires clé-valeur au format JSON. Afficher les options de formatage
  5. Pour appliquer les derniers paramètres de mise en forme, actualisez la page.

Exemple de fichier de configuration

L’exemple suivant montre une configuration valide .dbsql-formatter-config.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.

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