include

Utilisation

Inclure: "/views/airports.view"
Hiérarchie
include

- ou -

include

- ou -

include
Valeur par défaut
Aucun

Acceptation
Chaîne contenant un nom de fichier ou un modèle

Définition

Le paramètre include spécifie les fichiers LookML qui seront disponibles pour un modèle, une vue ou une exploration. Si vous souhaitez utiliser ou référencer un fichier LookML dans un autre fichier, vous devez l'ajouter avec le paramètre include.

Vous pouvez utiliser le paramètre include dans les fichiers de modèle, afficher les fichiers et Explorer les fichiers. Le paramètre include peut faire référence à différents types de fichiers LookML en fonction du contexte.

Dans un fichier de modèle, vous pouvez utiliser include pour référencer:

Dans un fichier d'affichage, vous pouvez utiliser include pour référencer:

Dans un fichier Explorer, vous pouvez utiliser include pour référencer:

Vous pouvez également utiliser include pour importer des fichiers provenant d'autres projets. Consultez la page de documentation Importer des fichiers à partir d'autres projets pour savoir comment inclure des fichiers d'un autre projet. Pour importer des fichiers à partir de projets LookML locaux, vous devez activer la fonctionnalité expérimentale Importation de projet en local.

Tenez compte des points suivants lorsque vous utilisez include:

  • Vous n'avez pas besoin d'utiliser include pour les types de fichiers autres que LookML, tels que les fichiers de documentation ou les fichiers de données.
  • L'inclusion de fichiers n'est pas complète. Toutes les informations du fichier compris sont donc ajoutées au fichier compris.
  • Vous pouvez utiliser plusieurs paramètres include dans un fichier.
  • Vous pouvez utiliser le caractère générique * pour indiquer des fichiers ayant des conventions d'attribution de noms stratégiques ou la même extension. Par exemple, vous pouvez utiliser "*base.dashboard" pour établir une correspondance et inclure à la fois "database.dashboard" et "crunchbase.dashboard". Vous pouvez utiliser "*.dashboard" pour indiquer tous les fichiers portant l'extension .dashboard.
  • Vous pouvez utiliser le caractère générique * pour inclure tous les fichiers d'un répertoire. Par exemple, vous pouvez inclure tous les fichiers de vue du répertoire views/users/ en spécifiant include: "/views/users/*.view". Consultez la page de documentation sur les dossiers IDE pour en savoir plus sur l'utilisation des caractères génériques avec les dossiers IDE.

Conseil pratique : Lorsque vous utilisez des caractères génériques, vous pouvez vérifier les fichiers inclus en plaçant le pointeur de la souris sur l'icône d'information à côté du numéro de ligne dans le fichier, ou en cliquant sur l'instruction include et en consultant l'aide rapide:

Conseil pratique : Vous pouvez copier le chemin d'accès à un fichier en sélectionnant Copier le chemin d'accès au fichier dans le menu à trois points du fichier dans l'IDE Looker:

Utiliser include dans un fichier de modèle

Vous pouvez utiliser le paramètre include dans un fichier de modèle pour inclure des vues et tableaux de bord ou des explorations.

Inclure des vues et des tableaux de bord dans un modèle

Utilisez le paramètre include dans un fichier de modèle pour spécifier le tableau de bord et afficher les fichiers qui seront disponibles pour ce modèle. Si vous souhaitez utiliser ou référencer un fichier LookML dans un modèle, vous devez l'ajouter avec le paramètre include.

Dans le paramètre include, utilisez l'extension .view pour les fichiers de vue et l'extension .dashboard pour les tableaux de bord. Vous pouvez ignorer les parties .lkml et .lookml de ces extensions.

Vous pouvez utiliser le caractère générique * pour indiquer des fichiers ayant des conventions d'attribution de noms stratégiques ou la même extension. Vous pouvez également utiliser le caractère générique * avec des chemins d'accès au répertoire pour spécifier plusieurs fichiers, comme décrit dans la section Exemples de caractères génériques de la page de documentation des dossiers IDE.

Par exemple, vous pouvez utiliser les paramètres include suivants dans un fichier de modèle:

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

Ces paramètres incluent les fichiers suivants:

  • Tous les fichiers du tableau de bord de n'importe quel répertoire de votre projet
  • Tous les fichiers de vue se terminant par base.view.lkml dans n'importe quel répertoire enfant immédiat du projet, tel que /views/database.view.lkml ou /public/crunchbase.view.lkml
  • Tous les fichiers de vue du répertoire /views/ du projet importé nommé e_commerce

Si votre projet contient un grand nombre de fichiers de vue ou s'il utilise des tables dérivées persistantes, nous vous recommandons de ne pas inclure tous les fichiers de vues de votre modèle. À la place, incluez des fichiers individuels pour ce type de vue. Voici un exemple d'inclusion de fichiers de vue individuels et de tous les tableaux de bord d'un projet:

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

Inclure des modèles dans un modèle

Vous ne pouvez pas inclure un fichier de modèle d'un autre projet. Pour réutiliser, affiner ou étendre les explorations d'un projet à l'autre, vous pouvez créer un fichier Explorer distinct dans le projet importé, puis l'inclure dans d'autres projets. Pour en savoir plus, consultez Inclure des explorations dans un modèle.

Inclure des explorations dans un modèle

Les fichiers Explorer écoutent la connexion du modèle dans lequel ils sont inclus. Pensez-y lorsque vous incluez des fichiers Explorer dans des modèles configurés avec une connexion différente de celle du modèle parent du fichier Explorer. Si le schéma de la connexion du modèle inclus diffère de celui de la connexion du modèle parent, des erreurs de requête peuvent se produire.

Les explorations sont généralement définies dans un fichier de modèle. Toutefois, vous avez parfois besoin d'un fichier Explorer distinct pour une table dérivée, ou pour étendre ou affiner une exploration à plusieurs modèles.

Si vous disposez d'un fichier Explorer distinct, vous devez utiliser le paramètre include dans le fichier de modèle pour l'inclure. Dans le paramètre include, utilisez l'extension .explore.lkml pour les fichiers Explorer.

Voici un exemple de fichier de modèle comportant deux explorations:

  • La fonction Explorer aircraft_new, qui est définie dans son propre fichier appelé aircraft_new.explore.lkml dans le dossier explores. Étant donné que l'exploration est définie dans son propre fichier, vous devez spécifier le chemin d'accès dans un paramètre include.
  • La fonction Explorer accidents, qui est définie dans le fichier de modèle. Étant donné qu'il est défini dans le fichier de modèle lui-même, vous n'avez pas besoin d'utiliser un paramètre include dans le modèle. Toutefois, vous avez besoin d'un include pour la vue sur laquelle l'exploration accidents est basée.
connection: "faa"

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

explore: accidents {
  view_name: accidents
  from: accidents
}

Inclure des tests de données dans un modèle

Les tests de données peuvent être définis directement dans un fichier de modèle ou un fichier de vue. Toutefois, vous pouvez également créer un fichier de test de données distinct si vous souhaitez réutiliser vos tests de données à plusieurs endroits dans votre projet.

Si vous disposez d'un fichier de test de données distinct, vous devez utiliser le paramètre include dans votre fichier de modèle ou votre fichier de vue afin de pouvoir exécuter les tests de données. Dans le paramètre include, utilisez l'extension .lkml pour les fichiers de test de données.

Voici un extrait d'un fichier de modèle qui inclut un fichier de test de données:

connection: "faa"

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

. . .

Une fois que vous avez inclus le fichier de test de données dans un fichier de modèle, vous pouvez exécuter le test de données pour vérifier que votre test de données fonctionne correctement et pour vérifier que la logique de votre modèle réussit le test.

Vous pouvez également inclure le fichier de test de données dans un fichier de vue, comme décrit dans la section Inclure des tests de données dans une vue de cette page.

Utiliser include dans un fichier de vue

Dans la plupart des cas, vous n'avez pas besoin d'utiliser include dans un fichier de vue. Toutefois, dans certains cas, vous souhaiterez inclure des fichiers dans votre fichier d'affichage:

Inclure des vues dans une vue (à étendre ou à affiner)

Vous pouvez également inclure un fichier de vue dans un autre fichier de vue pour étendre ou affiner la vue incluse.

Par exemple, voici le fichier de vue marketing_order_fields qui inclut le fichier de vue basic_order_fields, puis l'étend:

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

Inclure la fonctionnalité Explorer dans une vue

Les fichiers Explorer écoutent la connexion du modèle dans lequel ils sont inclus. Pensez-y lorsque vous incluez des fichiers Explorer dans des modèles configurés avec une connexion différente de celle du modèle parent du fichier Explorer. Si le schéma de la connexion du modèle inclus diffère de celui de la connexion du modèle parent, des erreurs de requête peuvent se produire.

Dans la plupart des cas, il n'est pas nécessaire d'inclure une exploration dans une vue. Toutefois, les tables dérivées natives constituent un cas particulier, car elles sont définies dans leur propre fichier de vue comportant un paramètre explore_source. Utilisez le paramètre explore_source pour spécifier une exploration, ainsi que les colonnes et les autres caractéristiques souhaitées pour la table dérivée native. Les explorations sont généralement définies dans un fichier de modèle, mais dans le cas de tables dérivées natives, il peut être plus facile de créer un fichier distinct pour l'exploration à l'aide de l'extension de fichier .explore.lkml. Si vous créez un fichier Explorer distinct, vous devez l'inclure dans le fichier natif de vue Tableau.

Voici un exemple d'utilisation de include dans un fichier de vue de table dérivée native pour pointer vers un fichier Explorer:

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

Pour en savoir plus sur l'exploration des fichiers des tables dérivées natives, consultez notre documentation sur l'utilisation des instructions include pour activer les champs de référence.

Inclure des tests de données dans une vue

Les tests de données peuvent être définis directement dans un fichier de modèle ou un fichier de vue. Toutefois, vous pouvez également créer un fichier de test de données distinct si vous souhaitez réutiliser vos tests de données à plusieurs endroits dans votre projet.

Si vous disposez d'un fichier de test de données distinct, vous devez utiliser le paramètre include dans votre fichier de modèle ou votre fichier de vue afin de pouvoir exécuter les tests de données. Dans le paramètre include, utilisez l'extension .lkml pour les fichiers de test de données.

Voici un extrait d'un fichier de vue qui inclut un fichier de test de données:

include: "/tests/data_tests.lkml"

view: orders {
  sql_table_name: looker.orders ;;

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

. . .

Une fois que vous avez inclus le fichier de test de données dans un fichier de vue, vous pouvez le tester pour vérifier qu'il fonctionne correctement et pour vérifier que la logique de votre vue réussit le test.

Vous pouvez également inclure le fichier de test de données dans un fichier de modèle, comme décrit dans la section Inclure des tests de données dans un modèle de cette page.

Utiliser include dans un fichier Explorer

Les explorations sont généralement définies dans un fichier de modèle. Toutefois, vous avez parfois besoin d'un fichier Explorer distinct pour une table dérivée, ou pour étendre ou affiner une exploration à plusieurs modèles.

Si vous disposez d'un fichier Explorer distinct, vous pouvez utiliser le paramètre include pour inclure des vues ou d'autres explorations.

Inclure des vues dans une exploration

Si vous disposez d'un fichier Explorer distinct, vous devez inclure toutes les vues utilisées par l'exploration. Utilisez l'extension de fichier .view pour afficher les fichiers. Vous pouvez omettre la partie .lkml de l'extension du fichier. Voici un exemple de fichier Explorer qui inclut les deux vues qu'il utilise:

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

Explorations incluses

Les fichiers Explorer écoutent la connexion du modèle dans lequel ils sont inclus. Pensez-y lorsque vous incluez des fichiers Explorer dans des modèles configurés avec une connexion différente de celle du modèle parent du fichier Explorer. Si le schéma de la connexion du modèle inclus diffère de celui de la connexion du modèle parent, des erreurs de requête peuvent se produire.

Vous pouvez inclure un fichier Explorer dans un autre fichier, par exemple lorsque vous prolongez ou affinez une exploration. Utilisez le paramètre include et ajoutez l'extension de fichier .explore.lkml.

Voici un exemple de fichier Explorer qui inclut un autre fichier Explorer, puis étend l'exploration:

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

explore: aircraft_information {
  extends: [aircraft]

Examples

Consultez les sections précédentes pour savoir comment utiliser include dans les fichiers de modèle, afficher les fichiers et explorer les fichiers.

Éléments à prendre en compte

Utiliser des caractères génériques

Pour les projets où seuls quelques fichiers doivent être gérés, vous pouvez répertorier chaque fichier dans son propre paramètre include, comme suit:

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

Pour les projets comportant de nombreux fichiers à inclure, vous pouvez réduire le nombre de paramètres include que vous devez écrire en utilisant des caractères génériques pour inclure plusieurs fichiers à la fois:

L'utilisation de caractères génériques peut être particulièrement utile lors du développement lorsque vous devez créer un correctif temporaire pour les avertissements de validation LookML, en particulier lors de l'organisation d'un projet existant dans des dossiers IDE. Toutefois, tenez compte des points suivants lorsque vous utilisez des caractères génériques dans vos instructions include:

Utiliser des caractères génériques avec les dossiers IDE

Vous pouvez utiliser des caractères génériques en combinaison avec des dossiers IDE pour inclure des fichiers dans un répertoire spécifique de votre projet LookML.

Par exemple, cette instruction include référence tous les fichiers du répertoire /explores/ d'un projet LookML:

include: "/explores/*"

Utiliser des caractères génériques pour des types de fichiers spécifiques

Vous pouvez utiliser des caractères génériques pour référencer tous les fichiers d'un certain type. Par exemple, cette instruction include référence tous les fichiers Explorer d'un projet LookML:

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

Consultez la section Types de fichiers du projet sur la page de documentation Fichiers de projet LookML pour obtenir la liste des types de fichiers LookML et de leurs extensions.

Looker ne recommande pas l'utilisation de caractères génériques pour inclure tous les fichiers de vue d'un projet, car l'inclusion de tous les fichiers de vue peut affecter les performances de la validation LookML et encombrer le schéma de votre base de données.

Utiliser des caractères génériques avec des modèles de dénomination stratégique

Vous pouvez également utiliser des caractères génériques avec un nom stratégique pour optimiser vos instructions include. Par exemple, au lieu de nommer vos fichiers comme suit:

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

Vous pouvez ajouter un préfixe stratégique ou un suffixe à vos noms de fichiers, comme ceci:

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

Utilisez ensuite des caractères génériques pour référencer uniquement le suffixe .fruit à l'aide de include :

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

Inclure tous les fichiers de vue peut affecter les performances de la validation LookML

Si votre projet contient un grand nombre de fichiers de vue et que vous les incluez tous dans votre fichier de modèle, cela peut affecter les performances de l'outil LookML Validator. Étant donné que le validateur LookML vérifie tous les fichiers de vue inclus dans le modèle, vous ne devez inclure que les fichiers de vue requis dans le paramètre include du fichier de modèle.

Envisagez d'utiliser des conventions d'attribution de noms stratégiques pour les fichiers de vue afin de faciliter l'inclusion de groupes de vues dans un modèle (voir l'exemple de la section Utiliser des caractères génériques avec des modèles de dénomination stratégique sur cette page). Vous pouvez également utiliser des dossiers IDE pour organiser vos vues dans des dossiers. Vous pouvez ensuite utiliser le caractère générique * pour inclure toutes les vues dans un seul dossier au lieu d'inclure toutes les vues de votre projet. Pour en savoir plus, consultez notre documentation sur l'utilisation de include avec des dossiers IDE.

Inclure tous les fichiers de vue peut encombrer votre schéma de base de données

Pour les projets qui utilisent des tables dérivées persistantes, vous pouvez inclure le fichier d'affichage correspondant dans votre fichier de modèle. Toutefois, chaque fichier de modèle qui inclut le fichier de vue du disque persistant crée une copie de ce disque dans le schéma de travail de votre base de données. Si vous avez plusieurs fichiers de modèle et que vous incluez tous les fichiers de vue dans vos fichiers de modèle, vous pouvez ajouter un schéma inutile à votre schéma de travail de base de données. Pour cette raison, assurez-vous d'inclure le fichier de vue d'un PDT uniquement dans les fichiers de modèle où le PDT est nécessaire.