Modifica e convalida di LookML

Utilizzo dell'IDE

In questa pagina vengono descritte alcune delle funzionalità dell'IDE di Looker che possono aiutarti nella scrittura di LookML.

Puoi accedere all'IDE di Looker (ambiente di sviluppo integrato) tramite il menu Sviluppo di Looker. Per maggiori dettagli e altre opzioni, vedi Accesso ai file di progetto.

Suggerimenti automatici

Durante la digitazione, 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 opzioni valide per quel parametro. Inoltre, i campi nei parametri sql devono essere contrassegnati con ${...}, quindi l'IDE aggiunge questa sintassi quando suggerisce i campi.

Il suggerimento automatico appare automaticamente ovunque può essere mostrato. Per chiuderlo, premi il tasto Esc sulla tastiera. Per visualizzarlo in qualsiasi momento, premi Ctrl+Barra spaziatrice (Windows) o Ctrl-Barra spaziatrice (Mac).

Controllo degli errori ad hoc

L'IDE rileva gli errori di sintassi durante la digitazione. Una X rossa nella grondaia indica un errore di sintassi, sottolineato in rosso. Passa il mouse sopra la X rossa per visualizzare una breve descrizione del problema. Ad esempio, se per errore digiti avrage anziché average come valore del parametro type per una misura, l'IDE visualizza 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 a un campo non valido a causa di un join mancante, richiedono un'analisi olistica del modello e, di conseguenza, vengono visualizzati solo quando viene eseguito lo strumento di convalida LookML.

Riquadro Guida rapida

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

Nota: puoi anche utilizzare il riquadro dei metadati per visualizzare informazioni contestualmente pertinenti sugli oggetti nel riquadro dei metadati dell'IDE di Looker. Per ulteriori informazioni, consulta la pagina della documentazione Metadati per gli oggetti LookML.

Formattazione automatica

In modalità di sviluppo, puoi utilizzare la scorciatoia da tastiera del formato dei file per applicare automaticamente il rientro al file LookML. Il rientro indica la gerarchia dei parametri e dei sottoparametri, rendendo il tuo LookML più semplice da leggere e comprendere.

Pieghevole

Viene visualizzata una piccola freccia nella grondaia accanto all'inizio di ogni parametro LookML di livello superiore nel file. Se selezioni questa freccia, la sezione di LookML viene piegata o aperta in modo da poterti concentrare solo su sezioni specifiche.

Il menu Visualizza azioni file per il file LookML fornisce anche le opzioni Fold LookML e Unfold LookML, per espandere o comprimere tutte le sezioni LookML verso il basso nel parametro di primo livello all'interno del file corrente.

Puoi anche utilizzare le scorciatoie da tastiera per comprimere e espandere LookML.

Contrassegnare aggiunte, modifiche ed eliminazioni

Nell'IDE LookML, vengono sempre visualizzati diversi indicatori quando sei in modalità di sviluppo e hai modifiche di cui non è stato eseguito il commit.

• Il nome del file viene visualizzato con un punto blu nel 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 linee nuove o modificate, mentre una linea rossa orizzontale indica le linee rimosse.

Aggiunta di commenti

Puoi aggiungere commenti a 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 commentare un intero blocco di codice utilizzando le scorciatoie da tastiera procedendo nel seguente modo:

1. Seleziona le righe che vuoi commentare.
2. Premi Comando+ / (Mac) o Ctrl+ / (Windows).

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

Commentare i blocchi SQL

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

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

Vai all'oggetto o al file

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

Per ulteriori informazioni, consulta la pagina della documentazione relativa all'accesso ai file di progetto LookML.

Ricerca e sostituzione di testo nel progetto

L'IDE di Looker include una funzione di ricerca e sostituzione che puoi utilizzare per cercare testo in tutti i file di progetto e quindi sostituire tutte le istanze o le istanze selezionate con un'operazione collettiva.

Suggerimento: la funzionalità Trova e sostituisci nell'IDE di Looker è un ottimo strumento per individuare gli elementi LookML nei progetti LookML di grandi dimensioni e per sostituire il testo nelle descrizioni e nelle etichette. Se vuoi cercare e sostituire i nomi di modelli, esplorazioni e campi nel tuo progetto, utilizza la funzione di ricerca e sostituzione dello strumento di convalida dei contenuti. La modifica dei nomi dei modelli, delle esplorazioni e dei campi può interrompere i riferimenti all'interno del modello e lo strumento di convalida dei contenuti può convalidare i riferimenti a LookML e correggere gli errori in LookML dopo aver apportato questi tipi di modifiche.

Per utilizzare la funzione di ricerca dell'IDE di Looker, segui questi passaggi:

1. Vai al riquadro di ricerca nell'IDE.
2. Inserisci un termine nel campo Trova.
3. Facoltativamente, puoi selezionare Maiuscole/minuscole per cercare solo istanze corrispondenti a quelle inserite nel campo Trova oppure seleziona RegEX per eseguire una ricerca tramite espressioni regolari.
4. Seleziona Trova.
5. Se vuoi, puoi selezionare il nome di un file per aprirlo nell'IDE.

Se sei in modalità di sviluppo, vedrai anche il campo Sostituisci con. Per sostituire il testo nel tuo progetto, segui questi passaggi:

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

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

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

   • Utilizza la casella di controllo accanto al riepilogo dei risultati per selezionare o deselezionare tutte le istanze nell'intero progetto.
   • Utilizza la casella di controllo accanto a una singola istanza per selezionarla o deselezionarla.

4. Seleziona il pulsante Sostituisci selezionata 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 poi li testeremo.

Creare una dimensione

Innanzitutto aggiungeremo una nuova dimensione alla nostra 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à Sì se l'utente si trova in California o New York e No in caso contrario.

Il LookML per la nostra nuova dimensione ha il seguente aspetto:

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

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

Per scoprire di più su ${TABLE}.state, consulta l'articolo sugli operatori di sostituzione.

Creazione di una misura

Successivamente aggiungeremo una nuova misura alla nostra visualizzazione user che rappresenta la media dell'età dei nostri utenti. Questa misura sarà type: average e aggregata per la 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 di visualizzazione user, quindi fai clic sul pulsante Salva modifiche nel file.

Test dei campi nell'esplorazione

Puoi testare la nuova dimensione e misurarla eseguendo delle query. Dopo aver salvato le modifiche, questi campi verranno visualizzati nel selettore campi in Esplora. Utilizza il menu a discesa Visualizza azioni file accanto al nome file della visualizzazione per accedere facilmente a Esplora per la visualizzazione corrente. Il menu a discesa Visualizza le azioni dei file elenca tutte le esplorazioni basate sulla visualizzazione, comprese le esplorazioni a cui è unita. Ad esempio, per accedere all'esplorazione per una vista denominata users, puoi selezionare l'opzione Esplora utenti dal menu a discesa Visualizza azioni file.

Nell'esplorazione Utenti, puoi selezionare i nuovi campi per aggiungerli a una query. Ad esempio, puoi creare una query con entrambi i nuovi campi che mostrano l'età media degli utenti della California o New York e l'età media degli utenti che non lo sono:

Nota: per accedere a questi nuovi campi devi essere in modalità di sviluppo finché non hai eseguito il commit delle modifiche e inviato le modifiche in produzione.

Convalida di LookML

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

Poi, usa lo strumento di convalida LookML per eseguire una convalida completa del modello. Alcuni errori, come un riferimento a un campo non valido a causa di un join mancante, richiedono un'analisi olistica del modello e, di conseguenza, 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 ogni problema, ad esempio quelli relativi alle autorizzazioni del database, evita la maggior parte degli errori.

Nota: lo strumento di convalida LookML non deve essere confuso con lo strumento di convalida dei contenuti, che verifica invece se le modifiche apportate danneggeranno i Look salvati.

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 visualizzazione cambia, vengono convalidate di nuovo solo le esplorazioni in cui è utilizzata.
• Se un'esplorazione cambia, viene convalidata di nuovo solo quella corrispondente.

Suggerimento: se noti che il completamento della convalida di LookML richiede molto tempo, la prima cosa da controllare è il parametro include nel file del modello. Se includi tutti i file di visualizzazione (include: "*.view"), lo strumento di convalida LookML dovrà controllarli tutti, il che può influire sulle prestazioni. In questo caso, aggiorna il parametro include del file del modello in modo che siano inclusi solo i file di visualizzazione necessari.

Convalida in corso...

Per eseguire lo strumento di convalida LookML, seleziona il pulsante Convalida LookML in alto a destra nell'IDE di Looker oppure seleziona l'icona Integrità del progetto nella parte superiore dell'IDE per aprire il riquadro Integrità del progetto, quindi fai clic sull'icona Convalida LookML.

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

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

Messaggi di convalida

Looker visualizza i messaggi di convalida dopo l'esecuzione della convalida su LookML.

Nota: le dashboard LookML mostrano messaggi informativi, anziché avvisi, nella barra laterale quando è abilitata la localizzazione permissiva.

Nessun errore di LookML trovato

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

Errori di LookML

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

Nell'elenco espanso dei problemi, vedrai il motivo per cui la convalida non è andata a buon fine. Spesso, se fai clic sull'errore, vieni indirizzato direttamente alla riga di codice problematica. Vedrai una "X" rossa accanto alla riga. Passa il mouse sopra al file per visualizzare informazioni più dettagliate sull'errore in alcuni casi:

Suggerimento per il team via chat: l'errore di convalida che ci viene maggiormente chiesto è "Campo sconosciuto o inaccessibile". Visita la pagina delle best practice Errore: campo sconosciuto o inaccessibile per conoscere le cause e sapere come procedere.

Avvisi di LookML

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

Come per gli errori di LookML, puoi espandere gli avvisi e passare al codice del problema selezionandolo nel riquadro Stato del progetto e passando il mouse sopra l'icona X rossa per visualizzare ulteriori informazioni:

Deployment delle modifiche

Dopo aver verificato il corretto funzionamento delle modifiche, puoi utilizzare l'integrazione Git di Looker per eseguire il commit delle modifiche in produzione ed eseguirne il deployment.

Nota: se modifichi i nomi dei campi che fungono da filtri nei Look o nelle dashboard, assicurati di rivedere la sezione Filtri dei Look e delle dashboard pianificati e aggiorna i filtri in base alle esigenze per riflettere le modifiche. Se un'importazione dei contenuti pianificata include filtri che non funzionano più (ad esempio, se il campo di riferimento è stato modificato), la pubblicazione pianificata potrebbe esporre dati non filtrati.