Utilizzo
Gerarchia
include - oppure - include - oppure - include |
Valore predefinito
NessunaAccetta
Una stringa contenente un nome file o un pattern
|
Definizione
Il parametro include
specifica i file LookML disponibili per un modello, una vista o un'esplorazione. Se vuoi utilizzare un file LookML all'interno di un altro file o utilizzarlo come riferimento, devi aggiungerlo con il parametro include
.
Puoi utilizzare il parametro include
nei file del modello, visualizzare i file ed Esplora. Il parametro include
può fare riferimento a diversi tipi di file LookML, a seconda del contesto.
In un file del modello, puoi utilizzare include
per fare riferimento a:
In un file vista, puoi utilizzare include
per fare riferimento a:
In un file Esplora, puoi utilizzare include
per fare riferimento a:
Puoi anche utilizzare include
per importare file da altri progetti. Consulta la pagina di documentazione Importazione di file da altri progetti per informazioni su come includere i file di un altro progetto. Per importare file da progetti LookML locali, devi abilitare la funzionalità di local Project Import di Labs.
Quando utilizzi include
, tieni presente quanto segue:
- Non è necessario utilizzare
include
per i tipi di file non LookML, ad esempio i file di documentazione o i file di dati. - L'inclusione dei file è interamente o inesistente, quindi tutte le informazioni del file inclusoed vengono aggiunte al file inclusoing.
- In un file puoi utilizzare più parametri
include
. - Puoi utilizzare il carattere jolly
*
per indicare i file che utilizzano convenzioni di denominazione strategiche o con la stessa estensione. Ad esempio, puoi utilizzare"*base.dashboard"
per creare una corrispondenza e includere sia"database.dashboard"
che"crunchbase.dashboard"
. Puoi utilizzare"*.dashboard"
per indicare tutti i file con l'estensione.dashboard
. - Puoi utilizzare il carattere jolly
*
per includere tutti i file della directory. Ad esempio, puoi includere tutti i file delle viste nella directoryviews/users/
specificandoinclude: "/views/users/*.view"
. Per ulteriori informazioni sull'utilizzo dei caratteri jolly nelle cartelle IDE, consulta la pagina della documentazione sulle cartelle dell'IDE.
Suggerimento pratico: quando utilizzi i caratteri jolly, puoi controllare quali file sono inclusi passando il mouse sopra l'icona delle informazioni accanto al numero di riga nel file oppure facendo clic sull'istruzione
include
e cercando nella guida rapida:
Suggerimento manuale: puoi copiare il percorso di un file selezionando Copia percorso file dal menu con tre puntini dell'IDE di Looker:
Utilizzo di include
in un file modello
Puoi utilizzare il parametro include
in un file modello per includere visualizzazioni e dashboard o esplorazioni.
Includere visualizzazioni e dashboard in un modello
Utilizza il parametro include
in un file modello per specificare la dashboard e visualizzare i file disponibili per il modello. Se vuoi utilizzare o fare riferimento a un file LookML all'interno di un modello, devi aggiungerlo con il parametro include
.
Nel parametro include
, utilizza l'estensione .view
per visualizzare i file e l'estensione .dashboard
per le dashboard. Puoi escludere le parti .lkml
e .lookml
di queste estensioni.
Puoi utilizzare il carattere jolly *
per indicare i file che utilizzano convenzioni di denominazione strategiche o con la stessa estensione. Puoi anche utilizzare il carattere jolly *
in combinazione con i percorsi della directory per specificare più file, come descritto nella sezione Esempi di caratteri jolly della pagina della documentazione sulle cartelle IDE.
Ad esempio, puoi utilizzare questi parametri include
in un file modello:
include: "/**/*.dashboard"
include: "/*/*base.view.lkml"
include: "//e_commerce/views/*.view.lkml"
Questi parametri includono i seguenti file:
- Tutti i file della dashboard in qualsiasi directory del progetto
- Tutti i file delle viste che terminano con
base.view.lkml
in qualsiasi directory secondaria immediata del progetto, come/views/database.view.lkml
o/public/crunchbase.view.lkml
- Tutti i file delle viste nella directory
/views/
del progetto importato denominatie_commerce
Se il tuo progetto ha un numero elevato di file di visualizzazione o se utilizza tabelle derivate persistenti (PDT), dovresti evitare di includere tutti i file di visualizzazione nel modello. Includi invece singoli file di visualizzazione come questo. Ecco un esempio di inclusione dei singoli file delle viste e di tutte le dashboard in un progetto:
include: "/views/order.view"
include: "/views/user.view"
include: "/**/*.dashboard"
Inclusione dei modelli in un modello
Non puoi includere un file modello da un altro progetto. Invece, per riutilizzare, perfezionare o estendere le esplorazioni tra i progetti, nel progetto importato puoi creare un file Esplora separato e poi includerlo in altri progetti. Per ulteriori informazioni, consulta la sezione Utilizzo delle esplorazioni in un modello.
Inclusione delle esplorazioni in un modello
I file Esplora ascoltano la connessione del modello in cui sono inclusi. Tieni presente questo aspetto quando includi i file di esplorazione in modelli configurati con una connessione diversa da quella del modello principale del file Esplora. Se lo schema per la connessione del modello incluso è diverso da quello dello schema per la connessione del modello principale, può causare errori nelle query.
Le esplorazioni di solito vengono definite all'interno di un file modello. Tuttavia, a volte hai bisogno di un file Explore distinto per una tabella derivata oppure per estendere o perfezionare un'esplorazione nei vari modelli.
Se hai un file Explore separato, devi includere il parametro include
nel file modello per includerlo. Nel parametro include
, utilizza l'estensione .explore.lkml
per i file Esplora.
Ad esempio, di seguito è riportato un file modello con due esplorazioni:
aircraft_new
Explore (Esplora), definito nel proprio file denominatoaircraft_new.explore.lkml
nella cartellaexplores
. Poiché l'esplorazione è definita in un proprio file, devi specificare il percorso del file Esplora in un parametroinclude
.accidents
Explore (Esplora), definito all'interno del file del modello. Poiché è definito nel file del modello stesso, non è necessario utilizzare un parametroinclude
nel modello. Tuttavia, è necessario uninclude
per la vista su cui si basa l'esplorazioneaccidents
.
connection: "faa"
include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"
explore: accidents {
view_name: accidents
from: accidents
}
Includere test dei dati in un modello
I test dei dati possono essere definiti direttamente in un file modello o in un file di visualizzazione. Tuttavia, puoi anche creare un file di test dati separato se vuoi riutilizzarli in più punti del progetto.
Se hai un file di test dei dati separato, devi utilizzare il parametro include
nel file modello o nel file di visualizzazione per poter eseguire i test dei dati. Nel parametro include
, utilizza l'estensione .lkml
per i file di test dei dati.
Ad esempio, di seguito è riportato un estratto di un file modello che include un file di test dei dati:
connection: "faa"
include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"
include: "/tests/data_tests.lkml"
. . .
Una volta incluso il file di test dei dati in un file del modello, puoi eseguire il test dei dati per verificare che funzioni correttamente e per verificare se la logica del modello supera il test.
Puoi anche includere il file di test dei dati in un file vista, come descritto nella sezione Includere i test dei dati in una vista di questa pagina.
Utilizzo di include
in un file di visualizzazione
Nella maggior parte dei casi, non è necessario utilizzare include
in un file di visualizzazione. Tuttavia, in alcuni casi vuoi includere file nel file di visualizzazione:
- Se stai estendendo o perfezionando una vista
- Se hai un file Explore (Esplora) per una tabella derivata
Includere le visualizzazioni di una vista (per estendere o perfezionare la selezione).
Puoi anche includere un file di visualizzazione in un altro file di vista per estendere o perfezionare la visualizzazione inclusa.
Ad esempio, ecco il file di vista marketing_order_fields
che include il file basic_order_fields
e poi lo estende:
include: "/views/basic_order_fields.view"
view: marketing_order_fields {
extends: [basic_order_fields] # The file that contains the basic_order_fields
} # view should be included
Include le esplorazioni in una visualizzazione
I file Esplora ascoltano la connessione del modello in cui sono inclusi. Tieni presente questo aspetto quando includi i file di esplorazione in modelli configurati con una connessione diversa da quella del modello principale del file Esplora. Se lo schema per la connessione del modello incluso è diverso da quello dello schema per la connessione del modello principale, può causare errori nelle query.
Nella maggior parte dei casi, non è necessario includere un Explore in una visualizzazione. Tuttavia, le tabelle derivate native sono un caso speciale perché sono definite nel proprio file di vista che ha un parametro explore_source
. Puoi utilizzare il parametro explore_source
per specificare un'esplorazione e definire le colonne desiderate e altre caratteristiche desiderate per la tabella derivata nativa. Le esplorazioni sono di solito definite all'interno di un file modello, ma nel caso di tabelle derivate native può essere più semplice creare un file separato per l'esplorazione utilizzando l'estensione del file .explore.lkml
. Se crei un file Esplora separato, devi includerlo nel file nativo della visualizzazione derivata.
Ecco un esempio di utilizzo di include
in un file di visualizzazione tabella derivato nativo per indirizzare a un file Esplora:
include: "/explores/order_items.explore.lkml"
view: user_order_facts {
derived_table: {
explore_source: order_items {
column: user_id {field: order_items.user_id}
column: lifetime_number_of_orders {field: order_items.order_count}
column: lifetime_customer_value {field: order_items.total_revenue}
derived_column: average_customer_order {
sql: lifetime_customer_value / lifetime_number_of_orders ;;
}
}
}
dimension: user_id {hidden: yes}
dimension: lifetime_number_of_orders {type: number}
dimension: lifetime_customer_value {type: number}
dimension: average_customer_order {type: number}
}
Per saperne di più sui file Esplora per le tabelle native derivate, consulta la nostra documentazione sull'utilizzo delle istruzioni include
per attivare i campi di riferimento.
Includere test dei dati in una vista
I test dei dati possono essere definiti direttamente in un file modello o in un file di visualizzazione. Tuttavia, puoi anche creare un file di test dati separato se vuoi riutilizzarli in più punti del progetto.
Se hai un file di test dei dati separato, devi utilizzare il parametro include
nel file modello o nel file di visualizzazione per poter eseguire i test dei dati. Nel parametro include
, utilizza l'estensione .lkml
per i file di test dei dati.
Ad esempio, di seguito è riportato un estratto di un file di visualizzazione che include un file di test dei dati:
include: "/tests/data_tests.lkml"
view: orders {
sql_table_name: looker.orders ;;
dimension: id {
primary_key: yes
type: number
sql: ${TABLE}.id ;;
}
. . .
Una volta incluso il file di test dei dati in un file vista, puoi eseguire il test per verificare che il test funzioni correttamente e per controllare se la logica della vista supera il test.
Puoi anche includere il file di test dei dati in un file modello, come descritto nella sezione Inclusione dei test dei dati in un modello in questa pagina.
Utilizzo di include
in un file Esplora
Le esplorazioni di solito vengono definite all'interno di un file modello. Tuttavia, a volte hai bisogno di un file Explore distinto per una tabella derivata oppure per estendere o perfezionare un'esplorazione nei vari modelli.
Se hai un file Explore separato, puoi utilizzare il parametro include
per includere le visualizzazioni o altre Esplora.
Includere le visualizzazioni in un'esplorazione
Se hai un file Esplora separato, devi includere tutte le viste utilizzate da Esplora. Utilizza l'estensione .view
per visualizzare i file. Puoi escludere la parte .lkml
dell'estensione del file. Ecco un esempio di file Esplora che include le due viste che sta utilizzando:
include: "/views/aircraft.view"
include: "/views/aircraft_types.view"
explore: aircraft {
join: aircraft_types {
type: left_outer
sql_on: ${aircraft.aircraft_type_id} = ${aircraft_types.aircraft_type_id} ;;
relationship: many_to_one
}
}
Includere le esplorazioni in un'esplorazione
I file Esplora ascoltano la connessione del modello in cui sono inclusi. Tieni presente questo aspetto quando includi i file di esplorazione in modelli configurati con una connessione diversa da quella del modello principale del file Esplora. Se lo schema per la connessione del modello incluso è diverso da quello dello schema per la connessione del modello principale, può causare errori nelle query.
Puoi includere un file Esplora in un altro file di Esplora, ad esempio quando estendi o rifiuti un'esplorazione. Utilizza il parametro include
e aggiungi l'estensione del file .explore.lkml
.
Ecco un esempio di file Explore che include un altro file Explore e poi estende l'app:
include: "/explores/base.explore.lkml"
explore: aircraft_information {
extends: [aircraft]
Esempi
Consulta le sezioni precedenti per esempi di utilizzo di include
nei file modello, nella visualizzazione dei file e nell'esplorazione dei file.
Aspetti da considerare
Caratteri jolly
Per i progetti in cui è necessario gestire solo pochi file, puoi elencare ogni file nel relativo parametro include
, in questo modo:
include: "/dashboards/user_info.dashboard"
include: "/views/users.view"
Bur per i progetti con molti file da includere, puoi ridurre il numero di parametri include
che devi scrivere utilizzando i caratteri jolly per includere più file contemporaneamente:
- Utilizza i caratteri jolly con le cartelle IDE per includere i file in una directory specifica del progetto.
- Utilizza i caratteri jolly con le estensioni per includere file di un tipo specifico.
- Usa i caratteri jolly con nomi file strategici per includere file con prefissi o suffissi specifici nei nomi file.
L'utilizzo dei caratteri jolly può essere particolarmente utile durante lo sviluppo quando devi creare una correzione temporanea per gli avvisi di convalida di LookML, soprattutto quando organizzi un progetto esistente in cartelle IDE. Tuttavia, tieni presente quanto segue quando utilizzi i caratteri jolly nelle istruzioni include
:
- Looker sconsiglia l'uso di caratteri jolly per includere tutti i file delle viste in un progetto, poiché l'inclusione di tutti i file delle viste può incidere sulle prestazioni della convalida di LookML e può cludere lo schema del database.
- Looker non supporta l'uso di caratteri jolly per includere tutti i file di un progetto se il progetto ha più file modello, poiché i file modello non possono essere inclusi in altri file modello.
Utilizzo di caratteri jolly con cartelle IDE
Puoi utilizzare i caratteri jolly in combinazione con le cartelle dell'IDE per includere i file in una directory specifica nel tuo progetto LookML.
Ad esempio, la seguente istruzione include
fa riferimento a tutti i file nella directory /explores/
di un progetto LookML:
include: "/explores/*"
Utilizzare i caratteri jolly per tipi di file specifici
Puoi utilizzare i caratteri jolly per fare riferimento a tutti i file di un tipo specifico. Ad esempio, questa istruzione include
fa riferimento a tutti i file Explore di un progetto LookML:
include: "/**/*.explore.lkml"
Consulta la sezione Tipi di file di progetto della pagina della documentazione relativa ai file di progetto LookML per un elenco dei tipi di file LookML e delle relative estensioni.
Looker sconsiglia l'uso di caratteri jolly per includere tutti i file delle viste in un progetto, poiché l'inclusione di tutti i file delle viste può incidere sulle prestazioni della convalida di LookML e può cludere lo schema del database.
Utilizzo di caratteri jolly con pattern di denominazione strategici
Puoi anche utilizzare i caratteri jolly con la denominazione strategica dei file per ottimizzare ulteriormente le istruzioni include
. Ad esempio, invece di denominare i file in questo modo:
/views/apple.view
/views/banana.view
/views/cherry.view
/views/orange.view
/views/celery.view
Puoi aggiungere un prefisso o un suffisso strategico ai nomi dei file, in questo modo:
/views/apple.fruit.view
/views/banana.fruit.view
/views/cherry.fruit.view
/views/orange.fruit.view
/views/celery.vegetable.view
Quindi utilizza i caratteri jolly per fare riferimento solo al suffisso .fruit
utilizzando questo include
:
include: "/views/*.fruit.view"
L'inclusione di tutti i file di visualizzazione può influire sul rendimento della convalida LookML
Se il tuo progetto ha un numero elevato di file di viste e li includi tutti nel file del modello, ciò potrebbe influire sulle prestazioni dello Strumento di convalida LookML. Poiché lo strumento di convalida LookML controlla tutti i file delle viste incluse nel modello, devi includere solo i file delle viste necessarie nel parametro include
del file modello.
Valuta la possibilità di utilizzare convenzioni di denominazione strategiche per i file delle viste al fine di consentire l'inclusione semplice di gruppi di viste all'interno di un modello (vedi l'esempio in Utilizzo di caratteri jolly con pattern di denominazione strategici in questa pagina). In alternativa, puoi utilizzare le cartelle dell'IDE per organizzare le visualizzazioni in cartelle. Puoi quindi utilizzare il carattere jolly *
per includere tutte le visualizzazioni in un'unica cartella, anziché tutte le visualizzazioni nel progetto. Per informazioni, consulta la nostra documentazione sull'utilizzo di include
con cartelle IDE.
L'inclusione di tutti i file di visualizzazione può riempire lo schema di database
Per i progetti che utilizzano le tabelle derivate persistenti (PDT), puoi includere il file di visualizzazione delle PDT nel file del modello. Tuttavia, ogni file modello che include la vista PDT creerà una copia della PDT nello schema temporaneo sul tuo database. Se hai più file modello e includi tutti i file di visualizzazione nei file modello, potresti aggiungere disordine non necessario allo schema temporaneo del database. Per questo motivo, assicurati di includere il file di vista di una PDT solo nei file modello in cui è necessaria.