Modifica e convalida di LookML

Utilizzare l'IDE

L'ambiente di sviluppo integrato (IDE) di Looker offre diverse funzionalità per aiutarti a scrivere il codice LookML.

Suggerimenti automatici

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

La funzionalità di suggerimento automatico appare automaticamente ovunque possa essere mostrata. 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, che è sottolineato in rosso. Quando passi il mouse sopra la X rossa, viene visualizzata una breve descrizione del problema.

Lo strumento di convalida LookML deve comunque eseguire una convalida completa del modello. Alcuni errori, ad esempio un riferimento a un campo non valido a causa di un join mancante, richiedono una visione olistica del modello e quindi vengono visualizzati solo quando viene eseguito lo strumento di convalida LookML.

Riquadro della Guida rapida

Fai clic sull'icona delle informazioni per aprire il riquadro Guida rapida, che fornisce spiegazioni e opzioni per la posizione corrente nel codice. Fai clic sul nome di un parametro nella barra laterale per aprire la pagina della documentazione di Looker per quel parametro.

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

Formattazione automatica

In modalità Sviluppo, puoi utilizzare la scorciatoia da tastiera per il file di formato per applicare automaticamente il rientro al file LookML. Il rientro indica la gerarchia di parametri e sottoparametri, semplificando l'interpretazione e la comprensione del codice LookML.

Ripiegature

Una piccola freccia viene visualizzata nel margine accanto all'inizio di ogni parametro LookML di livello superiore nel file. Se fai clic su questa freccia, la sezione viene aperta o aperta per consentirti di concentrarti solo su determinate sezioni.

Il menu File offre anche le opzioni piega LookML e Apri 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 aprire e aprire LookML.

Contrassegnare aggiunte, modifiche ed eliminazioni

Nell'IDE LookML, quando sei in modalità Development (Sviluppo) vengono visualizzati sempre diversi indicatori, con modifiche non confermate.

  • Il nome del file viene 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 delle righe all'interno del file vengono evidenziati in verde per mostrare le righe nuove o modificate, mentre una linea rossa orizzontale indica le righe rimosse.

Aggiungere commenti

Puoi aggiungere commenti a LookML per renderli più leggibili. 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:

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

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

Aggiungere commenti ai blocchi 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 dei commenti SQL, le sezioni dei commenti vengono comunque interpretate come codice LookML. Di conseguenza, i tuoi commenti verranno visualizzati all'interno dell'SQL generato da LookML, ma non influenzeranno i risultati della query.

Passa all'oggetto o al file

Nell'IDE di Looker, puoi eseguire una rapida ricerca per passare 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 di file o nel 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 e alla modifica delle informazioni sul progetto.

Ricerca e sostituzione di testo nel progetto

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

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

Per utilizzare la funzione Trova IDE di Looker:

  1. Vai al riquadro di ricerca nell'IDE.
  2. Inserisci un termine nel campo Trova.
  3. Facoltativamente, puoi selezionare Sensibili alle maiuscole per cercare solo le istanze che corrispondono alla richiesta che hai inserito nel campo Trova oppure seleziona RegEX per eseguire una ricerca con espressioni regolari.
  4. Fai clic su Trova.
  5. Facoltativamente, puoi fare clic sul 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. Se vuoi, puoi lasciare vuoto il campo Sostituisci con se vuoi eliminare il testo nel campo Trova anziché sostituirlo.

  2. Fai clic su Seleziona e sostituisci per visualizzare un'anteprima di come il testo verrà sostituito nel 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 tale istanza.
  4. Fai clic sul pulsante Sostituisci selezionato 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.

Creare una dimensione

Innanzitutto, aggiungeremo una nuova dimensione alla nostra vista users che determina se un utente proviene dalla California o da New York. La dimensione sarà type: yesno, il che significa che restituirà se l'utente proviene dalla California o da New York e No in caso contrario.

L'aspetto di LookML per la nostra nuova dimensione è il 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, poi fai clic sul pulsante Salva modifiche nel file.

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

Creare una misura

Successivamente, aggiungeremo alla nostra visualizzazione user una nuova misura che calcola la media dell'età dei nostri utenti. Questa misura sarà type: average e aggregata sulla colonna age.

Il codice LookML per questa nuova misura ha il seguente aspetto:

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

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

Testare i campi in Esplora

Puoi testare la nuova dimensione e misurare eseguendo query su di esse. Dopo aver salvato le modifiche, questi campi verranno visualizzati nel selettore di campi in Esplora. Un modo semplice per accedere a Esplora per la vista corrente è utilizzare il menu a discesa accanto al nome file della vista:

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

Affinché tu possa accedere a questi nuovi campi fino al commit e all'invio delle modifiche in produzione, devi rimanere in modalità Sviluppo.

Convalida del codice 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.

Successivamente, utilizza lo strumento di convalida LookML per eseguire una convalida completa del modello. Alcuni errori, ad esempio un riferimento a un campo non valido a causa di un join mancante, richiedono una visione olistica del modello e quindi 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 i problemi di autorizzazione del database, impedisce la maggior parte degli errori.

Lo strumento di convalida LookML non deve essere confuso con lo Strumento di convalida dei contenuti, che controlla se le modifiche apportate non funzioneranno correttamente eventuali 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 viene utilizzata.
  • Se un'esplorazione cambia, solo quella viene convalidata di nuovo.

Suggerimento per il team di Chat. Se noti che il completamento della convalida LookML richiede molto tempo, la prima cosa da controllare è il parametro include nel file del modello. Se includi tutti i file della vista (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 da includere solo i file di vista 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 Project Health nella parte superiore dell'IDE per aprire il riquadro Project Health, quindi seleziona il pulsante Validate LookML:

Dopo aver eseguito lo strumento di convalida LookML, potrebbe essere visualizzato un elenco di errori e altri avvisi che dovresti risolvere. Puoi selezionare qualsiasi freccia per espandere gli elenchi di errori o avvisi:

Il pulsante 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 aver eseguito la convalida su LookML.

Quando è abilitata la localizzazione permissiva, nelle dashboard di LookML vengono mostrati messaggi informativi, anziché avvisi, nella barra laterale.

Nessun errore LookML trovato

Se non vengono rilevati problemi, Looker visualizza un segno di spunta verde insieme al testo No LookML errors found (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 trovati (nove nell'esempio seguente):

Nell'elenco espanso dei problemi vedrai il motivo per cui la convalida non è stata superata. Spesso, facendo clic sull'errore, verrai reindirizzato direttamente alla riga del codice contenente il problema. Accanto alla riga verrà visualizzata una "X" rossa. Se passi il mouse sopra il modello, otterrai informazioni più dettagliate sull'errore in alcuni casi:

Suggerimento per il team di Chat: l'errore di convalida che ci viene chiesto più spesso è "Campo sconosciuto o inaccessibile". Consulta questo articolo del Centro assistenza per scoprire le cause e cosa fare al riguardo.

Avvisi LookML

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

Come per gli errori LookML, per espandere gli avvisi e passare al codice problema, puoi selezionare l'avviso nel riquadro Project Health e passare il mouse sopra l'icona X rossa per visualizzare ulteriori informazioni.

Implementazione delle modifiche

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

Se modifichi i nomi dei campi che fungono da filtri nei Look o nelle dashboard, assicurati di esaminare la sezione Filtri dei Look e delle dashboard pianificati e aggiorna i filtri secondo necessità per riflettere le modifiche. Se una pubblicazione di contenuti pianificata include filtri che non funzionano più (ad esempio, se il campo a cui viene fatto riferimento è cambiato), la pubblicazione pianificata potrebbe esporre dati non filtrati.