Tipi di file in un progetto LookML

Un progetto LookML è una raccolta di file LookML che indicano a Looker come connettersi al database, come eseguire query sui dati e come controllare il comportamento dell'interfaccia utente. Puoi accedere ai file di progetto LookML dalla sezione Sviluppo di Looker o dall'interfaccia utente, come descritto nella pagina della documentazione Accesso ai file di progetto LookML.

I file di progetto vengono organizzati dagli sviluppatori Looker utilizzando le cartelle nell'IDE.

Un progetto LookML è costituito da almeno un file del modello e almeno un file di vista, oltre a possibilmente alcuni degli altri tipi di file descritti in questa pagina. Tutti i file di progetto hanno estensioni, anche se queste sono nascoste nell'elenco IDE se il progetto non è abilitato per le cartelle nell'IDE.

Seleziona i seguenti link per saperne di più su ciascuno dei tipi di file che possono essere utilizzati in un progetto LookML:

Dopo aver creato un progetto LookML, puoi accedere ai file di progetto e aggiungere nuovi file e cartelle al progetto utilizzando l'IDE di Looker.

File modello

Un file del modello specifica una connessione al database e il set di esplorazioni che utilizzano la connessione. Un file del modello definisce anche le esplorazioni stesse e le loro relazioni con altre viste. Un'esplorazione è un punto di partenza per l'esecuzione di query sui dati. In termini SQL, un'esplorazione è la clausola FROM di una query. Le esplorazioni che definisci nel modello vengono visualizzate dagli utenti quando esaminano il menu Esplora di Looker.

In altre parole, il file del modello è il luogo in cui definisci quali tabelle di dati devono essere utilizzate (come viste incluse) e come devono essere unite, se necessario.

Tieni presente quanto segue in merito ai file modello:

  • Le esplorazioni vengono in genere definite all'interno di un file modello. Tuttavia, a volte è necessario un file Explore separato per una tabella derivata o per estendere un'esplorazione o per perfezionare un'esplorazione tra i modelli.
  • Un file del modello deve avere un nome univoco in tutti i progetti dell'istanza. Se l'istanza contiene due file .model.lkml con lo stesso nome, è probabile che si verifichino errori, ad esempio errori di configurazione del modello nella pagina Progetti LookML ed errori di rendering per gli errori della dashboard LookML, poiché le dashboard LookML utilizzano il nome del modello nel formato URL (<hostname>/dashboard/model_name::<dashboard_name>). Puoi utilizzare il validatore LookML per verificare se i nomi dei modelli sono duplicati nell'istanza. Tuttavia, anche se il validatore LookML rileva nomi di modelli duplicati nell'istanza, puoi comunque eseguire il push del codice in produzione. Pertanto, assicurati di correggere eventuali errori di nomi di modelli duplicati prima di eseguire il deployment del progetto LookML in produzione.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file modello, consulta la pagina della documentazione Gestione di file e cart1elle LookML.

Struttura e sintassi generale

All'interno delle parentesi graffe di un'esplorazione, { }, definisci i parametri per l'esplorazione. Puoi utilizzare i parametri join per unire altre viste a un'esplorazione in un file del modello.

Nell'esempio seguente, il codice LookML in un file del modello di esempio definisce un'esplorazione denominata inventory_items, insieme alle viste unite:

connection: "thelook_events"

explore: inventory_items {
  join: products {
    type: left_outer
    sql_on: ${inventory_items.product_id} = ${products.id} ;;
    relationship: many_to_one
  }

  join: distribution_centers {
    type: left_outer
    sql_on: ${products.distribution_center_id} = ${distribution_center.id} ;;
    relationship: many_to_one
  }
}

Questa definizione LookML fa sì che Articoli di inventario venga visualizzato nella sezione Esplora della navigazione di Looker e unisce i dati delle viste products e distribution_centers alla vista inventory_items.

È possibile accedere alle visualizzazioni Centri di distribuzione, Articoli di inventario e Prodotti dal selettore di campi per l&#39;esplorazione degli articoli di inventario.

Per informazioni più specifiche sulle strutture LookML in un file modello, consulta la pagina della documentazione Terminologia e concetti di LookML.

Per saperne di più sui parametri LookML nel file del modello, consulta le pagine della documentazione Parametri modello, Parametri esplorazione e Parametri join.

File di visualizzazione

Un file di visualizzazione definisce in genere una singola "vista" all'interno di Looker. Una vista corrisponde a una singola tabella nel database o a una singola tabella derivata. Il file di visualizzazione specifica una tabella su cui eseguire query e i campi (dimensioni e misure) da includere da tale tabella in modo che gli utenti possano creare query con questi campi nell'interfaccia utente di Looker.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file di visualizzazione, consulta la pagina della documentazione Gestione di file e cartella LookML.

Struttura e sintassi generale

All'interno delle parentesi graffe di ogni vista, { }, sono presenti le definizioni dei campi, che in genere corrispondono a una colonna nella tabella sottostante o a un calcolo in Looker. Looker classifica la maggior parte di queste definizioni come dimensioni o misure.

Nell'esempio seguente di un file di vista, il orders.view file include le definizioni delle dimensioni id, status e user_id, del gruppo di dimensioni created e della misura count:

view: orders {
  sql_table_name: demo_db.orders ;;
  drill_fields: [id]

  dimension: id {
    primary_key: yes
    type: number
    sql: ${TABLE}.id ;;
  }

  dimension: status {
    type: string
    sql: ${TABLE}.status ;;
  }

  dimension: user_id {
    type: number
    # hidden: yes
    sql: ${TABLE}.user_id ;;
  }

    dimension_group: created {
    type: time
    timeframes: [
      raw,
      time,
      date,
      week,
      month,
      quarter,
      year
    ]
    sql: ${TABLE}.created_at ;;
  }

  measure: count {
    type: count
    drill_fields: [id, users.id, users.first_name, users.last_name, order_items.count]
  }
}

La definizione di questi campi nella vista orders espone i campi Data di creazione, ID, Stato, ID utente e Conteggio nel selettore campi per l'esplorazione Ordini.

Gli utenti che hanno accesso all'esplorazione Ordini possono eseguire query sull'esplorazione Ordini selezionando e filtrando questi campi.

Oltre a dimensioni e misure, puoi anche creare più dimensioni basate sul tempo contemporaneamente utilizzando i gruppi di dimensioni o specificare un filtro per gli utenti con i campi filtro. Visita la pagina della documentazione Parametri di visualizzazione per saperne di più sui parametri LookML nei file di visualizzazione e la pagina della documentazione Parametri dei campi per informazioni sui parametri LookML utilizzati per definire dimensioni, misure, gruppi di dimensioni e campi filtro in LookML.

File dashboard

Looker supporta due tipi di dashboard:

  • Dashboard definite dall'utente, che possono essere create da utenti non sviluppatori senza utilizzare LookML. Per i dettagli, consulta la pagina della documentazione Creazione di dashboard definite dall'utente.
  • Dashboard LookML, che vengono archiviate come file con controllo delle versioni associati al progetto.

Se il progetto contiene dashboard LookML, queste verranno definite in file dashboard dedicati nell'IDE, con l'estensione .dashboard.lookml.

Per saperne di più sulle dashboard LookML, consulta la pagina della documentazione Creazione di dashboard LookML.

File di documenti

I file di documenti Looker ti consentono di scrivere documentazione o altre note sul modello dei dati Looker utilizzando Markdown con GitHub. Questo può essere utile per consentire agli utenti di familiarizzare con il modo in cui la tua organizzazione utilizza Looker.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file di documenti, consulta la pagina della documentazione Gestione di file e cartelle LookML.

Visualizzare il documento al di fuori dell'IDE

Per visualizzare un documento al di fuori dell'IDE, cosa che dovrai fare per sfruttare le funzionalità di navigazione descritte in questa pagina, scegli l'opzione Visualizza documento dal menu Visualizza azioni file per il file del documento:

Puoi distribuire l'URL della pagina risultante ad altri utenti in modo che possano accedere direttamente al documento senza dover navigare nel menu Sviluppo di Looker per raggiungerlo.

Aggiungere una struttura di navigazione al documento

Puoi aggiungere una barra laterale ai file di documenti in modo che gli utenti possano vedere la struttura delle informazioni e spostarsi tra i documenti.

Per aggiungere la navigazione nella barra laterale di un documento, crea una sezione di navigazione a partire dalla prima riga del documento. Contrassegna l'inizio e la fine della sezione di navigazione con tre trattini (---).

Puoi utilizzare i seguenti parametri nella sezione di navigazione:

Puoi utilizzare navigation: true in un file di documenti per aggiungere la barra laterale di navigazione a quel documento. Ad esempio, puoi aggiungere il seguente codice all'inizio di un file Markdown:

---
navigation: true
---

Questo codice aggiunge al documento una barra laterale di navigazione con link a tutti i documenti del progetto. Se includi solo navigation: true in un documento, la barra laterale di quel documento elenca tutti i documenti del progetto in ordine alfabetico per nome file.

Inoltre, potresti scoprire che l'organizzazione per nome file alfabetico non è l'ideale oppure potresti avere alcuni documenti che non vuoi che vengano visualizzati nella navigazione:

La barra laterale elenca Documento 4, Documento 1, Documento 3 e Documento 2 in ordine alfabetico, insieme a un documento intitolato Non visualizzare.

In questo esempio, potresti voler elencare i documenti Documento uno, Documento due, Documento tre e Documento quattro in ordine numerico anziché alfabetico, nonché nascondere il documento Non visualizzare dalla barra laterale di navigazione.

Per modificare l'ordine dei documenti nella barra laterale di navigazione o per mostrare solo un sottoinsieme dei documenti nella barra laterale, puoi utilizzare questo formato:

---
navigation:
  - document_one
  - document_two
  - document_three
  - document_four
---

Ora la navigazione mostrerà solo i file di documenti che vuoi visualizzare e verranno visualizzati in un ordine più logico:

La barra laterale elenca i documenti in ordine numerico e il documento Non visualizzare non viene più mostrato.

title

Per impostazione predefinita, la barra laterale mostra l'intestazione del documento (se il documento inizia con un'intestazione) o il nome file del documento se non è presente un'intestazione nel file. Puoi aggiungere un parametro title all'inizio di un documento per modificare la modalità di visualizzazione del documento nelle barre laterali di navigazione:

---
title: New Title for Users
---

Questo titolo verrà utilizzato come testo del link nelle barre laterali di navigazione di tutti i documenti, a meno che non specifichi un label diverso nella sezione di navigazione di un documento.

label

Se vuoi modificare la modalità di visualizzazione di un documento nella barra laterale di navigazione, puoi utilizzare i parametri document e label nel seguente modo:

---
navigation:
  - document_one
  - document: document_two
    label: Customized Label for Document Two
  - document_three
  - document_four
---

Il valore label definisce la modalità di visualizzazione di un documento nella navigazione della barra laterale del documento, anche se il documento a cui fa riferimento ha un proprio parametro title.

L'esempio precedente ha il seguente aspetto nella barra laterale del documento:

Il documento della pagina document_two è elencato come Etichetta personalizzata per il documento due nella barra laterale.

section

Se vuoi suddividere la barra laterale di navigazione in sezioni, puoi utilizzare il parametro section nel seguente modo:

---
navigation:
  - document_one
  - document_two
  - section: My Section Name
  - document_three
  - document_four
---

In questo esempio, il parametro section aggiunge un'interruzione di sezione e il titolo di testo Nome sezione alla barra laterale.

Il titolo di testo non è un link; non fa riferimento a nessuno dei file di documenti.

File di dati

I file di dati sono file JSON con estensione .json, .topojson o .geojson.

Il parametro map_layer ti consente di utilizzare un file JSON come mappa personalizzata che può essere utilizzata per tracciare i dati in Looker.

Quindi utilizzi il parametro map_layer_name con una dimensione in modo da poter associare un valore di dati (ad esempio "Parigi") a una regione geografica sulla mappa personalizzata.

Puoi modificare un file JSON nell'IDE di LookML e poi selezionare Salva.

Per il debug, puoi scegliere Visualizza non elaborato selezionando il menu Visualizza azioni file accanto al nome del file per visualizzare il file in formato non elaborato. Se hai l'estensione corretta per visualizzare JSON nel browser, avrai anche la possibilità di visualizzare il file in formato Analizzato.

Per istruzioni sul caricamento di un file JSON in un progetto LookML, consulta la pagina della documentazione Gestione di file e cartelle LookML.

File manifest del progetto

Il progetto può contenere un file manifest del progetto, utilizzato per le seguenti attività:

Consulta la pagina della documentazione Parametri del manifest del progetto per visualizzare un file manifest di esempio e i possibili parametri per i file manifest. Per istruzioni sulla creazione di file di progetto LookML, inclusi i file manifest del progetto, consulta la pagina della documentazione Gestione di file e cartelle LookML.

Tieni presente quanto segue in merito ai file manifest del progetto:

  • Ogni progetto può avere un solo file manifest, che deve essere denominato manifest.lkml e trovarsi a livello root della struttura di directory del progetto e nel repository Git.
  • Looker non supporta un file manifest del progetto vuoto. Se il file manifest è vuoto, eliminalo.
  • Ogni progetto può avere un solo file manifest.
  • Il file manifest del progetto deve essere denominato manifest.lkml e trovarsi a livello root della struttura di directory del progetto.

File di blocco manifest

I file di blocco manifest vengono creati automaticamente quando una dipendenza remota viene aggiunta al file manifest del progetto. Looker utilizza il file di blocco manifest per tenere traccia della versione dei progetti remoti specificati nel file manifest. Il file di blocco manifest è elencato nel riquadro del browser dei file dell'IDE di Looker e ha il nome file manifest_lock.lkml.

Gli sviluppatori Looker non devono creare o modificare un file di blocco manifest, poiché i file di blocco vengono gestiti automaticamente da Looker.

Per saperne di più, consulta la pagina della documentazione Importazione di file da altri progetti.

File di stringhe delle impostazioni internazionali

Se stai localizzando il modello di dati, dovrai creare file di stringhe delle impostazioni internazionali per ogni impostazione internazionale che vuoi localizzare, inclusa quella predefinita (ad esempio, spesso l'inglese negli Stati Uniti).

I file di stringhe delle impostazioni internazionali elencano le coppie chiave-valore per ogni etichetta e descrizione che stai localizzando nel modello. Il file di stringhe per ogni impostazione internazionale deve fornire la traduzione di questa impostazione internazionale per ogni etichetta o descrizione. Ulteriori informazioni sulla creazione di file di stringhe delle impostazioni internazionali sono disponibili nella pagina della documentazione Localizzazione del modello LookML.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file di stringhe delle impostazioni internazionali, consulta la pagina della documentazione Gestione di file e cartelle LookML.

Esplora i file

Un'esplorazione è una vista su cui gli utenti possono eseguire query. Un'esplorazione è il punto di partenza per una query o, in termini SQL, la clausola FROM in un'istruzione SQL. Per informazioni su come gli utenti interagiscono con le esplorazioni per eseguire query sui dati, consulta la pagina della documentazione Visualizzazione e interazione con le esplorazioni in Looker.

Le esplorazioni vengono in genere definite all'interno di un file modello. Tuttavia, a volte è necessario un file Explore separato per una tabella derivata o per estendere o perfezionare un'esplorazione tra i modelli.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file di esplorazione, consulta la pagina della documentazione Gestione di file e cartelle LookML.

File di test sui dati

Il progetto può avere file di test sui dati utilizzati per verificare la logica del modello LookML. I test sui dati possono essere contenuti in file modello o in file di visualizzazione, ma se gli sviluppatori vogliono utilizzare gli stessi test sui dati in più modelli diversi, può essere utile conservare i test sui dati in un file dedicato.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file di test sui dati, consulta la pagina della documentazione Gestione di file e cartelle LookML.

File di perfezionamento

Il progetto può avere file utilizzati per i perfezionamenti LookML. Con i perfezionamenti LookML, puoi adattare una vista o un'esplorazione esistente senza modificare il file LookML che la contiene. I perfezionamenti LookML possono essere contenuti in file modello, di visualizzazione o di esplorazione oppure in un file dedicato.

Per istruzioni sulla creazione di file di progetto LookML, inclusi i file di perfezionamento, consulta la pagina della documentazione Gestione di file e cartelle LookML.

Altri file

Molti elementi LookML possono essere contenuti in file diversi del progetto o in file dedicati. Ad esempio, i test sui dati possono essere contenuti in file modello, file di visualizzazione o file .lkml dedicati.