inclure

Utilisation


include: "/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, les fichiers de vue et les fichiers Explorer. Le paramètre include peut faire référence à différents types de fichiers LookML, selon le contexte.

Dans un fichier de modèle, vous pouvez utiliser include pour faire référence aux types de fichiers suivants :

Dans un fichier de vue, vous pouvez utiliser include pour faire référence aux types de fichiers suivants :

Dans un fichier Explorer, vous pouvez utiliser include pour référencer les types de fichiers suivants :

Vous pouvez également utiliser include pour importer des fichiers d'autres projets. Pour savoir comment inclure des fichiers provenant d'un autre projet, consultez la page de documentation Importer des fichiers d'autres projets.

Lorsque vous utilisez include, tenez compte des points suivants :

  • Vous n'avez pas besoin d'utiliser include pour les types de fichiers non LookML, tels que les fichiers de documentation ou les fichiers de données.
  • L'inclusion de fichiers est tout ou rien. Toutes les informations du fichier inclus sont ajoutées au fichier incluant.
  • Vous pouvez utiliser plusieurs paramètres include dans un fichier.
  • Vous pouvez utiliser le caractère générique * pour indiquer les fichiers avec des conventions de dénomination stratégiques ou avec la même extension. Par exemple, vous pouvez utiliser "*base.dashboard" pour faire correspondre et inclure "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". Pour en savoir plus sur l'utilisation des caractères génériques avec les dossiers IDE, consultez la page de documentation sur les dossiers IDE.

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 des 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 les fichiers de tableau de bord et de vue 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 omettre la partie .lkml et .lookml de ces extensions.

Vous pouvez utiliser le caractère générique * pour indiquer les fichiers avec des conventions de dénomination stratégiques ou avec la même extension. Vous pouvez également utiliser le caractère générique * en combinaison avec des chemins d'accès à des répertoires pour spécifier plusieurs fichiers, comme décrit dans la section Exemples de caractères génériques de la page du paramètre include.

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 de 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 projet importé dans le répertoire /views/ nommé e_commerce

Si votre projet comporte un grand nombre de fichiers de vue ou s'il utilise des tables dérivées persistantes (PDT), vous devez éviter d'inclure tous les fichiers de vue dans votre modèle. Incluez plutôt des fichiers de vue individuels comme ceci. 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 provenant d'un autre projet. Au lieu de cela, pour réutiliser, affiner ou étendre des explorations dans plusieurs projets, vous pouvez créer un fichier d'exploration distinct dans le projet importé, puis inclure ce fichier d'exploration dans d'autres projets. Pour en savoir plus, consultez Inclure des explorations dans un modèle.

Inclure des explorations dans un modèle

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

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

L'exemple suivant est un fichier de modèle comportant deux explorations :

  • L'exploration aircraft_new, qui est définie dans son propre fichier appelé aircraft_new.explore.lkml dans le dossier explores. Étant donné que cette exploration est définie dans son propre fichier, vous devez spécifier le chemin d'accès au fichier d'exploration dans un paramètre include.
  • L'exploration accidents, qui est définie dans le fichier de modèle. Comme elle est définie dans le fichier de modèle lui-même, vous n'avez pas besoin d'utiliser de paramètre include pour elle 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 de vue pour 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.

Par exemple, 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 qu'il fonctionne correctement et voir si 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, il existe des cas où vous souhaitez inclure des fichiers dans votre fichier de vue :

Inclure des vues dans une vue (pour l'étendre ou l'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 des explorations dans une vue

Dans la plupart des cas, vous n'avez pas besoin 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 qui comporte un paramètre explore_source. Vous utilisez le paramètre explore_source pour spécifier une exploration et définir les colonnes et 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 des tables dérivées natives, il peut être plus judicieux de créer un fichier distinct pour l'exploration à l'aide de l'extension de fichier .explore.lkml. Si vous créez un fichier Explore distinct, vous devez l'inclure dans le fichier de vue Tableau dérivée native.

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

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 les fichiers Explore pour les tables dérivées natives, consultez notre documentation sur l'utilisation des instructions include pour activer le référencement des champs.

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 de vue pour 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.

Par exemple, 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 exécuter le test de données pour vérifier qu'il fonctionne correctement et voir si 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 Explore distinct pour une table dérivée, ou pour étendre ou affiner une exploration dans plusieurs modèles.

Si vous disposez d'un fichier Explore 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 Explore distinct, vous devez inclure toutes les vues utilisées par l'exploration. Utilisez l'extension de fichier .view pour les fichiers de vue. Vous pouvez omettre la partie .lkml de l'extension de fichier. Voici un exemple de fichier Explore 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
  }
}

Inclure des explorations dans une exploration

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

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

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

explore: aircraft_information {
  extends: [aircraft]

Utiliser include avec les dossiers de l'IDE

Lorsque vous organisez vos fichiers de projet LookML dans des dossiers, vous devez fournir les chemins d'accès aux fichiers dans l'instruction include.

Vous pouvez utiliser des chemins d'accès absolus ou relatifs dans l'instruction include (consultez la section Syntaxe des chemins d'accès sur cette page pour obtenir des exemples). Vous pouvez également utiliser les caractères génériques * et ** pour inclure plusieurs fichiers à la fois (consultez la section Exemples de caractères génériques sur cette page pour obtenir des exemples).

Par exemple, supposons que votre projet comporte la structure de répertoires suivante, avec le contenu de premier niveau du dossier views :

  • Le dossier orders, qui contient les fichiers de vue order_facts et order_items
  • Le dossier users, qui contient les fichiers de vue user_with_age_extension, users et users_extended
  • Les fichiers de vue individuelle distribution_centers, events, inventory_items et products

Exemple de structure de répertoire avec des dossiers pour les explorations, les modèles et les vues.

Les instructions suivantes incluront la vue products, la vue order_facts et toutes les vues du répertoire /views/users/ :

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

Lorsque vous modifiez le chemin d'accès d'un fichier, veillez à mettre à jour toutes les instructions include de votre projet pour qu'elles correspondent au nouveau chemin d'accès du fichier. Des avertissements de validation LookML peuvent s'afficher sur vos anciennes instructions include si elles ne font plus référence à des fichiers ou chemins d'accès existants. De plus, vous pouvez voir des erreurs de validation LookML pour les objets référencés qui ne sont plus trouvés, car leurs chemins d'accès aux fichiers ont changé.

Syntaxe des chemins d'accès

Voici quelques exemples de syntaxes que vous pouvez utiliser pour inclure des fichiers :

Syntaxe Description
PATH Chemin relatif commençant à l'emplacement du fichier actuel.
./PATH Chemin relatif commençant à l'emplacement du fichier actuel. Cet exemple pointe vers le même fichier que l'exemple précédent : PATH.
../PATH Chemin relatif commençant par le répertoire parent du fichier actuel.
/PATH Chemin absolu commençant à la racine du projet actuel.
//PROJECT_NAME/PATH Chemin absolu commençant à la racine d'un projet importé appelé PROJECT_NAME.

Utiliser des caractères génériques

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

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 à é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 pendant le développement lorsque vous devez créer une solution temporaire pour les avertissements de validation LookML, en particulier lorsque vous organisez 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 de l'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 fait 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 faire référence à tous les fichiers d'un type spécifique. Par exemple, cette instruction include fait référence à tous les fichiers Explorer d'un projet LookML :

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

Consultez la section Types de fichiers dans un projet LookML de la page de documentation Comprendre les fichiers de projet LookML pour obtenir la liste des types de fichiers LookML et de leurs extensions.

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

Vous pouvez également utiliser des caractères génériques avec une stratégie de nommage de fichiers pour optimiser davantage 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 ou un suffixe stratégique à vos noms de fichiers, comme suit :

/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 ne faire référence qu'au suffixe .fruit en utilisant include :

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

Exemples de caractères génériques

Voici quelques exemples d'utilisation de caractères génériques (notez que vous pouvez remplacer PATH par les syntaxes de chemin d'accès du tableau précédent) :

Syntaxe Description
PATH/*.view Correspondance générique des fichiers se terminant par .view à PATH.
PATH/*.view.lkml Correspondance générique des fichiers se terminant par .view.lkml à PATH.

Étant donné que les fichiers de vue ont l'extension .view.lkml, cet exemple spécifie le même fichier que l'exemple précédent, PATH/*.view. La partie .lkml n'est pas affichée dans l'IDE, et la partie .lkml n'est pas requise pour les instructions include. Toutefois, vous pouvez utiliser des caractères génériques pour exploiter cette partie commune de l'extension de fichier. Pour obtenir la liste des extensions de fichier de projet, consultez la page de documentation Fichiers de projets LookML.
PATH/*.lkml Correspondance générique des fichiers se terminant par .lkml à PATH.

Notez que plusieurs types de fichiers partagent .lkml comme dernière partie de l'extension de fichier, comme .view.lkml et .model.lkml. La partie .lkml n'est pas affichée dans l'IDE, et la partie .lkml n'est pas requise pour les instructions include. Toutefois, vous pouvez utiliser des caractères génériques pour exploiter cette partie commune de l'extension de fichier. Pour obtenir la liste des extensions de fichier de projet, consultez la page de documentation Fichiers de projets LookML.
PATH/myfile.* Correspondance générique des fichiers appelés myfile avec n'importe quel type d'extension dans PATH.
PATH/myfile.*.lkml Correspondance générique des fichiers appelés "myfile" avec n'importe quel type d'extension .lkml à PATH.
PATH/my*file.view Correspondance générique pour les fichiers commençant par my et se terminant par file.view à PATH.
PATH/my*fi*le.view Caractères génériques correspondant aux fichiers commençant par my, suivis de certains caractères, puis de fi, de certains caractères supplémentaires et se terminant par le.view à PATH.
PATH/*/myfile.lkml Caractère générique pour le nom du dossier (ne correspond qu'à un seul niveau d'imbrication). Correspond à tous les fichiers myfile.lkml dans les répertoires enfants directs de PATH.
PATH/**/my_file.view Correspondance générique récursive (correspond à n'importe quel niveau d'imbrication) pour tous les fichiers appelés my_file.view.lkml dans PATH et tous les sous-répertoires.
PATH/**/*.view Caractère générique récursif correspondant à tous les fichiers se terminant par .view.lkml dans les sous-répertoires de PATH.
PATH/**/my_folder/myfile.view Correspondance de caractère générique récursif avec le sous-chemin d'accès /my_folder/myfile.view à n'importe quelle profondeur sous PATH.

Exemples

Consultez les sections précédentes pour obtenir des exemples d'utilisation de include dans les fichiers de modèle, les fichiers de vue et les fichiers Explorer.

Éléments à prendre en compte

L'inclusion de tous les fichiers de vue peut affecter les performances de la validation LookML

Si votre projet comporte un grand nombre de fichiers de vue et que vous les incluez tous dans votre fichier de modèle, cela peut affecter les performances du validateur LookML. É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 nécessaires dans le paramètre include du fichier de modèle.

Envisagez d'utiliser des conventions de dénomination stratégiques pour les fichiers de vues afin d'inclure facilement des groupes de vues dans un modèle (consultez l'exemple dans Utiliser des caractères génériques avec des modèles de dénomination stratégiques sur cette page). Vous pouvez également utiliser les dossiers de l'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 de les inclure toutes dans votre projet. Pour en savoir plus, consultez la section Utiliser include avec les dossiers de l'IDE.

L'inclusion de tous les fichiers de vue peut encombrer le schéma de votre base de données.

Pour les projets qui utilisent des tables dérivées persistantes (PDT), vous pouvez inclure le fichier de vue de la PDT dans votre fichier de modèle. Toutefois, chaque fichier de modèle qui inclut le fichier de vue de la PDT créera une copie de la PDT dans le schéma temporaire 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 risquez d'encombrer inutilement le schéma temporaire de votre base de données. Pour cette raison, veillez à n'inclure le fichier de vue d'une PDT que dans les fichiers de modèle où la PDT est nécessaire.