Freigeben über


Syntax der Mustache-Parameter

Von Bedeutung

Die Syntax der Mustache-Parameter wird nur im älteren SQL-Editor unterstützt. Databricks empfiehlt die Verwendung benannter Parametermarkierungen für neue Abfragen. Wenn Sie eine Abfrage mit einer mustache-Syntax in ein Notizbuch, einen AI/BI-Dashboard-Dataset-Editor oder einen Genie-Bereich kopieren, müssen Sie sie in benannte Parametermarkierungen konvertieren, bevor sie ausgeführt wird.

Im älteren SQL-Editor wird jede Zeichenfolge, die in geschweifte Klammern ({{ }}) eingeschlossen ist, als Abfrageparameter behandelt. Oberhalb des Ergebnisbereichs wird ein Widget angezeigt, in dem Sie den Parameterwert festlegen können.

Hinzufügen eines Mustache-Parameters

  1. Drücken Sie Cmd + I. Der Parameter wird an der Cursorposition eingefügt, und das Dialogfeld " Parameter hinzufügen " wird angezeigt.
  2. Geben Sie das Schlüsselwort ein, ändern Sie optional den Titel, und wählen Sie einen Typ aus.
  3. Klicken Sie auf Parameter hinzufügen.
  4. Legen Sie den Parameterwert im Widget fest.
  5. Klicken Sie auf Apply Changes.
  6. Klicke auf Speichern.

Geben Sie {{ }} alternativ direkt in die Abfrage ein, und klicken Sie im Parameter-Widget auf das Zahnradsymbol, um es zu konfigurieren.

Um die Abfrage mit einem anderen Wert erneut auszuführen, aktualisieren Sie das Widget, und klicken Sie auf "Änderungen übernehmen".

Bearbeiten, Entfernen und Neuanordnen von Parametern

Bearbeiten: Klicken Sie neben dem Parameter-Widget auf das Zahnradsymbol. Um zu verhindern, dass Benutzer, die nicht der Besitzer der Abfrage sind, den Parameterwert ändern, klicken Sie auf " Nur Ergebnisse anzeigen".

Entfernen: Löschen Sie den Parameter-Marker aus der Abfrage. Das Widget wird automatisch entfernt.

Neu anordnen: Klicken und ziehen Sie Parameter-Widgets in die gewünschte Reihenfolge.

Widgettypen

Die folgenden Widgettypen sind verfügbar:

Text

Verwendet Zeichenfolge als Eingabe. Backslash, einzelnes und doppeltes Anführungszeichen werden automatisch escaped. Azure Databricks fügt Anführungszeichen um den Wert hinzu.

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

Nummer

Nimmt eine Zahl als Eingabe an.

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

Datum und Uhrzeit

Parametrisiert Datums- und Zeitstempelwerte. Die folgenden drei Optionen stehen zur Verfügung:

Typ Präzision
Datum Tag
Datum und Uhrzeit Minute
Datum und Uhrzeit (mit Sekunden) Sekunde

Alle Datums- und Uhrzeitwerte werden als Zeichenfolgenliterale übergeben und müssen in einfache Anführungszeichen in Ihrer Abfrage eingeschlossen werden:

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

Wenn Sie eine Bereichsoption auswählen, erstellt Azure Databricks zwei Parameter mit .start und .end Suffixen:

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

Hinweis

Das Datumsbereichs-Widget liefert nur für DATE-Typ-Spalten die korrekten Ergebnisse zurück. Verwenden Sie für Zeitstempelspalten ein Datums- und Zeitbereichs-Widget.

Dynamische Datumswerte: Datums-Widgets enthalten ein blaues Blitzsymbol. Klicken Sie darauf, um dynamische Werte wie today, yesterday, this week, last week, last month oder last year auszuwählen. Diese Werte werden automatisch aktualisiert.

Von Bedeutung

Dynamische Datumswerte sind nicht mit geplanten Abfragen kompatibel.

Beschränkt die Eingabe auf eine vordefinierte statische Liste. Unterstützt die Einzelwert- und mehrfachwertauswahl.

  • Einzelner Wert: Umbrechen des Parameters in einfache Anführungszeichen in der Abfrage.

  • Mehrfachwert: Aktivieren Sie Mehrfachwerte zulassen in den Widgeteinstellungen. Verwenden Sie die Option "Anführungszeichen ", um zu steuern, ob Werte in einfache Anführungszeichen, doppelte Anführungszeichen oder keines eingeschlossen werden. Aktualisieren Sie die Klausel WHERE, so dass sie IN verwendet.

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

    Wenn doppelte Anführungszeichen ausgewählt sind, wird die Abfrage in: WHERE status IN ("value1", "value2", "value3")aufgelöst.

Dropdownlistenwerte sind Zeichenfolgen. Um Datums- oder Zeitstempel zu verwenden, geben Sie sie in das format ein, das ihre Datenquelle benötigt.

Abfragebasierte Auswahlliste

Füllt Dropdownoptionen aus einer gespeicherten Abfrage auf. Verhält sich wie eine Dropdown-Liste, aber die Optionen sind dynamisch.

  1. Wählen Sie unter "Typ " im Einstellungsbereich " Abfragebasierte Dropdownliste" aus.
  2. Klicken Sie auf das Abfragefeld , und wählen Sie eine gespeicherte Abfrage aus.

Wenn die Abfrage mehrere Spalten zurückgibt, verwendet Azure Databricks die erste Spalte. Wenn die Abfrage Spalten mit den Namen name und value zurückgibt, zeigt das Widget die Spalte name an, übergibt aber die zugehörige value zur Laufzeit an die Abfrage.

Beispiel:

SELECT user_uuid AS 'value', username AS 'name' FROM users
value Name
1001 Johan Lorenz
1002 Jane Doe
1003 Bobby-Tabellen

Der an die Datenbank zur Laufzeit übergebene Wert ist 1001, 1002oder 1003nicht der Anzeigename.

Hinweis

Die Leistung wird beeinträchtigt, wenn die Quellabfrage eine große Anzahl von Datensätzen zurückgibt.

Verwenden von Mustache-Parametern in Legacy-Dashboards

Optional können Abfragen Parameter oder statische Werte nutzen. Wenn einer Visualisierung basierend auf einer parametrisierten Abfrage ein Dashboard hinzugefügt wird, können Sie jeden Parameter so konfigurieren, dass er eine von drei Wertquellen verwendet:

  • Widget-Parameter: Gilt nur für die einzelne Visualisierung, zu der sie gehört. Die Wertauswahl wird im Visualisierungsbereich angezeigt.
  • Dashboardparameter: Kann auf mehrere Visualisierungen im gesamten Dashboard angewendet werden. Die Wertauswahl wird oben im Dashboard angezeigt. Wird standardmäßig hinzugefügt, wenn Sie einem Dashboard eine parametrisierte Visualisierung hinzufügen.
  • Statischer Wert: Ersetzt den Parameter durch einen festen Wert. Die Wertauswahl ist ausgeblendet, sodass die Dashboard-UI für Parameter, die nicht geändert werden müssen, sauber bleibt.

Um auf Parameterzuordnungseinstellungen zuzugreifen, klicken Sie auf das Kebab-Menü in einem Dashboard-Widget, und wählen Sie " Widgeteinstellungen ändern" aus.

Eigenschaften des Dashboard-Parameters

Eigentum Beschreibung
Title Der Anzeigename, der neben der Wertauswahl angezeigt wird. Standardmäßig wird das Schlüsselwort für den Parameter verwendet. Nicht für statische Parameter angezeigt.
Schlüsselwort Das Zeichenfolgenliteral für diesen Parameter in der zugrunde liegenden Abfrage. Nützlich für das Debuggen unerwarteter Ergebnisse.
Standardwert Der Wert, der verwendet wird, wenn kein anderer Wert angegeben wird. Um sie zu ändern, führen Sie die Abfrage mit dem gewünschten Wert aus, und klicken Sie auf "Speichern".
Wertquelle Steuert, wo der Parameterwert stammt. Optionen: Neuer Dashboardparameter, Vorhandener Dashboardparameter, Widget-Parameter, statischer Wert.