Het werken met parameterwidgets

Wanneer u een benoemde parametermarkering aan een query toevoegt, wordt in Azure Databricks een parameterwidget weergegeven in de gebruikersinterface. Met widgets kunnen gebruikers parameterwaarden instellen zonder de query rechtstreeks te bewerken. U kunt het type, de titel en de standaardwaarde van elke widget configureren.

Parameterwidgets worden ondersteund in de SQL-editor, notebooks, AI/BI-dashboards en Genie-ruimten, maar gedragen zich anders op deze oppervlakken. Op deze pagina worden parameterwidgets in de SQL-editor beschreven. Zie voor andere oppervlakken:

• Werken met dashboardparameters voor dashboards
• Queryparameters toevoegen voor Genie-ruimten
• Databricks-widgets voor notebooks

In de SQL-editor kan elk parametertype (tekenreeks, geheel getal, decimaal, datum, tijdstempel) elk widgettype gebruiken.

Een parameterwidget configureren

1. Voeg een benoemde parametermarkering toe aan uw query. Er wordt een widget weergegeven in de gebruikersinterface.
2. Klik op het tandwielpictogram naast de widget om het widgetdialoogvenster te openen.
3. Stel de volgende velden in:
   • Parameternaam: de parameternaam zoals deze wordt weergegeven in de query. Als u de parameternaam wijzigt, moet u deze in het dialoogvenster Widget ook wijzigen in de query.
   • Widgetlabel: Een tekenreeks die de widget beschrijft
   • Widgettype: Bepaalt hoe gebruikers de waarde invoeren. Zie widgettypen hieronder.
   • Parametertype: Het gegevenstype van de parameter. Zie parametertypen.
4. Klik weg van het widgetdialoogvenster om uw wijzigingen op te slaan.

Widgets bewerken, verwijderen en opnieuw ordenen

Bewerken: Klik op het tandwielpictogram naast de widget om het deelvenster Instellingen opnieuw te openen.

Verwijderen: Verwijder de parametermarkering uit de query. De widget wordt automatisch verwijderd.

Volgorde wijzigen: Gebruik de sleepgreep links van een widget om de volgorde te wijzigen.

Widgettypen

Azure Databricks ondersteunt de volgende widgettypen voor queryparameters:

Tekstinvoer

Accepteert een vrije-formulierwaarde rechtstreeks van de gebruiker. Gebruik deze widget wanneer er geen vooraf gedefinieerde opties nodig zijn.

SELECT * FROM samples.tpch.region WHERE r_name = :region_param

Vervolgkeuzelijst

Geeft een vooraf gedefinieerde lijst met waarden weer. Gebruikers moeten een keuze maken in de lijst. Vermelding in vrije vorm is niet toegestaan. Voer toegestane waarden in het deelvenster Instellingen in, één per regel.

SELECT * FROM samples.tpch.orders WHERE o_orderstatus = :status_param

Om een vervolgkeuzelijst-widgettype te maken:

1. Klik op het tandwielpictogram naast de :status_param widget.
2. Stel het widgettype in op Dropdown.
3. Stel het parametertype in op Tekenreeks.
4. Voer waarden in in het tekstinvoerveld Keuzes voor parameterwaarde. Klik op Toevoegen of druk op Enter tussen elke waarde.

Keuzelijst met invoervak

Hiermee wordt een vooraf gedefinieerde lijst met voorgestelde waarden weergegeven, maar kunnen gebruikers ook een aangepaste waarde typen die niet in de lijst staat. Gebruik een keuzelijst met invoervak wanneer algemene opties handig zijn voor het gemak, maar u wilt vrije invoer toestaan.

SELECT * FROM samples.tpch.part WHERE p_brand = :brand_param

Meervoudige selectie

Hiermee kunnen gebruikers meer dan één waarde selecteren in een vooraf gedefinieerde lijst. De geselecteerde waarden worden als verzameling doorgegeven aan de query.

SELECT * FROM samples.nyctaxi.trips WHERE
  array_contains(
    TRANSFORM(SPLIT(:list_parameter, ','), s -> TRIM(s)),
    CAST(dropoff_zip AS STRING)
  )

Opties toevoegen voor een vervolgkeuzelijst met meerdere selecties:

1. Klik op het tandwielpictogram naast de list_parameter widget.
2. Stel het widgettype in op Multiselect.
3. Stel het parametertype in op Tekenreeks.
4. Voer waarden in in het tekstinvoerveld Keuzes voor parameterwaarde. Klik op Toevoegen of druk op Enter tussen elke waarde.

Dynamische vervolgkeuzelijst

Hiermee wordt de lijst met keuzes van een opgeslagen query ingevuld in plaats van een statische lijst. Wanneer de onderliggende gegevens veranderen, worden de beschikbare opties automatisch bijgewerkt.

Een dynamische vervolgkeuzelijst gebruiken:

1. Maak en sla een query op die de gewenste waarden retourneert in de vervolgkeuzelijst:

   SELECT DISTINCT c_mktsegment FROM samples.tpch.customer ORDER BY c_mktsegment
   

2. Voeg in een nieuwe of bestaande query een benoemde parametermarkering toe:

   SELECT c_custkey, c_name, c_acctbal
   FROM samples.tpch.customer
   WHERE c_mktsegment = :segment_param
   

3. Klik op het tandwielpictogram naast de segment_param widget.

4. Stel Widgettype in op Dynamische vervolgkeuzelijst.

5. Klik op het veld Query om het dialoogvenster Bestaande query selecteren te openen. Selecteer de opgeslagen query uit stap 1 en klik vervolgens op Selecteren.

6. Kies een standaardparameterwaarde.

7. Klik op Wijzigingen toepassen.

Datum- en tijdstempelbereik

Datum- en tijdstempelparameters ondersteunen een widgettype Bereik. Wanneer deze optie is geselecteerd, maakt Azure Databricks twee parameters met behulp van .min en .max achtervoegsels om het begin en einde van het bereik te definiëren.

SELECT * FROM samples.nyctaxi.trips
WHERE tpep_pickup_datetime
BETWEEN CAST(:date_range_min AS TIMESTAMP) AND CAST(:date_range_max AS TIMESTAMP)

Klik op het blauwe bliksemschichtpictogram om dynamische waarden te selecteren, zoals today, yesterdaythis week, , last week, of last monthlast year. Deze waarden worden automatisch bijgewerkt.