Usa i parametri con le viste metriche

I parametri consentono di passare valori in una visualizzazione metrica quando si esegue una query. Usare i parametri per riutilizzare una singola definizione di visualizzazione delle metriche in input diversi, ad esempio una tariffa di sconto o una finestra della data. Fare riferimento a un parametro in qualsiasi punto in cui un'espressione SQL costante è valida, ad esempio nei filtri, nelle espressioni di campo e di misura, nell'origine e nei join. Puoi anche fare riferimento a un parametro intero come valore di una misura range di finestra o offset, così un chiamante passa la dimensione della finestra in al momento della query. Passa un valore come argomento quando interroghi la vista.

I parametri riducono la duplicazione. Anziché mantenere una visualizzazione metrica separata per ogni variante, definire la logica una sola volta e consentire a ogni chiamante di fornire i propri valori. Un parametro può includere un valore predefinito, quindi i chiamanti che non passano un argomento fallback all'impostazione predefinita.

È possibile passare i valori dei parametri da una query SQL o da un dashboard di intelligenza artificiale/BI. In un dashboard connettere un parametro a un widget di filtro per consentire ai visualizzatori di scegliere il valore in fase di esecuzione. Vedi Usare una query con parametri in una dashboard.

Requisiti

Limitazioni

Le limitazioni seguenti si applicano alle visualizzazioni delle metriche che definiscono i parametri:

  • Non è possibile materializzare una visualizzazione metrica che definisce i parametri.
  • I valori predefiniti hanno restrizioni. Un valore predefinito deve poter essere convertito nel tipo di dati dichiarato del parametro e non può fare riferimento a un altro parametro né contenere una subquery. Se si imposta un valore predefinito per un parametro, ogni parametro che segue deve avere anche un valore predefinito. Vedere Parametri.

Definisci parametri

È possibile definire i parametri nell'editor a basso codice di Esplora cataloghi o direttamente in YAML. Dopo aver creato un parametro, puoi farvi riferimento per nome ovunque sia consentita un'espressione SQL costante, ad esempio nei filtri, nelle espressioni di campi e misure, nell'origine dati e nei join. Puoi anche fare riferimento a un parametro intero come valore di una misura range finestra o offset. Vedi Dimensioni della finestra.

Per definire i parametri in YAML, aggiungere un blocco di primo livello parameters alla definizione della visualizzazione delle metriche. Per informazioni di riferimento sul campo completo e un esempio YAML, vedere Parametri.

La procedura seguente usa l'editor a basso codice di Esplora cataloghi e la samples.tpch.orders tabella, disponibile in ogni area di lavoro, per creare una visualizzazione delle metriche con un discount parametro e due misure. Una misura applica il parametro e l'altra calcola il totale senza conteggio in modo da poter confrontare i due.

Passaggio 1: Creare una visualizzazione delle metriche

Creare una visualizzazione metrica per contenere il parametro e le misure.

  1. Fare clic sull'icona Dati.Catalogo nella barra laterale dell'area di lavoro, quindi usare la barra di ricerca per trovare samples.tpch.orders e fare clic sul nome della tabella.
  2. Fare clic su Crea>visualizzazione metrica.
  3. Nella finestra di dialogo Crea visualizzazione metriche immettere un nome, quindi selezionare un catalogo e uno schema in cui creare la visualizzazione delle metriche. Clicca su Crea.

L'editor viene aperto nella scheda dell'interfaccia utente . Per una procedura dettagliata completa dell'editor di visualizzazione delle metriche, vedere Creare una visualizzazione delle metriche.

Passaggio 2: Aggiungere un parametro

Aggiungere un parametro con un discount tipo numerico e un valore predefinito.

  1. Nell'intestazione dell'editor fare clic su Aggiungi parametro.

  2. Nella finestra di dialogo Dettagli parametro :

    1. Immettere discount per Nome.
    2. Scegliere Numerico dal menu a discesa Tipo.
    3. Scegliere Double dall'elenco a discesa Tipo numerico visualizzato.

    Il pulsante Aggiungi parametro e la finestra di dialogo Dettagli del parametro con un parametro di sconto impostato sul tipo Numerico e sul tipo numerico Double.

  3. Fare clic lontano dalla finestra di dialogo per chiuderla, quindi immettere 0.15 come valore predefinito per lo sconto.

    Parametro discount con valore predefinito 0,15.

Il parametro viene visualizzato nell'intestazione dell'editor dopo averlo creato. Il valore impostato qui è l'impostazione predefinita che si applica quando una query omette l'argomento.

Passaggio 3: Aggiungere una misura che usa il parametro

Fare riferimento al parametro per nome in un'espressione di una misura. Questa misura applica lo sconto a ogni totale dell'ordine.

  1. Fare clic sulla scheda Misure nella parte superiore dell'editor.

  2. Fare clic su + Aggiungi.

  3. Inserire Discounted Sales come Nome della misura.

  4. Fare clic su Personalizzato, quindi immettere l'espressione seguente:

    SUM((1 - discount) * source.o_totalprice)
    

Passaggio 4: Aggiungere un'altra misura

Aggiungere una seconda misura per il totale non scontato.

  1. Fare clic su + Aggiungi.
  2. Inserire Total Sales come Nome della misura.
  3. In Generatore selezionare source.o_totalprice e l'aggregazione Sum per produrre SUM(source.o_totalprice).

Passaggio 5: Salvare la visualizzazione delle metriche

Fare clic su Salva. Per eseguire una query sulla visualizzazione delle metriche e passare un valore per il discount parametro, vedere Eseguire query su una vista metrica con parametri.

Eseguire una query su una vista delle metriche con parametri

Per eseguire query su una vista metrica che definisce i parametri, chiamare la vista metrica come funzione con valori di tabella e passare parametri come argomenti. È possibile passare argomenti per nome o posizione oppure ometterli per usare i valori predefiniti.

Passare gli argomenti per nome

Per passare un argomento per nome, usare l'operatore => . Nell'esempio seguente viene passato un discount valore di 0.15:

SELECT product, MEASURE(discountedSales)
FROM catalog.schema.metric_view(discount => 0.15)
GROUP BY product;

Passare argomenti per posizione

Per passare argomenti per posizione, elencare i valori nell'ordine in cui sono definiti i parametri. Nell'esempio seguente viene passato lo stesso discount valore di 0.15:

SELECT product, MEASURE(discountedSales)
FROM catalog.schema.metric_view(0.15)
GROUP BY product;

Usare i valori dei parametri predefiniti

Per usare i valori predefiniti dei parametri quando si richiama la vista delle metriche, omettere gli argomenti. Le query seguenti sono equivalenti e usano tutti i valori predefiniti:

SELECT product, MEASURE(discountedSales) FROM catalog.schema.metric_view() GROUP BY product;
SELECT product, MEASURE(discountedSales) FROM catalog.schema.metric_view GROUP BY product;

Visualizzare i parametri definiti da una vista metrica

Per visualizzare i parametri definiti da una visualizzazione metrica, visualizzarne la definizione YAML, che include il parameters blocco. Consulta Definizione e metadati della vista metrica.

Usa una query con parametri in una dashboard

È possibile usare una di queste query per definire un set di dati in un dashboard di intelligenza artificiale/BI. Fare riferimento alla visualizzazione delle metriche in un set di dati SQL e passare il parametro come argomento nella chiamata di funzione con valori di tabella. Per consentire agli utenti del dashboard di scegliere il valore in fase di esecuzione, passate un parametro del dashboard nell'argomento e collegatelo a un widget di filtro. Vedi Passare parametri a una vista metrica.

Risorse aggiuntive