includi

Utilizzo


include: "/views/airports.view"
Gerarchia
include

- o -

include

- o -

include
Valore predefinito
Nessuno

Accetta
Una stringa contenente un nome file o un pattern

Definizione

Il parametro include specifica i file LookML che saranno disponibili per un modello, una vista o un'esplorazione. Se vuoi utilizzare o fare riferimento a un file LookML all'interno di un altro file, devi aggiungerlo con il parametro include.

Puoi utilizzare il parametro include nei file modello, nei file di visualizzazione e nei file di esplorazione. Il parametro include può fare riferimento a diversi tipi di file LookML, a seconda del contesto.

In un file modello, puoi utilizzare include per fare riferimento a questi tipi di file:

In un file di visualizzazione, puoi utilizzare include per fare riferimento a questi tipi di file:

In un file Esplora, puoi utilizzare include per fare riferimento a questi tipi di file:

Puoi anche utilizzare include per importare file da altri progetti. Per informazioni sull'inclusione di file di un altro progetto, consulta la pagina della documentazione Importazione di file da altri progetti.

Tieni presente quanto segue quando utilizzi include:

  • Non è necessario utilizzare include per i tipi di file non LookML, come i file di documentazione o i file di dati.
  • L'inclusione dei file è tutto o niente, quindi tutte le informazioni del file incluso vengono aggiunte al file includente.
  • Puoi utilizzare più parametri include in un file.
  • Puoi utilizzare il carattere jolly * per indicare i file con convenzioni di denominazione strategiche o con la stessa estensione. Ad esempio, puoi utilizzare "*base.dashboard" per trovare 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 in una directory. Ad esempio, puoi includere tutti i file di visualizzazione nella directory views/users/ specificando include: "/views/users/*.view". Per saperne di più sull'utilizzo dei caratteri jolly con le cartelle IDE, consulta la pagina della documentazione relativa alle cartelle IDE.

Utilizzo di include in un file modello

Puoi utilizzare il parametro include in un file modello per includere visualizzazioni e dashboard o esplorazioni.

Inclusione di viste e dashboard in un modello

Utilizza il parametro include in un file modello per specificare i file di dashboard e visualizzazione che saranno 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 i file di visualizzazione e l'estensione .dashboard per le dashboard. Puoi omettere la parte .lkml e .lookml di queste estensioni.

Puoi utilizzare il carattere jolly * per indicare i file con convenzioni di denominazione strategiche o con la stessa estensione. Puoi anche utilizzare il carattere jolly * in combinazione con i percorsi delle directory per specificare più file, come descritto nella sezione Esempi di caratteri jolly della pagina dei parametri include.

Ad esempio, potresti 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 di visualizzazione che terminano con base.view.lkml in qualsiasi directory secondaria immediata del progetto, ad esempio /views/database.view.lkml o /public/crunchbase.view.lkml
  • Tutti i file di visualizzazione nella directory /views/ del progetto importato denominato e_commerce

Se il tuo progetto ha un numero elevato di file di visualizzazione o se utilizza tabelle derivate persistenti (PDT), devi evitare di includere tutti i file di visualizzazione nel modello. Includi invece singoli file di visualizzazione come questo. Ecco un esempio di inclusione di singoli file di visualizzazione e di tutte le dashboard in un progetto:

include: "/views/order.view"
include: "/views/user.view"
include: "/**/*.dashboard"

Inclusione di modelli in un modello

Non puoi includere un file modello di un altro progetto. Per riutilizzare, perfezionare o estendere le esplorazioni tra i progetti, nel progetto importato puoi creare un file Explore separato, quindi includerlo in altri progetti. Per saperne di più, consulta la sezione Includere le esplorazioni in un modello.

Inclusione di esplorazioni in un modello

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

Se hai un file Esplora separato, devi utilizzare il parametro include nel file del modello per includerlo. Nel parametro include, utilizza l'estensione .explore.lkml per i file di Esplora.

Il seguente esempio è un file modello con due esplorazioni:

  • L'esplorazione aircraft_new, definita nel proprio file denominato aircraft_new.explore.lkml nella cartella explores. Poiché l'esplorazione è definita in un file separato, devi specificare il percorso del file di esplorazione in un parametro include.
  • L'esplorazione accidents, definita all'interno del file del modello. Poiché è definito nel file del modello stesso, non è necessario utilizzare un parametro include nel modello. Tuttavia, è necessario un include per la visualizzazione su cui si basa l'esplorazione accidents.
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 dei dati separato se vuoi riutilizzare i test dei dati in più posizioni del progetto.

Se hai un file di test sui dati separato, devi utilizzare il parametro include nel file del modello o nel file della vista per poter eseguire i test sui dati. Nel parametro include, utilizza l'estensione .lkml per i file di test dei dati.

Ad esempio, ecco un estratto di un file del 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 modello, puoi eseguire il test dei dati per verificare che funzioni correttamente e per vedere se la logica del modello supera il test.

Puoi anche includere il file di test dei dati in un file di visualizzazione, come descritto nella sezione Inclusione dei test dei dati in una visualizzazione 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, ci sono alcuni casi in cui vuoi includere i file nel file di visualizzazione:

Inclusione di viste in una vista (per estendere o perfezionare)

Puoi anche includere un file di visualizzazione in un altro file di visualizzazione per estendere o ottimizzare la visualizzazione inclusa.

Ad esempio, ecco il file di visualizzazione marketing_order_fields che include il file di visualizzazione basic_order_fields e 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

Includere le esplorazioni in una visualizzazione

Nella maggior parte dei casi, non è necessario includere un'esplorazione in una visualizzazione. Tuttavia, le tabelle derivate native sono un caso speciale perché sono definite nel proprio file di visualizzazione con un parametro explore_source. Utilizzi il parametro explore_source per specificare un'esplorazione e definire le colonne e le altre caratteristiche desiderate per la tabella derivata nativa. Le esplorazioni vengono in genere definite all'interno di un file modello, ma nel caso di tabelle derivate native potrebbe 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 di visualizzazione della tabella derivata nativa.

Ecco un esempio di utilizzo di include in un file di visualizzazione della tabella derivata nativa per indirizzare un file di 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 ulteriori informazioni sui file Explore per le tabelle derivate native, consulta la nostra documentazione sull'utilizzo delle istruzioni include per attivare i campi di riferimento.

Includere i test sui dati in una visualizzazione

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 dei dati separato se vuoi riutilizzare i test dei dati in più posizioni del progetto.

Se hai un file di test sui dati separato, devi utilizzare il parametro include nel file del modello o nel file della vista per poter eseguire i test sui dati. Nel parametro include, utilizza l'estensione .lkml per i file di test dei dati.

Ad esempio, ecco 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 ;;
  }

. . .

Dopo aver incluso il file di test dei dati in un file di visualizzazione, puoi eseguire il test dei dati per verificare che funzioni correttamente e per vedere se la logica della visualizzazione supera il test.

Puoi anche includere il file di test dei dati in un file del modello, come descritto nella sezione Includere i test dei dati in un modello di questa pagina.

Utilizzo di include in un file Esplora

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

Se hai un file Explore separato, puoi utilizzare il parametro include per includere visualizzazioni o altre esplorazioni.

Includere le visualizzazioni in un'esplorazione

Se hai un file di esplorazione separato, devi includere tutte le visualizzazioni utilizzate dall'esplorazione. Utilizza l'estensione .view per i file di visualizzazione. Puoi omettere la parte .lkml dell'estensione del file. Ecco un esempio di file di esplorazione che include le due visualizzazioni che utilizza:

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

Puoi includere un file Esplora in un altro, ad esempio quando estendi o ottimizzi 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 lo estende:

include: "/explores/base.explore.lkml"

explore: aircraft_information {
  extends: [aircraft]

Utilizzo di include con le cartelle IDE

Quando organizzi i file di progetto LookML in cartelle, devi fornire i percorsi dei file all'interno dell'istruzione include.

Puoi utilizzare percorsi assoluti o relativi nell'istruzione include (consulta la sezione Sintassi del percorso in questa pagina per esempi) e puoi utilizzare i caratteri jolly * e ** per includere più file contemporaneamente (consulta la sezione Esempi di caratteri jolly in questa pagina per esempi).

Ad esempio, supponi di avere questa struttura di directory nel tuo progetto, con i seguenti contenuti di primo livello della cartella views:

  • La cartella orders, che contiene i file di visualizzazione order_facts e order_items
  • La cartella users, che contiene i file di visualizzazione user_with_age_extension, users e users_extended
  • I file di visualizzazione individuale distribution_centers, events, inventory_items e products

Struttura di directory di esempio con cartelle per esplorazioni, modelli e visualizzazioni.

Le seguenti istruzioni includeranno la vista products, la vista order_facts e tutte le viste nella directory /views/users/:

include: "/views/products.view"
include: "/views/orders/order_facts.view"
include: "/views/users/*.view"

Quando modifichi il percorso di un file, assicurati di aggiornare tutte le istruzioni include nel progetto in modo che corrispondano al nuovo percorso del file. Potresti visualizzare avvisi di convalida di LookML nelle vecchie istruzioni include se non fanno più riferimento a file o percorsi di file esistenti. Inoltre, potresti visualizzare errori di convalida di LookML per gli oggetti a cui viene fatto riferimento e che non sono più reperibili perché i relativi percorsi dei file sono cambiati.

Sintassi del percorso

Ecco alcune sintassi di esempio che puoi utilizzare per includere i file:

Sintassi Descrizione
PATH Percorso relativo a partire dalla posizione del file corrente.
./PATH Percorso relativo a partire dalla posizione del file corrente. Questo esempio rimanda allo stesso file dell'esempio precedente: PATH.
../PATH Percorso relativo a partire dalla directory principale del file corrente.
/PATH Percorso assoluto a partire dalla radice del progetto corrente.
//PROJECT_NAME/PATH Percorso assoluto a partire dalla radice di un progetto importato denominato PROJECT_NAME.

Utilizzo dei caratteri jolly

Per i progetti in cui è necessario gestire solo pochi file, puoi elencare ogni file nel proprio parametro include, come segue:

include: "/dashboards/user_info.dashboard"
include: "/views/users.view"

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:

L'utilizzo di 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:

Utilizzo di caratteri jolly con le cartelle IDE

Puoi utilizzare i caratteri jolly in combinazione con le cartelle IDE per includere file in una directory specifica del tuo progetto LookML.

Ad esempio, questa istruzione include fa riferimento a tutti i file nella directory /explores/ di un progetto LookML:

include: "/explores/*"

Utilizzo di 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 in un progetto LookML:

include: "/**/*.explore.lkml"

Per un elenco dei tipi di file LookML e delle relative estensioni, consulta la sezione Tipi di file in un progetto LookML della pagina della documentazione Informazioni sui file di progetto LookML.

Utilizzo di caratteri jolly con pattern di denominazione strategici

Puoi anche utilizzare i caratteri jolly con una denominazione strategica dei file per ottimizzare ulteriormente i tuoi estratti conto 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, ad esempio:

/views/apple.fruit.view
/views/banana.fruit.view
/views/cherry.fruit.view
/views/orange.fruit.view
/views/celery.vegetable.view

Poi utilizza i caratteri jolly per fare riferimento solo al suffisso .fruit utilizzando questo include:

include: "/views/*.fruit.view"

Esempi di caratteri jolly

Ecco alcuni esempi che utilizzano caratteri jolly (tieni presente che puoi sostituire PATH con le sintassi dei percorsi nella tabella precedente):

Sintassi Descrizione
PATH/*.view Corrispondenza con caratteri jolly per i file che terminano con .view in PATH.
PATH/*.view.lkml Corrispondenza con caratteri jolly per i file che terminano con .view.lkml in PATH.

Poiché i file di visualizzazione hanno l'estensione .view.lkml, questo esempio specifica lo stesso file dell'esempio precedente, PATH/*.view. La parte .lkml non viene visualizzata nell'IDE, né è necessaria per le istruzioni include..lkml Tuttavia, puoi utilizzare i caratteri jolly per sfruttare questa parte comune dell'estensione del file. Per un elenco delle estensioni dei file di progetto, consulta la pagina della documentazione File di progetto LookML.
PATH/*.lkml Corrispondenza con caratteri jolly per i file che terminano con .lkml in PATH.

Tieni presente che diversi tipi di file condividono .lkml come parte finale dell'estensione del file, ad esempio .view.lkml e .model.lkml. La parte .lkml non viene visualizzata nell'IDE, né è necessaria per le istruzioni include..lkml Tuttavia, puoi utilizzare i caratteri jolly per sfruttare questa parte comune dell'estensione del file. Per un elenco delle estensioni dei file di progetto, consulta la pagina della documentazione File di progetto LookML.
PATH/myfile.* File con corrispondenza con caratteri jolly denominati myfile con qualsiasi tipo di estensione in PATH.
PATH/myfile.*.lkml File di corrispondenza con caratteri jolly denominati myfile con qualsiasi tipo di estensione .lkml in PATH.
PATH/my*file.view Corrispondenza con caratteri jolly dei file che iniziano con my e terminano con file.view alle ore PATH.
PATH/my*fi*le.view Caratteri jolly che corrispondono ai file che iniziano con my, seguiti da alcuni caratteri, poi fi, alcuni caratteri aggiuntivi e che terminano con le.view alle ore PATH.
PATH/*/myfile.lkml Carattere jolly del nome cartella (corrisponde a un solo livello di nidificazione). Corrisponde a tutti i file myfile.lkml in qualsiasi directory secondaria diretta di PATH.
PATH/**/my_file.view Corrispondenza con caratteri jolly ricorsivi (corrispondenza con qualsiasi livello di nidificazione) per tutti i file denominati my_file.view.lkml in PATH e in tutte le sottodirectory.
PATH/**/*.view Corrispondenza ricorsiva con caratteri jolly di tutti i file che terminano con .view.lkml nelle sottodirectory di PATH.
PATH/**/my_folder/myfile.view Corrispondenza ricorsiva con caratteri jolly del percorso secondario /my_folder/myfile.view a qualsiasi livello sotto PATH.

Esempi

Consulta le sezioni precedenti per esempi di utilizzo di include nei file modello, nei file di visualizzazione e nei file di esplorazione.

Aspetti da considerare

L'inclusione di tutti i file di visualizzazione può influire sulle prestazioni della convalida di LookML

Se il tuo progetto ha un numero elevato di file di visualizzazione e li includi tutti nel file modello, ciò potrebbe influire sulle prestazioni dello strumento di convalida LookML. Poiché il validatore LookML controlla tutti i file di visualizzazione inclusi nel modello, devi includere solo i file di visualizzazione necessari nel parametro include del file modello.

Valuta la possibilità di utilizzare convenzioni di denominazione strategiche per i file di visualizzazione per consentire la facile inclusione di gruppi di visualizzazioni all'interno di un modello (vedi l'esempio in Utilizzo dei caratteri jolly con pattern di denominazione strategici in questa pagina). In alternativa, puoi utilizzare le cartelle IDE per organizzare le visualizzazioni in cartelle. Poi puoi utilizzare il carattere jolly * per includere tutte le visualizzazioni in un'unica cartella, anziché includerle tutte nel progetto. Per informazioni, consulta la sezione sull'utilizzo di include con le cartelle IDE.

L'inclusione di tutti i file di visualizzazione può ingombrare lo schema del database

Per i progetti che utilizzano tabelle derivate permanenti (PDT), puoi includere il file della vista della PDT nel file del modello. Tuttavia, ogni file del modello che include il file di visualizzazione del PDT creerà una copia del PDT nello schema scratch del database. Se hai più file modello e includi tutti i file di visualizzazione nei file modello, potresti aggiungere elementi inutili allo schema temporaneo del database. Per questo motivo, assicurati di includere il file di visualizzazione di un PDT solo nei file del modello in cui è necessario.