include

Nutzung

Einschließen: "/views/airports.view"
Hierarchie
include

– oder –

include

– oder –

include
Standardwert
Keine

Akzeptiert
Ein String mit einem Dateinamen oder Muster

Definition

Der Parameter include gibt die LookML-Dateien an, die für ein Modell, eine Ansicht oder eine explorative Datenanalyse verfügbar sind. Wenn Sie eine LookML-Datei in einer anderen Datei verwenden oder darauf verweisen möchten, müssen Sie sie mit dem Parameter include hinzufügen.

Sie können den Parameter include in Modelldateien sowie in Dateien zum Ansehen und Erkunden verwenden. Der Parameter include kann je nach Kontext auf verschiedene Arten von LookML-Dateien verweisen.

In einer Modelldatei können Sie include verwenden, um auf Folgendes zu verweisen:

In einer Ansichtsdatei können Sie mit include auf Folgendes verweisen:

In einer Erkundungsdatei können Sie mit include auf Folgendes verweisen:

Mit include können Sie auch Dateien aus anderen Projekten einbinden. Informationen zum Einfügen von Dateien aus einem anderen Projekt finden Sie auf der Dokumentationsseite Dateien aus anderen Projekten importieren. Für den Import von Dateien aus lokalen LookML-Projekten müssen Sie die Labs-Funktion Lokaler Projektimport aktivieren.

Beachten Sie Folgendes, wenn Sie include verwenden:

  • Für Nicht-LookML-Dateitypen wie Dokumentationsdateien oder Datendateien ist include nicht erforderlich.
  • Das Einbinden von Dateien ist entweder „ganz oder nichts“. Es werden also alle Informationen in der eingeschlossenen Datei zur inklusiven Datei hinzugefügt.
  • Sie können in einer Datei mehrere include-Parameter verwenden.
  • Sie können das Platzhalterzeichen * verwenden, um Dateien mit strategischen Namenskonventionen oder mit derselben Erweiterung anzugeben. Sie können beispielsweise "*base.dashboard" verwenden, um "database.dashboard" und "crunchbase.dashboard" abzugleichen und einzuschließen. Mit "*.dashboard" können Sie alle Dateien mit der Erweiterung .dashboard angeben.
  • Mit dem Platzhalterzeichen * können Sie alle Dateien in ein Verzeichnis aufnehmen. Sie können beispielsweise alle Ansichtsdateien in das Verzeichnis views/users/ aufnehmen, indem Sie include: "/views/users/*.view" angeben. Weitere Informationen zur Verwendung von Platzhaltern mit IDE-Ordnern finden Sie auf der Dokumentationsseite für IDE-Ordner.

Tipp: Wenn Sie Platzhalter verwenden, können Sie prüfen, welche Dateien enthalten sind. Bewegen Sie dazu den Mauszeiger über das Informationssymbol neben der Zeilennummer in der Datei oder klicken Sie auf die Anweisung include in der Hilfe:

Tipp: Sie können den Pfad für eine Datei kopieren. Wählen Sie dazu in der Looker-IDE im Dreipunkt-Menü der Datei die Option Dateipfad kopieren aus:

include in einer Modelldatei verwenden

Sie können den Parameter include in einer Modelldatei verwenden, um Ansichten und Dashboards oder Erkundungen einzubinden.

Ansichten und Dashboards in einem Modell einschließen

Verwenden Sie den Parameter include in einer Modelldatei, um das Dashboard anzugeben und Dateien aufzurufen, die für dieses Modell verfügbar sind. Wenn Sie eine LookML-Datei in einem Modell verwenden oder darauf verweisen möchten, müssen Sie sie mit dem Parameter include hinzufügen.

Verwenden Sie im Parameter include die Erweiterung .view für Anzeigedateien und die Erweiterung .dashboard für Dashboards. Sie können den .lkml- und den .lookml-Teil dieser Erweiterungen weglassen.

Sie können das Platzhalterzeichen * verwenden, um Dateien mit strategischen Namenskonventionen oder mit derselben Erweiterung anzugeben. Sie können auch den Platzhalter * zusammen mit Verzeichnispfaden verwenden, um mehrere Dateien anzugeben. Dies wird im Abschnitt Platzhalterbeispiele auf der Dokumentationsseite für IDE-Ordner beschrieben.

Sie könnten beispielsweise die folgenden include-Parameter in einer Modelldatei verwenden:

include: "/**/*.dashboard"
include: "/*/*base.view.lkml"
include: "//e_commerce/views/*.view.lkml"

Diese Parameter würden die folgenden Dateien enthalten:

  • Alle Dashboard-Dateien in einem beliebigen Verzeichnis in Ihrem Projekt
  • Alle Ansichtsdateien, die auf base.view.lkml enden, in einem beliebigen untergeordneten Verzeichnis des Projekts, z. B. /views/database.view.lkml oder /public/crunchbase.view.lkml
  • Alle Ansichtsdateien im Verzeichnis /views/ des importierten Projekts mit dem Namen e_commerce

Wenn Ihr Projekt eine große Anzahl von Ansichtsdateien enthält oder wenn Ihr Projekt persistente abgeleitete Tabellen (PDTs) verwendet, sollten Sie nicht alle Ansichtsdateien in Ihr Modell aufnehmen. Fügen Sie stattdessen einzelne Dateien dieser Art hinzu. Hier ein Beispiel dafür, wie Sie einzelne Ansichtsdateien und alle Dashboards in ein Projekt aufnehmen:

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

Modelle in ein Modell aufnehmen

Sie können keine Modelldatei aus einem anderen Projekt hinzufügen. Wenn Sie sie stattdessen projektübergreifend wiederverwenden, optimieren oder erweitern möchten, können Sie im importierten Projekt eine separate Erkundungsdatei erstellen und diese Datei dann in andere Projekte einbinden. Weitere Informationen finden Sie unter Explorative Datenanalysen in einem Modell einschließen.

Erkundungen in einem Modell einschließen

Dateien zum Entdecken werden der Verbindung des Modells zugeordnet, in dem sie enthalten sind. Beachten Sie dies, wenn Sie Dateien zum Entdecken in Modelle einbinden, die mit einer Verbindung konfiguriert sind, die sich vom übergeordneten Modell der Datei „Erkunden“ unterscheidet. Wenn sich das Schema für die Verbindung des einschließenden Modells vom Schema der Verbindung des übergeordneten Modells unterscheidet, kann es zu Abfragefehlern kommen.

Explorative Datenanalysen werden normalerweise in einer Modelldatei definiert. Manchmal benötigen Sie jedoch eine separate „Erkunden“-Datei für eine abgeleitete Tabelle oder zum Erweitern oder Optimieren einer explorativen Datenanalyse für alle Modelle.

Wenn Sie eine separate Erkundungsdatei haben, müssen Sie den Parameter include in der Modelldatei verwenden, um sie einzuschließen. Verwenden Sie im Parameter include die Erweiterung .explore.lkml für Dateien des Typs „Erkunden“.

Im Folgenden finden Sie beispielsweise eine Modelldatei mit zwei Erkundungen:

  • Die Funktion „Erkunden“ aircraft_new, die in einer eigenen Datei namens aircraft_new.explore.lkml im Ordner explores definiert ist. Da die Funktion „Erkunden“ in einer eigenen Datei definiert ist, müssen Sie den Pfad der Datei „Entdecken“ in einem include-Parameter angeben.
  • Die accidents-Erkundung, die in der Modelldatei definiert ist. Da er in der Modelldatei selbst definiert ist, müssen Sie im Modell keinen include-Parameter dafür verwenden. Du benötigst jedoch eine include für die Ansicht, auf der die accidents-explorative Datenanalyse basiert.
connection: "faa"

include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"

explore: accidents {
  view_name: accidents
  from: accidents
}

Datentests in ein Modell aufnehmen

Datentests können direkt in einer Modell- oder Ansichtsdatei definiert werden. Sie können jedoch auch eine separate Datentestdatei erstellen, wenn Sie Ihre Datentests an mehreren Stellen in Ihrem Projekt wiederverwenden möchten.

Wenn Sie eine separate Datentestdatei haben, müssen Sie den Parameter include in Ihrer Modell- oder Datei verwenden, damit Sie die Datentests ausführen können. Verwenden Sie im Parameter include die Erweiterung .lkml für Datentestdateien.

Im Folgenden finden Sie beispielsweise einen Auszug aus einer Modelldatei, die eine Datentestdatei enthält:

connection: "faa"

include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"
include: "/tests/data_tests.lkml"

. . .

Nachdem Sie die Datentestdatei in eine Modelldatei aufgenommen haben, können Sie den Datentest ausführen, um zu prüfen, ob der Datentest ordnungsgemäß funktioniert und ob der Test durch die Logik des Modells bestanden wurde.

Sie können die Datentestdatei auch in eine Ansichtsdatei aufnehmen, wie auf dieser Seite im Abschnitt Datentests in einer Datenansicht einschließen beschrieben.

include in einer Ansichtsdatei verwenden

In den meisten Fällen benötigen Sie include nicht für eine Ansichtsdatei. Es gibt jedoch einige Fälle, in denen die Ansichtsdatei Dateien enthalten soll:

Ansichten in einer Ansicht einschließen (zum Erweitern oder Verfeinern)

Sie können eine Ansichtsdatei auch in eine andere Ansichtsdatei aufnehmen, um die enthaltene Ansicht zu erweitern oder zu optimieren.

Hier ist beispielsweise die Ansichtsdatei marketing_order_fields, die die Ansichtsdatei basic_order_fields enthält und dann erweitert:

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

Explorative Datenanalysen in einer Ansicht einschließen

Dateien zum Entdecken werden der Verbindung des Modells zugeordnet, in dem sie enthalten sind. Beachten Sie dies, wenn Sie Dateien zum Entdecken in Modelle einbinden, die mit einer Verbindung konfiguriert sind, die sich vom übergeordneten Modell der Datei „Erkunden“ unterscheidet. Wenn sich das Schema für die Verbindung des einschließenden Modells vom Schema der Verbindung des übergeordneten Modells unterscheidet, kann es zu Abfragefehlern kommen.

In den meisten Fällen ist es nicht erforderlich, eine Ansicht in die Ansicht aufzunehmen. Native abgeleitete Tabellen sind jedoch ein Sonderfall, da sie in einer eigenen Ansichtsdatei mit einem explore_source-Parameter definiert sind. Mit dem Parameter explore_source geben Sie „Erkunden“ an und definieren die gewünschten Spalten sowie andere gewünschte Eigenschaften für die native abgeleitete Tabelle. Explorative Datenanalysen werden normalerweise in einer Modelldatei definiert, aber bei nativen abgeleiteten Tabellen ist es übersichtlicher, eine separate Datei für die Dateierweiterung.explore.lkml zu erstellen. Wenn Sie eine separate „Erkunden“-Datei erstellen, müssen Sie die Datei „Erkunden“ in die native Tabellenansichtsdatei einfügen.

Hier ein Beispiel für die Verwendung von include in einer nativen abgeleiteten Tabellenansichtsdatei, die auf eine Erkundungsdatei verweist:

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}
}

Weitere Informationen zu Dateien des Typs „Erkunden“ für native abgeleitete Tabellen finden Sie in der Dokumentation zur Verwendung von include-Anweisungen zum Aktivieren von Verweisfeldern.

Datentests in eine Datenansicht aufnehmen

Datentests können direkt in einer Modell- oder Ansichtsdatei definiert werden. Sie können jedoch auch eine separate Datentestdatei erstellen, wenn Sie Ihre Datentests an mehreren Stellen in Ihrem Projekt wiederverwenden möchten.

Wenn Sie eine separate Datentestdatei haben, müssen Sie den Parameter include in Ihrer Modell- oder Datei verwenden, damit Sie die Datentests ausführen können. Verwenden Sie im Parameter include die Erweiterung .lkml für Datentestdateien.

Im Folgenden finden Sie beispielsweise einen Auszug aus einer Ansichtsdatei, die eine Datentestdatei enthält:

include: "/tests/data_tests.lkml"

view: orders {
  sql_table_name: looker.orders ;;

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

. . .

Nachdem Sie die Datentestdatei in eine Ansichtsdatei aufgenommen haben, können Sie den Datentest ausführen, um zu prüfen, ob der Datentest ordnungsgemäß funktioniert und ob der Test der Logik der Ansicht bestanden wurde.

Sie können die Datentestdatei auch in eine Modelldatei aufnehmen. Dies wird im Abschnitt Datentests in ein Modell einbeziehen auf dieser Seite beschrieben.

include in einer Erkundungsdatei verwenden

Explorative Datenanalysen werden normalerweise in einer Modelldatei definiert. Manchmal benötigen Sie jedoch eine separate „Erkunden“-Datei für eine abgeleitete Tabelle oder zum Erweitern oder Optimieren einer explorativen Datenanalyse für alle Modelle.

Wenn Sie eine separate Erkundungsdatei haben, können Sie mit dem Parameter include Aufrufe oder andere Erkundungen einbeziehen.

Aufrufe in einem Tab „Entdecken“ einschließen

Wenn Sie eine separate „Erkunden“-Datei haben, müssen Sie alle Ansichten einschließen, die von der Funktion „Erkunden“ verwendet werden. Verwenden Sie zum Ansehen von Dateien die Dateiendung .view. Sie können den .lkml-Teil der Dateiendung weglassen. Hier sehen Sie eine Beispieldatei mit den beiden Ansichten:

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
  }
}

„Erkunden“ in „Erkunden“ einschließen

Dateien zum Entdecken werden der Verbindung des Modells zugeordnet, in dem sie enthalten sind. Beachten Sie dies, wenn Sie Dateien zum Entdecken in Modelle einbinden, die mit einer Verbindung konfiguriert sind, die sich vom übergeordneten Modell der Datei „Erkunden“ unterscheidet. Wenn sich das Schema für die Verbindung des einschließenden Modells vom Schema der Verbindung des übergeordneten Modells unterscheidet, kann es zu Abfragefehlern kommen.

Sie können eine „Erkunden“-Datei in eine andere „Erkunden“-Datei einfügen, z. B. wenn Sie eine „Erkunden“ erweitern oder optimieren. Verwenden Sie den Parameter include und fügen Sie die Dateierweiterung .explore.lkml hinzu.

Hier ist ein Beispiel für eine „Entdecken“-Datei, die eine weitere „Erkunden“-Datei enthält und dann die Funktion „Erkunden“ erweitert:

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

explore: aircraft_information {
  extends: [aircraft]

Beispiele

In den vorherigen Abschnitten finden Sie Beispiele für die Verwendung von include in Modelldateien, Dateien ansehen und Dateien untersuchen.

Wichtige Punkte

Platzhalter verwenden

Bei Projekten, bei denen nur wenige Dateien verwaltet werden müssen, können Sie jede Datei in einem eigenen include-Parameter auflisten:

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

Bei Projekten mit vielen Dateien können Sie die Anzahl der erforderlichen include-Parameter reduzieren. Dazu müssen Sie Platzhalter verwenden, um mehrere Dateien gleichzeitig aufzunehmen:

Die Verwendung von Platzhaltern kann bei der Entwicklung besonders nützlich sein, wenn Sie eine vorübergehende Korrektur für LookML-Validierungswarnungen erstellen müssen, insbesondere bei der Organisation eines vorhandenen Projekts in IDE-Ordnern. Beachten Sie jedoch Folgendes, wenn Sie Platzhalter in Ihren include-Anweisungen verwenden:

Platzhalter mit IDE-Ordnern verwenden

Sie können Platzhalter in Kombination mit IDE-Ordnern verwenden, um Dateien in ein bestimmtes Verzeichnis in Ihrem LookML-Projekt aufzunehmen.

Die folgende include-Anweisung verweist beispielsweise auf alle Dateien im Verzeichnis /explores/ eines LookML-Projekts:

include: "/explores/*"

Platzhalter für bestimmte Dateitypen verwenden

Sie können Platzhalter verwenden, um auf alle Dateien eines bestimmten Typs zu verweisen. Die folgende include-Anweisung verweist beispielsweise auf alle Dateien zum Erkunden in einem LookML-Projekt:

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

Im Abschnitt Projektdateitypen der Dokumentationsseite für LookML-Projektdateien finden Sie eine Liste der Typen von LookML-Dateien und der entsprechenden Dateiendungen.

Looker empfiehlt nicht die Verwendung von Platzhaltern zum Einbeziehen aller Ansichtsdateien in ein Projekt, da das Einbeziehen aller Ansichtsdateien die Leistung der LookML-Validierung beeinträchtigen und das Datenbankschema bereinigen kann.

Platzhalter mit strategischen Namensmustern verwenden

Sie können auch Platzhalter mit strategischen Dateinamen verwenden, um Ihre include-Anweisungen weiter zu optimieren. Statt beispielsweise Dateien wie die folgenden zu benennen:

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

Sie können Ihren Dateinamen ein strategisches Präfix oder ein Suffix hinzufügen:

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

Verwenden Sie dann Platzhalter, um nur auf das Suffix .fruit zu verweisen. Verwenden Sie dazu diesen include:

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

Das Einbeziehen aller Ansichtsdateien kann die Leistung der LookML-Validierung beeinträchtigen

Wenn Ihr Projekt eine große Anzahl von Ansichtsdateien enthält und Sie alle in die Modelldatei aufnehmen, kann sich das auf die Leistung des LookML Validators auswirken. Da der LookML-Validator alle im Modell enthaltenen Ansichtsdateien prüft, sollten Sie nur die erforderlichen Ansichtsdateien in den Parameter include der Modelldatei aufnehmen.

Erwägen Sie die Verwendung von strategischen Namenskonventionen für Ansichtsdateien, um das einfache Einbinden von Ansichten in ein Modell zu ermöglichen (siehe Beispiel unter Platzhalter mit strategischen Namensmustern verwenden auf dieser Seite). Alternativ können Sie Ihre Ansichten mithilfe von IDE-Ordnern in Ordnern organisieren. Dann können Sie den Platzhalter * verwenden, um alle Ansichten in einen einzelnen Ordner aufzunehmen, anstatt alle Ansichten in Ihrem Projekt aufzunehmen. Weitere Informationen finden Sie in der Dokumentation zur Verwendung von include mit IDE-Ordnern.

Wenn Sie alle Ansichtsdateien einbeziehen, kann Ihr Datenbankschema überladen sein

Bei Projekten, die persistente abgeleitete Tabellen (PDTs) verwenden, können Sie die Ansichtsdatei des PDT in Ihre Modelldatei aufnehmen. Jede Modelldatei, die die Ansichtsdatei des PDT enthält, erstellt jedoch eine Kopie des PDT im Scratch-Schema Ihrer Datenbank. Wenn Sie mehrere Modelldateien haben und alle Ansichtsdateien in Ihre Modelldateien aufnehmen, können Sie Ihr Datenbank-Scratch-Schema unnötig überladen. Achten Sie daher darauf, die Ansichtsdatei eines PDT nur in die Modelldateien aufzunehmen, in denen das PDT benötigt wird.