Types de fichiers d'un projet LookML

Un projet Looker est un ensemble de fichiers LookML qui indiquent à Looker comment se connecter à votre base de données, interroger vos données et contrôler le comportement de l'interface utilisateur. Vous pouvez accéder aux fichiers du projet LookML depuis la section Développer de Looker ou l'interface utilisateur, comme décrit sur la page Accéder aux fichiers du projet LookML.

Les fichiers du projet sont organisés par vos développeurs Looker à l'aide de dossiers dans l'IDE.

Un projet LookML comprend au moins un fichier de modèle, au moins un fichier de vue et éventuellement d'autres types de fichiers décrits sur cette page. Tous les fichiers de projet contiennent des extensions, bien que celles-ci soient masquées dans la liste de l'IDE si votre projet n'est pas activé pour les dossiers dans l'IDE.

Cliquez sur les liens suivants pour en savoir plus sur chacun des types de fichiers pouvant être utilisés dans un projet LookML:

Une fois que vous avez créé un projet LookML, vous pouvez accéder aux fichiers du projet, et ajouter des fichiers et des dossiers au projet à l'aide de l'IDE Looker.

Fichiers de modèle

Un fichier de modèle spécifie une connexion à une base de données et l'ensemble d'explorations qui utilisent cette connexion. Un fichier de modèle définit également les explorations elles-mêmes et leurs relations avec les autres vues. Une exploration est un point de départ pour interroger vos données. En termes SQL, une exploration correspond à la clause FROM d'une requête. Les explorations que vous définissez dans le modèle sont visibles par les utilisateurs qui consultent le menu Explorer de Looker.

En d'autres termes, c'est dans le fichier de modèle que vous définissez les tables de données à utiliser (en tant que vues incluses) et la manière dont elles doivent être jointes, le cas échéant.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers de modèle.

Structure et syntaxe générale

Entre les accolades { }, vous définissez les paramètres de l'exploration. Vous pouvez utiliser les paramètres join pour joindre d'autres vues à une exploration dans un fichier de modèle.

Dans l'exemple suivant, le LookML dans un exemple de fichier de modèle définit une exploration appelée inventory_items, ainsi que les vues associées:

connection: "thelook_events"

explore: inventory_items {
  join: products {
    type: left_outer
    sql_on: ${inventory_items.product_id} = ${products.id} ;;
    relationship: many_to_one
  }

  join: distribution_centers {
    type: left_outer
    sql_on: ${products.distribution_center_id} = ${distribution_center.id} ;;
    relationship: many_to_one
  }
}

Cette définition LookML entraîne l'affichage des éléments d'inventaire dans la section Explorer de la navigation Looker, et joint les données des vues products et distribution_centers à la vue inventory_items.

Les vues Centres de distribution, Éléments d'inventaire et Produits sont accessibles depuis le sélecteur de champ de la section "Explorer les éléments d'inventaire".

Pour en savoir plus sur les structures LookML dans un fichier de modèle, consultez la page Termes et concepts de LookML.

Pour en savoir plus sur les paramètres LookML dans le fichier de modèle, consultez les pages de documentation sur les paramètres de modèle, les paramètres d'exploration et les paramètres de jointure.

Afficher les fichiers

Un fichier de vue définit généralement une "vue" unique dans Looker. Une vue correspond à une seule table de votre base de données ou à une seule table dérivée. Le fichier d'affichage spécifie une table à interroger et les champs (dimensions et mesures) à inclure à partir de cette table afin que les utilisateurs puissent créer des requêtes avec ces champs dans l'interface utilisateur de Looker.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris afficher des fichiers.

Structure et syntaxe générale

Entre les accolades de chaque vue, { } se trouvent des définitions de champ, qui correspondent généralement à une colonne du tableau sous-jacent ou à un calcul dans Looker. Looker classe la plupart d'entre elles comme des dimensions ou des mesures.

Dans l'exemple de fichier de vue suivant, le fichier orders.view inclut les définitions des dimensions id, status et user_id, le groupe de dimensions created et la mesure count:

view: orders {
  sql_table_name: demo_db.orders ;;
  drill_fields: [id]

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

  dimension: status {
    type: string
    sql: ${TABLE}.status ;;
  }

  dimension: user_id {
    type: number
    # hidden: yes
    sql: ${TABLE}.user_id ;;
  }

    dimension_group: created {
    type: time
    timeframes: [
      raw,
      time,
      date,
      week,
      month,
      quarter,
      year
    ]
    sql: ${TABLE}.created_at ;;
  }

  measure: count {
    type: count
    drill_fields: [id, users.id, users.first_name, users.last_name, order_items.count]
  }
}

La définition de ces champs dans la vue orders expose les champs Date de création, ID, État, ID utilisateur et Nombre dans l'outil de sélection des champs de l'exploration Commandes.

Les utilisateurs ayant accès à l'onglet Explorer les commandes peuvent interroger la section Explorer les commandes en sélectionnant et en filtrant ces champs.

En plus des dimensions et des mesures, vous pouvez créer plusieurs dimensions à la fois à l'aide de groupes de dimensions ou spécifier un filtre pour vos utilisateurs avec des champs de filtre. Consultez la page de documentation Afficher les paramètres pour en savoir plus sur les paramètres LookML dans les fichiers de vue, et la page Paramètres des champs pour en savoir plus sur les paramètres LookML utilisés pour définir les dimensions, les mesures, les groupes de dimensions et les champs de filtrage dans LookML.

Fichiers du tableau de bord

Looker accepte deux types de tableaux de bord:

  • Les tableaux de bord définis par l'utilisateur, qui peuvent être créés par des utilisateurs non techniques sans LookML. Pour en savoir plus, consultez la page Créer des tableaux de bord définis par l'utilisateur.
  • Tableaux de bord LookML, qui sont stockés en tant que fichiers avec contrôle des versions et associés au projet.

Si votre projet contient des tableaux de bord LookML, ils sont définis dans des fichiers de tableaux de bord dédiés dans l'IDE (extension .dashboard.lookml).

Pour en savoir plus sur les tableaux de bord LookML, consultez la page de documentation Créer des tableaux de bord LookML.

Fichiers de document

Les fichiers de documents Looker vous permettent d'écrire de la documentation ou d'autres notes sur votre modèle de données Looker à l'aide de Markdown, une version de GitHub. Cela peut aider vos utilisateurs à se familiariser avec la façon dont votre organisation utilise Looker.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers de documents.

Afficher le document en dehors de l'IDE

Pour afficher un document en dehors de l'IDE, pour pouvoir profiter des fonctionnalités de navigation décrites sur cette page, choisissez l'option Afficher le document dans le menu Consulter les actions pour le fichier correspondant:

Vous pouvez distribuer l'URL de la page obtenue à d'autres utilisateurs afin qu'ils n'aient pas à naviguer dans la section des développeurs de Looker pour y accéder.

Ajouter une structure de navigation à votre document

Vous pouvez ajouter une barre latérale aux fichiers de vos documents afin que les utilisateurs puissent facilement voir la structure des informations et naviguer entre les documents.

Pour ajouter une barre latérale de navigation à un document, créez une section de navigation à partir de la première ligne du document. Marquez le début et la fin de votre section de navigation avec trois tirets (---).

Vous pouvez utiliser les paramètres suivants dans la section de navigation:

Vous pouvez utiliser navigation: true dans un fichier de document pour ajouter la barre latérale de navigation à ce document. Par exemple, vous pouvez ajouter le code suivant en haut d'un fichier Markdown:

---
navigation: true
---

Ce code ajoute au document une barre latérale de navigation contenant des liens vers tous les documents du projet. Si vous n'incluez que navigation: true dans un document, la barre latérale de ce document répertorie tous les documents du projet, par ordre alphabétique.

Il peut également arriver que l'organisation par nom de fichier alphabétique n'est pas idéale ou que vous ne souhaitiez pas que certains documents apparaissent dans le menu de navigation:

La barre latérale affiche le document 4, le document 1, le document 3 et le document 2 par ordre alphabétique, ainsi qu'un document intitulé "Ne pas afficher".

Dans cet exemple, vous pouvez lister les documents Document One, Document 2, Document Three et Document Four par ordre numérique plutôt que par ordre alphabétique, et masquer le document Ne pas afficher dans la barre latérale de navigation.

Pour modifier l'ordre des documents dans la barre latérale de navigation, ou pour n'afficher qu'un sous-ensemble de vos documents dans la barre latérale, vous pouvez utiliser le format suivant:

---
navigation:
  - document_one
  - document_two
  - document_three
  - document_four
---

Désormais, la navigation n'affiche que les fichiers de documents que vous souhaitez afficher, et dans un ordre plus logique:

La barre latérale liste les documents dans l'ordre numérique. Le document ne s'affiche plus.

title

Par défaut, la barre latérale affiche l'en-tête du document (si le document commence par un titre) ou le nom du fichier si le fichier ne contient pas de titre. Vous pouvez ajouter un paramètre title en haut d'un document pour modifier son affichage dans les barres latérales de navigation:

---
title: New Title for Users
---

Ce titre sera utilisé comme texte du lien dans les barres latérales de navigation de tous les documents, sauf si vous spécifiez une label différente dans la section de navigation d'un document.

label

Si vous souhaitez modifier la façon dont un document est répertorié dans la barre latérale de navigation, vous pouvez utiliser les paramètres document et label comme suit:

---
navigation:
  - document_one
  - document: document_two
    label: Customized Label for Document Two
  - document_three
  - document_four
---

La valeur label définit l'affichage d'un document dans la barre de navigation latérale, même si le document auquel il fait référence possède son propre paramètre title.

L'exemple précédent se présente comme suit dans la barre latérale du document:

La page "document_two" est répertoriée en tant que libellé personnalisé pour le document 2 dans la barre latérale.

section

Si vous souhaitez décomposer la barre latérale de navigation en sections, vous pouvez utiliser le paramètre section comme suit:

---
navigation:
  - document_one
  - document_two
  - section: My Section Name
  - document_three
  - document_four
---

Dans cet exemple, le paramètre section ajoute un saut de section et l'en-tête Nom de la section à la barre latérale.

L'en-tête du texte n'est pas un lien lui-même. Il ne fait référence à aucun de vos fichiers de document.

Fichiers de données

Les fichiers de données sont des fichiers JSON portant l'extension .json, .topojson ou .geojson.

Le paramètre map_layer vous permet d'utiliser un fichier JSON en tant que carte personnalisée, qui peut ensuite servir à tracer vos données dans Looker.

Utilisez ensuite le paramètre map_layer_name avec une dimension afin d'associer une valeur de données (telle que "Paris") à une région géographique sur votre carte personnalisée.

Vous pouvez modifier un fichier JSON dans l'IDE LookML, puis sélectionner Enregistrer.

Pour le débogage, vous pouvez choisir l'option Afficher le fichier brut. Pour ce faire, sélectionnez le menu Actions sur les fichiers à côté du nom du fichier. Si vous disposez de l'extension appropriée pour afficher le fichier JSON dans votre navigateur, vous pourrez également afficher le fichier au format Analysé.

Pour savoir comment importer un fichier JSON dans un projet LookML, consultez la page de documentation Gérer des fichiers et des dossiers LookML.

Fichiers manifestes d'un projet

Votre projet peut contenir un fichier manifeste de projet, utilisé pour les tâches suivantes:

Chaque projet ne peut avoir qu'un seul fichier manifeste. Il doit être nommé manifest.lkml et se trouver à la racine de la structure de répertoires de votre projet et dans le dépôt Git.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers manifestes.

Fichiers de verrouillage du fichier manifeste

Les fichiers de verrouillage des fichiers manifestes sont créés automatiquement lorsqu'une dépendance distante est ajoutée au fichier manifeste du projet. Looker utilise le fichier manifeste de verrouillage pour suivre la version des projets distants qui sont spécifiées dans le fichier manifeste.

Les développeurs Looker n'ont pas besoin de créer ni de modifier un fichier de verrouillage du fichier manifeste, car ils sont gérés automatiquement par Looker.

Pour en savoir plus, consultez la page de documentation Importer des fichiers à partir d'autres projets.

Paramètres régionaux de fichiers

Si vous localisez votre modèle de données, vous devez créer des fichiers de chaînes correspondant à chaque paramètre régional que vous souhaitez localiser, y compris les paramètres régionaux par défaut (par exemple, souvent en anglais aux États-Unis).

Les fichiers de chaînes de paramètres régionaux répertorient les paires clé-valeur pour chaque libellé et description que vous localisez dans votre modèle. Le fichier de chaînes de chaque paramètre régional doit fournir la traduction de chaque libellé ou description. Pour en savoir plus sur la création de fichiers de chaînes de paramètres régionaux, consultez la page Localiser votre modèle LookML.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers de chaînes de paramètres régionaux.

Explorer des fichiers

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

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris "Explorer".

Fichiers de test de données

Votre projet peut disposer de fichiers de test de données utilisés pour vérifier la logique de votre modèle LookML. Les tests de données peuvent être contenus dans des fichiers de modèle ou dans des fichiers de vue, mais si vos développeurs souhaitent utiliser les mêmes tests de données sur plusieurs modèles différents, il peut être utile de conserver les tests de données dans leur propre fichier dédié.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers de test de données.

Fichiers de filtre

Votre projet peut comporter des fichiers pour les filtres LookML. Les filtres LookML vous permettent d'adapter une vue ou une exploration existante sans modifier le fichier LookML qui les contient. Les filtres LookML peuvent être contenus dans des fichiers de modèle, de vue ou d'exploration, ou dans leur propre fichier dédié.

Consultez la page de documentation Gérer des fichiers et des dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers de filtre.

Autres fichiers

De nombreux éléments LookML peuvent être hébergés dans différents fichiers de votre projet ou dans leurs propres fichiers dédiés. Par exemple, les tests de données peuvent être hébergés dans des fichiers de modèle, des fichiers de vue ou leurs propres fichiers .lkml dédiés.