Modifica e convalida di LookML

Utilizzo dell'IDE

L'ambiente di sviluppo integrato (IDE) di Looker include diverse funzionalità utili per la scrittura nel codice LookML.

Suggerimenti automatici

Mentre digiti, l'IDE suggerisce possibili parametri e valori sensibili al contesto del testo digitato. Ad esempio, i suggerimenti per il parametro type di una dimensione includeranno solo le opzioni valide per quel parametro. Inoltre, i campi nei parametri sql devono essere contrassegnati con ${...}, pertanto l'IDE aggiunge questa sintassi quando suggerisce i campi.

La funzionalità di suggerimento automatico viene visualizzata automaticamente ovunque possa essere mostrata. Per chiuderla, premi il tasto Esc sulla tastiera. Per visualizzarlo in qualsiasi momento, premi Ctrl+Barra spaziatrice (Windows) o Ctrl-Barra spaziatrice (Mac).

Controllo errori ad hoc

L'IDE rileva gli errori di sintassi durante la digitazione. Una X in una grondaia rossa indica un errore di sintassi, che è sottolineato in rosso. Quando passi il mouse sopra la X rossa, viene visualizzata una breve descrizione del problema. Ad esempio, se per errore digiti avrage anziché average come valore del parametro type, viene visualizzato l'errore Invalid value for "type":avrage.

Lo strumento di convalida LookML è comunque necessario per eseguire una convalida completa del modello. Alcuni errori, come un riferimento di campo non valido a causa di un join mancante, richiedono una visione olistica del modello e, pertanto, vengono visualizzati solo quando viene eseguito lo strumento di convalida LookML.

Riquadro Guida rapida

Seleziona l'icona Guida rapida per aprire il riquadro Guida rapida, che fornisce spiegazioni e opzioni per la posizione corrente nel codice. Seleziona il nome di un parametro nella barra laterale per aprire la pagina della documentazione di Looker relativa al parametro in questione.

Formattazione automatica

Quando sei in modalità Sviluppo, puoi utilizzare la scorciatoia da tastiera del file di formato per applicare automaticamente il rientro al file LookML. Il rientro indica la gerarchia di parametri e sottoparametri, semplificando la lettura e la comprensione del LookML.

Pieghevoli

Una piccola freccia appare nella grondaia accanto all'inizio di ogni parametro LookML di primo livello nel file. Se selezioni questa freccia, si piega o si apre quella sezione di LookML, in modo da poterti concentrare solo su sezioni specifiche.

Il menu See files actions (Visualizza azioni file) per il file LookML fornisce anche le opzioni Fold LookML e Unvel LookML per espandere o comprimere tutte le sezioni LookML fino al parametro di primo livello all'interno del file corrente.

Puoi anche utilizzare le scorciatoie da tastiera per piegare e aprire LookML.

Contrassegnare aggiunte, modifiche ed eliminazioni

Nell'IDE LookML, se la modalità di sviluppo è associata a modifiche non impegnate, vengono sempre visualizzati diversi indicatori.

  • Il nome del file è visualizzato con un punto blu sul lato sinistro della finestra per indicare che il file è nuovo, modificato o rinominato.
  • Quando apri un file nuovo o modificato, i numeri di riga all'interno del file vengono evidenziati in verde per mostrare le linee nuove o modificate, mentre una linea rossa orizzontale indica le righe rimosse.

Aggiungere commenti

Puoi aggiungere commenti al tuo LookML per renderlo più leggibile. Per aggiungere un singolo commento, utilizza il carattere #:

dimension: name {
  sql: ${TABLE}.name ;; # This is the customer's full name
}

Puoi aggiungere commenti a un intero blocco di codice utilizzando le scorciatoie da tastiera:

  1. Seleziona le righe che vuoi commentare.
  2. Premi ⌘ + / su Mac o Ctrl + / su un computer Windows.

L'IDE aggiungerà il carattere # a ogni riga selezionata.

Commenti dei blocchi di SQL

Se stai commentando righe che si trovano interamente all'interno di un blocco di codice SQL, aggiungi manualmente la notazione dei commenti SQL.

Quando utilizzi il blocco di commenti SQL, le sezioni commentate verranno comunque interpretate come codice LookML. Pertanto, vedrai i tuoi commenti all'interno dell'SQL generato da LookML, ma questi non influiranno sui risultati della query.

Vai all'oggetto o al file

Nell'IDE di Looker, puoi eseguire una rapida ricerca per andare direttamente agli oggetti LookML e ai file di progetto utilizzando la funzionalità Vai all'oggetto o al file. Fai clic sull'icona Vai all'oggetto o al file nel browser dei file o nel browser degli oggetti oppure utilizza la scorciatoia da tastiera Command-J (Mac) o Ctrl+J (Windows):

Per ulteriori informazioni, consulta la pagina Documentazione relativa ai file di progetto LookML.

Ricerca e sostituzione di testo nel progetto

L'IDE di Looker dispone di una funzione Trova e sostituisci che ti consente di cercare del testo in tutti i file del progetto e di sostituire tutte le istanze o determinate istanze con un'operazione collettiva.

Per utilizzare la funzione di ricerca degli IDE di Looker:

  1. Vai al riquadro di ricerca nell'IDE.
  2. Inserisci un termine nel campo Trova.
  3. Facoltativamente, puoi selezionare Maiuscole/minuscole per cercare solo le istanze che corrispondono alla richiesta inserita nel campo Trova o selezionare Espressione regolare per eseguire una ricerca tramite espressione regolare.
  4. Seleziona Trova.
  5. Facoltativamente, puoi selezionare il nome di un file per aprirlo nell'IDE.

Se è attiva la modalità di sviluppo, vedrai anche il campo Sostituisci con. Per sostituire il testo nel progetto:

  1. Inserisci il testo sostitutivo nel campo Sostituisci con. Facoltativamente, puoi lasciare vuoto il campo Sostituisci con se vuoi eliminare il testo nel campo Trova anziché sostituirlo.

  2. Seleziona Seleziona e sostituisci per visualizzare in anteprima il modo in cui il testo verrà sostituito nel tuo progetto.

  3. I risultati mostrano tutte le istanze del progetto evidenziate per la sostituzione. Per personalizzare le istanze da sostituire, puoi utilizzare le seguenti opzioni:

    • Utilizza la casella di controllo accanto al riepilogo dei risultati per selezionare o deselezionare tutte le istanze dell'intero progetto.
    • Utilizza la casella di controllo accanto a una singola istanza per selezionare o deselezionare l'istanza.
  4. Seleziona il pulsante Sostituisci selezionati per applicare la sostituzione alle istanze selezionate. L'IDE mostrerà le modifiche apportate.

Creazione e test di nuovi campi

Come esempio di modifica di LookML, aggiungeremo diversi campi e li testeremo.

Creazione di una dimensione

Innanzitutto, aggiungeremo una nuova dimensione alla vista users che determina se un utente si trova in California o a New York. La dimensione sarà type: yesno, il che significa che restituirà se l'utente proviene dalla California o New York e, se non lo è, No.

L'aspetto di LookML per la nostra nuova dimensione è simile al seguente:

dimension: from_ca_or_ny {
  type: yesno
  sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}

Aggiungi questa dimensione al file della vista user e poi fai clic sul pulsante Salva modifiche nel file.

Consulta gli operatori di sostituzione per scoprire di più su ${TABLE}.state.

Creazione di una misura

In seguito, aggiungeremo alla nostra visualizzazione user una nuova misura che indica la media dei nostri utenti. Questa misura è type: average e viene aggregata nella colonna age.

Il LookML per questa nuova misura ha il seguente aspetto:

measure: average_age {
  type: average
  sql: ${TABLE}.age ;;
}

Aggiungi questa misura al file della vista user e poi fai clic sul pulsante Salva modifiche nel file.

Testare i campi in Explore

Puoi provare la nuova dimensione e misurarla con una query. Dopo aver salvato le modifiche, questi campi verranno visualizzati nel selettore campi in Esplora. Utilizza il menu a discesa Visualizza le azioni sui file accanto al nome file della vista per accedere facilmente alla pagina Esplora per la visualizzazione corrente. Nel menu a discesa Visualizza le azioni sui file sono elencate tutte le esplorazioni basate sulla vista, incluse quelle a cui è collegata la visualizzazione. Ad esempio, per accedere alla funzionalità Esplora per una vista denominata users, puoi selezionare l'opzione Esplora utenti dal menu a discesa Visualizza le azioni sui file.

In Esplora utenti, puoi selezionare i nuovi campi per aggiungerli a una query in Utenti. Ad esempio, puoi creare una query con entrambi i nuovi campi che mostrano l'età media degli utenti provenienti dalla California o da New York e l'età media degli utenti che non lo fanno:

Tabella di dati per un campione di utenti esplora con i campi Utenti di CA o NY (Sì/No) ed Età media degli utenti selezionati.

Convalidare il codice LookML

Quando gli aggiornamenti ti soddisfano, puoi salvare le modifiche. L'IDE ti avvisa di eventuali errori di sintassi non risolti all'interno di un singolo file.

Successivamente, utilizza lo strumento di convalida LookML per eseguire una convalida completa del modello. Alcuni errori, come un riferimento di campo non valido a causa di un join mancante, richiedono una visione olistica del modello e, pertanto, vengono visualizzati solo quando viene eseguito lo strumento di convalida LookML. Assicurati di convalidare le modifiche LookML prima di pubblicarle nell'ambiente di produzione. Anche se la convalida non rileva tutti i problemi, ad esempio quelli relativi alle autorizzazioni del database, eviterà la maggior parte degli errori.

Lo strumento di convalida LookML analizza solo i file LookML che sono stati aggiornati dall'ultima convalida LookML o i file interessati dagli aggiornamenti:

  • Se un'impostazione a livello di modello cambia, tutto viene convalidato di nuovo.
  • Se una vista cambia, vengono nuovamente convalidate solo le esplorazioni in cui viene utilizzata.
  • Se un'esplorazione cambia, solo quell'esplorazione viene nuovamente convalidata.

Convalida in esecuzione

Per eseguire lo strumento di convalida LookML, seleziona il pulsante Convalida LookML in alto a destra nell'IDE di Looker oppure seleziona l'icona Stato progetto nella parte superiore dell'IDE per aprire il riquadro Stato progetto e poi fai clic sul pulsante Convalida LookML.

Dopo aver eseguito lo strumento di convalida LookML, potresti visualizzare un elenco di errori e altri avvisi da risolvere. Puoi selezionare qualsiasi freccia per espandere l'elenco degli errori o degli avvisi.

Il pulsante dello strumento di convalida nel riquadro Stato del progetto diventerà di nuovo disponibile se effettui e salvi un'altra modifica.

Messaggi di convalida

Looker visualizza i messaggi di convalida dopo aver eseguito la convalida su LookML.

Nessun errore LookML trovato

Se non vengono rilevati problemi dallo strumento di convalida, Looker mostra un segno di spunta verde insieme al testo Nessun errore LookML trovato.

Errori LookML

Gli errori LookML sono problemi che potrebbero impedire l'esecuzione delle query. Il numero tra parentesi indica il numero di errori rilevati (nove nell'esempio seguente):

Esempio di messaggio di convalida con testo come errori LookML (9).

Nell'elenco espanso dei problemi, vedrai il motivo per cui la convalida non è stata superata. Spesso, se fai clic sull'errore, viene visualizzata direttamente la riga del codice in cui si è verificato il problema. Vedrai una "X" rossa accanto alla riga. In alcuni casi, posizionandoci sopra il mouse verranno visualizzate informazioni più dettagliate sull'errore:

Esempio di errore visualizzato al passaggio del mouse per una definizione parametro parametro senza valore, con il testo dell'errore che indica che devi fornire un valore per il tipo.

Suggerimento per il team di Chat: l'errore di convalida che ci viene chiesto di più è "Campo sconosciuto o inaccessibile". Visita la pagina delle best practice per l'errore: campo sconosciuto o inaccessibile per scoprire le cause e le azioni da intraprendere.

Avvisi LookML

Gli avvisi di LookML potrebbero non impedire l'esecuzione di una query, ma potrebbero comunque causare funzionalità inaccessibili o indesiderate per gli utenti. Come per gli errori, il numero tra parentesi è il numero di avvisi trovati (tre avvisi nell'esempio seguente):

Esempio di un messaggio di convalida con il testo degli avvisi LookML (3).

Come con gli errori LookML, puoi espandere gli avvisi e passare al codice problema selezionando l'avviso nel riquadro Stato del progetto, quindi passa il mouse sopra l'icona rossa X per visualizzare ulteriori informazioni:

Esempio di un avviso con testo che indica che l'esplorazione deve corrispondere al nome di una visualizzazione o che deve avere una proprietà from o view_name.

Implementazione delle modifiche

Dopo aver verificato che le modifiche funzionino correttamente, puoi utilizzare l'integrazione Git di Looker per commettere ed eseguire il deployment delle modifiche in produzione.