Condividi tramite


Usare i widget dei parametri

Quando si aggiunge un marcatore di parametro denominato a una query, Azure Databricks visualizza un widget di parametri nell'interfaccia utente. I widget consentono agli utenti di impostare i valori dei parametri senza modificare direttamente la query. È possibile configurare il tipo, il titolo e il valore predefinito di ogni widget.

I widget dei parametri sono supportati nell'editor SQL, nei notebook, nei dashboard di intelligenza artificiale/BI e negli spazi Genie, ma si comportano in modo diverso in queste superfici. Questa pagina descrive i widget dei parametri nell'editor SQL. Per altre superfici, vedere:

Nell'editor SQL qualsiasi tipo di parametro (String, Integer, Decimal, Date, Timestamp) può usare qualsiasi tipo di widget.

Configurare un widget di parametri

  1. È necessario aggiungere un marcatore di parametro denominato alla query. Nell'interfaccia utente viene visualizzato un widget.
  2. Fare clic sull'icona a forma di ingranaggio accanto al widget per aprire la finestra di dialogo del widget. crea finestra di dialogo per widget
  3. Impostare i campi seguenti:
    • Nome parametro: nome del parametro visualizzato nella query. Se si modifica il nome del parametro, nella finestra di dialogo del widget è necessario modificarlo anche nella query.
    • Etichetta del widget: stringa che ha descritto il widget
    • Tipo di widget: controlla il modo in cui gli utenti inserisce il valore. Vedere Tipi di widget di seguito.
    • Tipo di parametro: tipo di dati del parametro. Vedere Tipi di parametri.
  4. Fare clic lontano dalla finestra di dialogo del widget per salvare le modifiche.

Modificare, rimuovere e riordinare i widget

Modifica: fare clic sull'icona a forma di ingranaggio accanto al widget per riaprire il riquadro delle impostazioni.

Remove: eliminare l'indicatore di parametro dalla query. Il widget viene rimosso automaticamente.

Riordinare: usare il quadratino di trascinamento a sinistra di un widget per riordinare.

Tipi di widget

Azure Databricks supporta i tipi di widget seguenti per i parametri di query:

Tipo di widget Descrizione
Elenco a discesa Gli utenti devono scegliere da un elenco predefinito.
Combobox Gli utenti possono scegliere da un elenco predefinito o digitare un valore personalizzato.
Input di testo Accetta qualsiasi valore in formato libero senza suggerimenti.
Multiselect Gli utenti possono selezionare più di un valore da un elenco predefinito.
Elenco a discesa dinamico Popola le scelte da una query salvata anziché da un elenco statico.
Intervallo di date e timestamp Definisce un intervallo iniziale e finale usando i parametri .min e .max.

Input di testo

Accetta un valore in formato libero direttamente dall'utente. Usare questo widget quando non sono necessarie opzioni predefinite.

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

Presenta un elenco predefinito di valori. Gli utenti devono selezionare dall'elenco: la voce in formato libero non è consentita. Immettere i valori consentiti nel riquadro delle impostazioni, uno per riga.

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

Per creare un tipo di widget a discesa:

  1. Fare clic sull'icona a forma di ingranaggio accanto al :status_param widget.
  2. Impostare Tipo di widget su Elenco a discesa.
  3. Impostare Tipo di parametro su String.
  4. Immettere i valori nel campo di immissione del testo Scelte per il valore del parametro. Fare clic su Aggiungi o premere INVIO tra ogni valore.

Casella combinata

Presenta un elenco predefinito di valori suggeriti, ma consente anche agli utenti di digitare un valore personalizzato non nell'elenco. Usare una casella combinata quando le opzioni comuni sono utili per praticità, ma si vuole consentire l'input in formato libero.

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

Selezione multipla

Consente agli utenti di selezionare più di un valore da un elenco predefinito. I valori selezionati vengono passati alla query come raccolta.

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

Per aggiungere opzioni per un elenco a discesa a selezione multipla:

  1. Fare clic sull'icona a forma di ingranaggio accanto al list_parameter widget.
  2. Impostare Tipo di widget su Multiselect.
  3. Impostare Tipo di parametro su String.
  4. Immettere i valori nel campo di inserimento testo Scelte per il valore del parametro. Fare clic su Aggiungi o premere INVIO tra ogni valore.

Elenco a discesa dinamico

Annotazioni

I widget a discesa dinamici sono disponibili solo nell'editor SQL, non nei notebook.

Popola l'elenco di scelte da una query salvata anziché da un elenco statico. Man mano che i dati sottostanti cambiano, le opzioni disponibili vengono aggiornate automaticamente.

Per usare un elenco a discesa dinamico:

  1. Creare e salvare una query che restituisce i valori desiderati nell'elenco a discesa:

    SELECT DISTINCT c_mktsegment FROM samples.tpch.customer ORDER BY c_mktsegment
    
  2. In una query nuova o esistente aggiungere un marcatore di parametro denominato:

    SELECT c_custkey, c_name, c_acctbal
    FROM samples.tpch.customer
    WHERE c_mktsegment = :segment_param
    
  3. Fare clic sull'icona a forma di ingranaggio accanto al segment_param widget.

  4. Impostare Tipo di widget su Elenco a discesa dinamico.

  5. Fare clic sul campo Query per aprire la finestra di dialogo Seleziona query esistente . Selezionare la query salvata nel passaggio 1, quindi fare clic su Seleziona.

  6. Scegliere un valore di parametro predefinito.

  7. Fare clic su Applica modifiche.

Intervallo di date e timestamp

I parametri Date e Timestamp supportano un tipo di widget Range . Se selezionata, Azure Databricks crea due parametri usando .min e .max suffissi per definire l'inizio e la fine dell'intervallo.

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

Fare clic sull'icona a forma di fulmine blu per selezionare valori dinamici, ad todayesempio , yesterdaythis week, last week, last montho last year. Questi valori vengono aggiornati automaticamente.

Importante

I valori di data dinamica non sono compatibili con le query pianificate.