Partager via

Syntaxe des paramètres Mustache

Important

La syntaxe des paramètres Mustache est prise en charge uniquement dans l’éditeur SQL hérité. Databricks recommande d’utiliser des marqueurs de paramètres nommés pour les nouvelles requêtes. Si vous copiez une requête à l’aide de la syntaxe de moustache dans un bloc-notes, un éditeur de jeu de données de tableau de bord IA/BI ou un espace Génie, vous devez le convertir en marqueurs de paramètres nommés avant son exécution.

Dans l’éditeur SQL hérité, toute chaîne encapsulée dans des accolades doubles ({{ }}) est traitée comme un paramètre de requête. Un widget apparaît au-dessus du volet de résultats, où vous définissez la valeur du paramètre.

Ajouter un paramètre moustache

  1. Appuyez sur Cmd + I. Le paramètre est inséré à la position du curseur et la boîte de dialogue Ajouter un paramètre s’affiche.
  2. Entrez le mot clé, modifiez éventuellement le titre, puis sélectionnez un type.
  3. Cliquez sur Ajouter un paramètre.
  4. Définissez la valeur du paramètre dans le widget.
  5. Cliquez sur Appliquer les modifications.
  6. Cliquez sur Enregistrer.

Vous pouvez également taper {{ }} directement dans la requête et cliquer sur l’icône d’engrenage dans le widget de paramètre pour le configurer.

Pour réexécuter la requête avec une autre valeur, mettez à jour le widget et cliquez sur Appliquer les modifications.

Modifier, supprimer et réorganiser les paramètres

Modifier : cliquez sur l’icône d’engrenage en regard du widget de paramètre. Pour empêcher les utilisateurs qui ne possèdent pas la requête de modifier la valeur du paramètre, cliquez sur Afficher les résultats uniquement.

Supprimer : supprimez le marqueur de paramètre de la requête. Le widget est supprimé automatiquement.

Réorganiser : cliquez et faites glisser des widgets de paramètres vers l’ordre souhaité.

Types de widgets

Les types de widgets suivants sont disponibles :

Texte

Accepte une chaîne comme entrée. Les antislashs, les guillemets simples et doubles sont automatiquement échappés. Azure Databricks ajoute des guillemets autour de la valeur.

SELECT * FROM samples.tpch.customer WHERE c_name = {{ name_param }}

Numéro

Prend un nombre comme entrée.

SELECT * FROM users WHERE age = {{ number_param }}

Date et heure

Paramétre les valeurs de date et d’horodatage. Trois options sont disponibles :

Type Précision
Date Jour
Date et heure Minute
Date et heure (avec secondes) Second

Toutes les valeurs de date et d’heure sont passées en tant que littéraux de chaîne et doivent être encapsulées entre guillemets simples dans votre requête :

SELECT * FROM usage_logs WHERE date = '{{ date_param }}'

Lorsque vous sélectionnez une option Range , Azure Databricks crée deux paramètres à l’aide .start et .end des suffixes :

SELECT * FROM usage_logs
WHERE modified_time > '{{ date_range.start }}'
AND modified_time < '{{ date_range.end }}'

Note

Le widget Plage de dates retourne les résultats corrects uniquement pour les colonnes de type DATE. Pour les colonnes d’horodatage, utilisez un widget de plage de dates et d'heures.

Valeurs de date dynamiques : les widgets date incluent une icône de éclair bleu. Cliquez dessus pour sélectionner des valeurs dynamiques telles que today, , yesterdaythis week, last week, last month, ou last year. Ces valeurs sont mises à jour automatiquement.

Important

Les valeurs de date dynamique ne sont pas compatibles avec les requêtes planifiées.

Limite l’entrée à une liste statique prédéfinie. Prend en charge à la fois la sélection à valeur unique et à valeurs multiples.

  • Valeur unique : encapsulez le paramètre entre guillemets simples dans la requête.

  • Valeur multiple : activez autoriser plusieurs valeurs dans les paramètres du widget. Utilisez l’option Guillemets pour contrôler si les valeurs sont encapsulées entre guillemets simples, guillemets doubles ou aucun. Mettez à jour votre WHERE clause pour utiliser IN:

    SELECT * FROM orders WHERE status IN ( {{ status_param }} )

    Avec des guillemets doubles sélectionnés, la requête se résout en : WHERE status IN ("value1", "value2", "value3").

Les valeurs de liste déroulante sont des chaînes. Pour utiliser des dates ou des horodatages, entrez-les dans le format requis par votre source de données.

Liste déroulante basée sur une requête

Remplit les choix de liste déroulante d’une requête enregistrée. Se comporte comme liste déroulante, mais les options sont dynamiques.

  1. Sous Type dans le panneau paramètres, sélectionnez Liste déroulante basée sur la requête.
  2. Cliquez sur le champ Requête et sélectionnez une requête enregistrée.

Si la requête retourne plusieurs colonnes, Azure Databricks utilise la première colonne. Si la requête retourne des colonnes nommées name et value, le widget affiche la colonne name mais passe la valeur associée value à la requête lors de l'exécution.

Exemple :

SELECT user_uuid AS 'value', username AS 'name' FROM users
valeur nom
1 001 John Smith
1002 Jane Doe
1003 Bobby Tables

La valeur passée à la base de données au moment de l’exécution est 1001, 1002ou 1003, pas le nom complet.

Note

Les performances se dégradent si la requête source retourne un grand nombre d’enregistrements.

Utiliser des paramètres de moustache dans les tableaux de bord hérités

Les requêtes peuvent éventuellement utiliser des paramètres ou des valeurs statiques. Lorsqu’une visualisation basée sur une requête paramétrable est ajoutée à un tableau de bord, vous pouvez configurer chaque paramètre pour utiliser l’une des trois sources de valeur :

  • Paramètre de widget : s’applique uniquement à la visualisation unique à laquelle elle appartient. Le sélecteur de valeur s’affiche dans le panneau de visualisation.
  • Paramètre de tableau de bord : peut s’appliquer à plusieurs visualisations dans le tableau de bord. Le sélecteur de valeur apparaît en haut du tableau de bord. Ajouté par défaut lorsque vous ajoutez une visualisation paramétrable à un tableau de bord.
  • Valeur statique : remplace le paramètre par une valeur fixe. Le sélecteur de valeur est masqué, ce qui permet de nettoyer l’interface utilisateur du tableau de bord pour les paramètres qui n’ont pas besoin de changer.

Pour accéder aux paramètres de mappage de paramètres, cliquez sur le menu kebab d’un widget de tableau de bord, puis sélectionnez Modifier les paramètres du widget.

Propriétés des paramètres du tableau de bord

Propriété Description
Titre Nom affiché à côté du sélecteur de valeur. Utilise par défaut le mot-clé du paramètre. Non affiché pour les paramètres statiques.
Mot clé Littéral de chaîne pour ce paramètre dans la requête sous-jacente. Utile pour déboguer des résultats inattendus.
Valeur par défaut Valeur utilisée lorsqu’aucune autre valeur n’est spécifiée. Pour le modifier, exécutez la requête avec la valeur souhaitée, puis cliquez sur Enregistrer.
Source de valeur Contrôle l’emplacement à partir duquel provient la valeur du paramètre. Options : Nouveau paramètre de tableau de bord, paramètre de tableau de bord existant, paramètre widget, valeur statique.
  • Last updated on