Importazione di file da altri progetti

Puoi importare file da altri progetti LookML e repository esterni nel tuo progetto attuale, il che ti consente di utilizzare file modello, file di visualizzazione e altri file in più di un progetto. I progetti importati sono di sola lettura. Se vuoi modificare i file, devi farlo dal loro progetto LookML (o da un altro editor connesso al repository Git dei file).

Esistono diversi casi d'uso per l'importazione di file nel progetto LookML. Di seguito sono riportati alcuni esempi:

  • Creare un blocco Looker installato senza dover apportare modifiche dirette. Se Looker apporta modifiche al blocco, puoi estrarle perché tutto il codice LookML che hai aggiunto viene conservato in un repository separato.

  • Mantenere un progetto di base generato automaticamente in base allo schema del database. Puoi inserire tutte le dimensioni, le misure e simili personalizzate in un progetto separato che importa tutto il codice LookML dal progetto generato automaticamente. Puoi rigenerare regolarmente il progetto di base man mano che lo schema del database cambia senza sovrascrivere tutto il codice LookML personalizzato.

  • Incapsulare gli oggetti condivisi in un unico progetto e poi importarli in più progetti. Ad esempio, se hai una tabella comune a più database, puoi inserire la relativa visualizzazione in un progetto e gestirla in un unico posto. Poi, fai in modo che più progetti lo utilizzino importando la tabella in questi progetti.

Per importare file da un altro progetto, svolgi le seguenti attività:

  1. Crea un file manifest del progetto.
  2. Specifica i progetti locali o remoti che vuoi importare.
  3. Visualizzare i file di un progetto importato.
  4. Includi file da un progetto importato.

Potrai quindi fare riferimento ai campi dei file del progetto importato e ignorare i valori delle costanti definite nel progetto importato, se le costanti consentono l'override.

Creare un file manifest del progetto

Qualsiasi progetto che importa file da altri progetti deve avere un file manifest del progetto. Se il tuo progetto non ha già un file manifest, puoi crearne uno dall'icona + nella parte superiore del browser dei file nell'IDE di Looker.

Per importare i progetti, specificali nel manifest. Puoi specificare progetti locali o remoti, come descritto nelle sezioni seguenti.

Importazione di progetti locali

L'importazione di progetti locali può essere utilizzata solo se il progetto importato è presente nella stessa istanza di Looker. Inoltre, è consigliabile che gli sviluppatori dispongano delle autorizzazioni per i modelli per i modelli del progetto importato. Se gli sviluppatori dispongono delle autorizzazioni del modello nel progetto importato, il controllo delle versioni sarà dinamico, il che significa che le modifiche nel progetto importato influiranno immediatamente sul progetto che lo importa. In questo modo, gli sviluppatori possono convalidare le modifiche in entrambi i progetti prima di eseguire il push alla produzione. Inoltre, per gli sviluppatori con autorizzazioni del modello in entrambi i progetti, i file del progetto importati rifletteranno lo stato della modalità Development (Sviluppo) dello sviluppatore. Pertanto, se lo sviluppatore è in modalità Development (Sviluppo), l'IDE Looker mostrerà la modalità Development (Sviluppo) dei file del progetto importato. Se lo sviluppatore è in modalità Produzione, l'IDE Looker mostrerà la modalità Produzione del progetto importato.

Nel file manifest, il parametro project_name specifica il nome del progetto corrente (Looker compila automaticamente questo parametro quando crei il file manifest per il progetto). Per importare un progetto locale nel progetto corrente, utilizza uno o più parametri local_dependency per specificare il progetto o i progetti da importare:

# This project
project_name: "my_project"

# The project to import
local_dependency: {
  project: "my_other_project"
}

Nei seguenti scenari, devi utilizzare l'importazione di progetti remoti anziché l'importazione di progetti locali:

  • I tuoi sviluppatori non dispongono delle autorizzazioni per i modelli nei modelli del progetto importato. In questo caso, Looker crea un clone della modalità di produzione del progetto importato e mostra la versione statica dei file nell'IDE. Questa versione statica non mostrerà mai la versione in modalità di sviluppo dei file e potrebbe anche essere obsoleta rispetto alla modalità di produzione corrente senza avvisare lo sviluppatore. È preferibile utilizzare l'importazione di progetti remoti e fornire un ref che specifichi un ramo Git o una release Git nel progetto remoto. In questo modo, Looker rileverà automaticamente i nuovi commit nel progetto remoto, in modo che gli sviluppatori vengano avvisati e possano importare l'ultima versione dei file del progetto remoto.
  • Gli sviluppatori devono sempre lavorare con la versione di produzione di un progetto importato.
  • Gli sviluppatori devono lavorare con una versione statica dei file del progetto importato.

Importazione di progetti remoti

In un'importazione remota, il progetto importato non deve trovarsi sulla stessa istanza. Il progetto viene invece importato tramite il repository Git remoto.

Per importare un repository remoto, utilizza il parametro remote_dependency per fornire le informazioni per il repository remoto. Il parametro remote_dependency accetta le seguenti informazioni e i seguenti parametri secondari:

  • Il nome del progetto importato, che può essere qualsiasi. Nel seguente esempio, il nome del progetto è ga_360_block. Utilizzi questo nome nelle istruzioni include per fare riferimento ai file importati nei progetti LookML. Il nome viene utilizzato anche come nome della cartella nella cartella imported_projects dell'IDE di Looker.
  • Il parametro secondario url, in cui specifichi l'indirizzo del repository Git esterno. Utilizza l'URL principale del repository.
  • Il parametro secondario ref, in cui specifichi un ramo Git, un tag di release Git o la SHA di un commit nel repository Git. Puoi specificare uno SHA di commit se vuoi il controllo delle versioni statico, in modo che le modifiche al progetto importato non vengano automaticamente riportate nel tuo progetto (questa è una buona opzione per i blocchi Looker). In alternativa, puoi specificare un ramo Git o un tag di release Git se vuoi che Looker rilevi automaticamente i nuovi commit nel progetto remoto. Per saperne di più, consulta la sezione Rilevare automaticamente le nuove versioni di un progetto remoto in questa pagina.
  • Il sottoparametro override_constant, che è un sottoparametro facoltativo che consente di ignorare il valore di una costante definita in un progetto importato.

Ecco un esempio di parametro remote_dependency in un file manifest del progetto. Questo esempio utilizza una connessione HTTPS:

remote_dependency: ga360_block {
  url: "https://github.com/llooker/google_ga360"
  ref: "master"
  override_constant: connection {
    value: "importing_project_connection"
  }
}

Puoi anche utilizzare SSH:

remote_dependency: ga360_block {
  url: "git@github.com:llooker/google_ga360.git"
  ref: "master"
  override_constant: connection {
    value: "importing_project_connection"
  }
}

Dopo aver aggiunto la dipendenza remota, potrebbe essere necessario configurare le credenziali di importazione per il progetto remoto. Consulta la sezione Configurazione delle credenziali di autenticazione per i repository remoti privati in questa pagina.

Rilevamento automatico di nuove versioni di un progetto remoto

Puoi fare in modo che Looker rilevi automaticamente i nuovi commit nel progetto remoto se specifichi un ramo Git o un tag di release Git nel parametro secondario ref di remote_dependency nel file manifest.

Ad esempio, ecco una dipendenza remota in cui il branch master è specificato nel sottoparametro ref:

remote_dependency: exchange_rate {
  url: "https://github.com/llooker/datablocks-exchangerate.git"
  ref: "master"
}

Successivamente, quando il ramo master viene aggiornato con nuovi commit, Looker rileva automaticamente le modifiche.

Ecco un esempio in cui viene specificato il tag di rilascio v1.0:

remote_dependency: e_faa_original {
  url: "https://github.com/llooker/google_ga360"
  ref: "v1.0"
}

Indipendentemente dal tipo di valore specificato per il parametro ref, anche un SHA di commit, l'IDE mostrerà il pulsante Aggiorna dipendenze nella barra di navigazione del progetto in alto quando aggiungi un parametro remote_dependency al progetto.

Fai clic su Aggiorna dipendenze per importare i file del progetto remoto. Se questa è la prima dipendenza remota che hai aggiunto al progetto, l'aggiornamento delle dipendenze chiederà anche a Looker di creare un file di blocco del manifest. Looker utilizza il file di blocco del manifest per monitorare la versione dei progetti remoti.

Se specifichi un ramo Git o un tag di release Git nel parametro secondario ref, Looker verificherà la presenza di nuovi commit ogni volta che l'IDE di Looker viene aggiornato, ovvero quando uno sviluppatore Looker passa alla modalità di sviluppo, esegue un'azione Git nell'IDE o aggiorna il browser.

Se esistono nuovi commit, Looker visualizzerà l'opzione Aggiorna dipendenze nel riquadro delle azioni Git dell'IDE.

Seleziona l'opzione Aggiorna dipendenze per importare i file di progetto remoti più recenti nel tuo progetto.

Una volta ottenuti i file più recenti, puoi convalidare il codice LookML per verificare che tutti i riferimenti del progetto funzionino con i file del progetto remoto aggiornati. A questo punto, puoi correggere eventuali riferimenti interrotti e implementare le modifiche senza tempi di inattività per gli utenti.

File di blocco del manifest

Looker utilizza il file di blocco manifest con il nome file manifest_lock.lkml per monitorare le versioni dei progetti importati da remoto. Il file di blocco del manifest è elencato nel riquadro del browser dei file dell'IDE di Looker.

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

Il file di blocco del manifest mostra ogni progetto remoto, rappresentato da una voce remote_dependency con i sottoparametri url e ref:

  • Il parametro remote_dependency indica il nome del progetto remoto specificato da uno sviluppatore Looker nel file manifest.
  • Il parametro secondario url indica l'indirizzo del repository Git esterno specificato da uno sviluppatore Looker nel file manifest.
  • Il parametro secondario ref mostra la versione del progetto (indicata da un hash SHA del commit) che Looker sta utilizzando nel tuo progetto:
    • Se il progetto remoto è stato definito nel file manifest con un ref di un branch Git o un tag di release Git, il parametro ref mostra la versione dei file (lo SHA del commit del progetto remoto) attualmente in uso nel tuo progetto. Se sono presenti nuovi commit nel progetto remoto, Looker visualizzerà il pulsante Aggiorna dipendenze nell'IDE in modo da poter importare i file del progetto remoto più recenti. Il valore ref nel file di blocco del manifest verrà quindi aggiornato per mostrare l'SHA del commit più recente per quel ramo o tag di rilascio.
    • Se il progetto remoto è stato definito nel file manifest con un ref di uno specifico SHA del commit, il parametro ref nel file di blocco del manifest sarà lo stesso SHA del commit.

Configurazione delle credenziali di autenticazione per i repository remoti privati

Per configurare le credenziali di autenticazione per i repository remoti privati, vai alla pagina Importa credenziali selezionando Impostazioni nel riquadro di navigazione a sinistra all'interno dell'IDE.

Le impostazioni Importa credenziali mostrano un elenco degli URL per ogni repository remoto definito nel file manifest del progetto, il tipo di autenticazione utilizzato per il repository (https o ssh) e se Looker può connettersi correttamente al repository.

Aggiunta delle credenziali di autenticazione

Per aggiungere le credenziali di autenticazione per un repository:

  1. Nella pagina Importa credenziali, sotto l'intestazione URL, tieni il puntatore sopra il nome di un repository per visualizzare i pulsanti Testa e Configura, quindi fai clic su Configura.

  2. Looker mostra la finestra di dialogo Configura autenticazione Git per consentirti di configurare le credenziali per il repository remoto. La finestra di dialogo indicherà il tipo di credenziali richieste per quel particolare repository.

    • Se il repository richiede un nome utente e una password (o un token di accesso personale) per l'autenticazione, inserisci il nome utente e la password o il token e fai clic su Salva modifiche.

    • Se il repository richiede una chiave SSH, ad esempio nell'esempio di utilizzo di SSH per importare un progetto remoto spiegato in precedenza in questa pagina, Looker mostra una finestra di dialogo che mostra la chiave SSH locale. Fai clic su Copia chiave per copiare la chiave SSH negli appunti e aggiungerla all'elenco delle chiavi del repository.

  3. Dopo aver salvato le credenziali, fai clic su Testa per testare l'accesso di Looker al repository.

    Una volta superati i test di connessione e connesso al repository, nella sezione Importa credenziali viene visualizzato un segno di spunta verde accanto al nome del repository.

Modifica delle credenziali di autenticazione

Per modificare le credenziali di autenticazione per un repository:

  1. Per visualizzare i pulsanti Testa e Modifica, tieni il puntatore sopra un repository per il quale sono già configurate le credenziali di autenticazione e fai clic su Modifica.

  2. Se il repository richiede un nome utente e una password (o un token di accesso personale) per l'autenticazione, fai clic su Cancella credenziali e, nella finestra di dialogo di conferma, fai clic su Sì, cancella credenziali.

  3. Inserisci le nuove credenziali nella finestra di dialogo Configura autenticazione Git e fai clic su Salva modifiche.

Visualizzare i file di un progetto importato

L'IDE di Looker mostra i file di progetto importati nella cartella imported_projects del riquadro di navigazione a sinistra. Puoi selezionare un file di progetto importato per visualizzarne i contenuti.

I file dei progetti locali e dei progetti remoti sono elencati nella cartella imported_projects.

Puoi anche visualizzare gli oggetti dei file di progetto importati inclusi nel progetto attivo dal browser degli oggetti. Accedi al browser degli oggetti dalla barra di navigazione dell'IDE di Looker.

Inoltre, gli utenti con l'autorizzazione develop possono utilizzare il riquadro dei metadati per visualizzare informazioni sugli oggetti dei progetti importati, inclusi i link per accedere al file importato in cui è definito l'oggetto. Per ulteriori informazioni, consulta la pagina della documentazione Metadati per gli oggetti LookML.

Inclusione di file da un progetto importato

Il parametro include in un file modello specifica i file di progetto che saranno disponibili per quel modello. Dopo aver specificato un progetto importato locale o remoto nel file manifest, puoi utilizzare il parametro include in un file modello per specificare i file del progetto importato. Possono essere inclusi solo i file il cui progetto è elencato nel file manifest.

Per include un file da un altro progetto, utilizza il nome file con due barre (//) e il nome del progetto importato. Fai seguire al nome del progetto importato una singola barra (/) e il percorso completo del file che vuoi includere.

Ad esempio, questi comandi include indicano il file di visualizzazione users del progetto importato e_flights e la visualizzazione orders del progetto importato e_commerce:

include: "//e_flights/views/users.view.lkml"
include: "//e_commerce/public/orders.view.lkml"

Per informazioni su come specificare i percorsi con le cartelle IDE abilitate, consulta la sezione Sintassi del percorso della pagina del parametro include.

Puoi utilizzare i caratteri jolly per includere più file. Ad esempio, per includere tutti i file di visualizzazione nella directory /views/ del progetto importato e_flights:

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

Inoltre, puoi utilizzare i caratteri jolly per definire l'ambito di livelli di directory specifici o di directory ricorsive nel progetto importato:

include: "//e_flights/*/*.view.lkml"
include: "//e_commerce/*/*.view.lkml"

Per informazioni sull'utilizzo dei caratteri jolly con le cartelle IDE abilitate, consulta la sezione Esempi di caratteri jolly della pagina dei parametri include.

Inclusione dei file del modello

Non puoi includere un file modello di un altro progetto. Se invece vuoi 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 Inclusione di esplorazioni in un modello della pagina della documentazione del parametro include.

Inclusi i file che includono altri file

Quando includi un file che include altri file, tutte le inclusioni vengono risolte prima che il file venga passato al progetto successivo che lo include.

Ad esempio, se nel progetto attuale importi un file (A) da un altro progetto (proj_A) e il file importato contiene un parametro include che include il file B del progetto proj_B, il file B verrà incluso nel file A prima che quest'ultimo venga importato nel progetto attuale.A

Importare i file di dati

I file archiviati nella sezione Dati di un progetto non vengono importati. Per fare riferimento a un file di dati da un progetto importato, ad esempio nel parametro map_layer, utilizza il percorso completo e il nome del file. Ad esempio:

map_layer: json_from_imported_project {
  file: "//path_to_imported_project/folder/filename.topojson"
  ...
}

Fare riferimento ai file di un progetto importato

Dopo aver importato un file di visualizzazione nel progetto, puoi utilizzare la sintassi ${view_name.field_name} per fare riferimento ai campi della visualizzazione importata come se il file di visualizzazione facesse parte del progetto. Ad esempio, supponiamo che tu abbia importato il progetto ga_360_block nel file manifest del progetto e che nel file del modello sia presente la seguente istruzione include:

include: "//ga_360_block/ga_block.view"

Utilizzeresti la sintassi ${ga_block.hits_total} per fare riferimento al campo hits_total della visualizzazione ga_block inclusa.

Utilizzo di costanti nei file di un progetto importato

Le costanti LookML consentono di definire un valore nel file manifest del progetto che può essere riutilizzato in tutto il progetto. Il parametro secondario export del parametro constant specifica se il valore di una costante può essere sostituito quando i file che fanno riferimento a quella costante vengono importati in un altro progetto.

Il parametro export ha i seguenti valori possibili:

  • none: il valore predefinito per export. Il valore della costante non può essere sostituito nel progetto di importazione. Il progetto di importazione utilizza il valore costante specificato nel file manifest del progetto importato.
  • override_optional: il valore della costante può essere sostituito facoltativamente nel progetto di importazione. Se non viene fornito un valore nel file manifest del progetto di importazione, viene utilizzato il valore originale del progetto importato.
  • override_required: il progetto di importazione deve sostituire il valore costante originariamente specificato nel file manifest del progetto importato. Se nel progetto di importazione non viene fornito un nuovo valore costante, Looker mostrerà un errore.

Quando importi nel progetto file che fanno riferimento a una costante, puoi utilizzare il parametro secondario override_constant di local_dependency o remote_dependency nel file manifest del progetto per fornire un nuovo valore per la costante, a condizione che export sia impostato su override_optional o override_required nel progetto originale. Quando sostituisci il valore di una costante di un progetto importato, il progetto utilizzerà il valore specificato con il parametro override_constant.

Ad esempio, supponiamo che tu stia gestendo più database su una singola istanza di Looker, con un progetto separato per ogni database. Supponi inoltre che gli schemi dei dati siano identici per ogni database e che il tuo obiettivo sia definire un'analisi una sola volta e applicarla a ogni set di dati.

In questo esempio, supponiamo che proj_core sia il progetto di base in cui hai definito le visualizzazioni che vuoi importare in altri progetti. Inoltre, una delle visualizzazioni che vuoi importare è la visualizzazione orders, definita come segue:


view: orders {
  sql_table_name: "@{schema_name}.orders"
}

Lo schema su cui si basa la visualizzazione orders è specificato nel parametro sql_table_name utilizzando la costante schema_name, definita nel file manifest proj_core. Nell'esempio seguente, poiché la costante schema_name è impostata su export: override_required, qualsiasi progetto che importa schema_name deve sostituire il suo valore utilizzando il parametro override_constant:


constant: schema_name {
  value: "proj_core_schema"
  export: override_required
}

Ad esempio, supponiamo che tu voglia importare la visualizzazione orders in un progetto locale denominato proj_a. Nel database per proj_a è presente anche una tabella denominata orders con una struttura identica a quella della tabella orders nel progetto di base, proj_core.

Poiché proj_core e proj_a si trovano sulla stessa istanza, puoi importare la vista orders in proj_a utilizzando local_dependency. Utilizzando il parametro secondario override_constant di local_dependency, puoi quindi aggiornare la costante schema_name in modo che punti allo schema proj_a_schema nel file manifest per proj_a:


project_name: "proj_a"

local_dependency: {
  project: "proj_core"
  override_constant: schema_name {
    value: "proj_a_schema"
  }
}

In questo esempio, poiché la costante schema_name è impostata su export: override_required in project_core, Looker mostrerà un errore se non esegui l'override del suo valore in proj_a (il progetto di importazione).

L'override della costante schema_name in proj_a ti consente di utilizzare i campi definiti nella visualizzazione orders in proj_core, anziché creare un nuovo file di visualizzazione e definire i campi da zero. In questo esempio, la visualizzazione orders corrisponde a una tabella diversa per ogni progetto:

  • In proj_core, la vista orders si basa sulla tabella proj_core_schema.orders del tuo database.
  • In proj_a, la vista orders si basa sulla tabella proj_a_schema.orders del tuo database.