Types de fichiers d'un projet LookML

Un projet LookML 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 de projet LookML depuis la section Développer de Looker ou depuis l'interface utilisateur, comme décrit sur la page de documentation Accéder aux fichiers de projet LookML.

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

Un projet LookML se compose d'au moins un fichier de modèle et d'au moins un fichier de vue, et éventuellement d'autres types de fichiers décrits sur cette page. Tous les fichiers de projet ont 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.

Sélectionnez 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 de base de données et l'ensemble des explorations qui utilisent cette connexion. Un fichier de modèle définit également les explorations proprement dites, ainsi que leurs relations avec les autres vues. Une exploration constitue le 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 vos utilisateurs lorsqu'ils 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, si nécessaire.

Consultez la page de documentation Gérer les fichiers et les dossiers LookML pour obtenir des instructions sur la création de fichiers de projet LookML, y compris de fichiers de modèle.

Structure et syntaxe générale

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

Dans l'exemple suivant, le code LookML d'un exemple de fichier de modèle définit une exploration appelée inventory_items, ainsi que ses vues jointes :

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

Avec cette définition LookML, les éléments d'inventaire apparaissent 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", "Articles d'inventaire" et "Produits" sont accessibles à partir du sélecteur de champs de l'exploration des articles d'inventaire.

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

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

Afficher les fichiers

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

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

Structure et syntaxe générale

Les crochets { } de chaque vue contiennent des définitions de champs, qui correspondent généralement à une colonne de la table sous-jacente ou à un calcul dans Looker. Looker les classe pour la plupart en tant que dimensions ou mesures.

Dans l'exemple de fichier de vue suivant, le fichier orders.view inclut des définitions pour les 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 affiche les champs Date de création, ID, État, ID utilisateur et Nombre dans le sélecteur de champ de l'exploration Commandes.

Les utilisateurs ayant accès à l'exploration Commandes peuvent interroger l'exploration Commandes en sélectionnant et en filtrant sur ces champs.

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

Fichiers du tableau de bord

Looker propose deux types de tableaux de bord :

  • Tableaux de bord définis par l'utilisateur, que les utilisateurs non développeurs peuvent créer sans utiliser LookML. Pour en savoir plus, consultez la page de documentation 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 associés au projet.

Si votre projet contient des tableaux de bord LookML, ils seront définis dans des fichiers de tableau de bord dédiés dans l'IDE, avec l'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 documents

Les fichiers de document Looker vous permettent de rédiger des documents ou d'autres notes sur votre modèle de données Looker à l'aide de Markdown au format GitHub. Vos utilisateurs pourront ainsi se familiariser avec la façon dont votre organisation utilise Looker.

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

Afficher le document en dehors de l'IDE

Pour afficher un document en dehors de l'IDE, ce qui est nécessaire pour profiter des fonctionnalités de navigation décrites sur cette page, sélectionnez l'option Afficher le document dans le menu Afficher les actions sur le fichier du fichier de document :

Vous pouvez distribuer l'URL de la page générée à d'autres utilisateurs afin qu'ils n'aient pas besoin de parcourir 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 à 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 en commençant par 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 avec 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 liste tous les documents du projet par ordre alphabétique du nom de fichier.

Vous pouvez également trouver que l'organisation par nom de fichier alphabétique n'est pas idéale, ou que certains documents ne doivent pas apparaître dans la navigation :

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

Dans cet exemple, vous pouvez lister les documents Document 1, Document 2, Document 3 et Document 4 par ordre numérique plutôt qu'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 de navigation latérale ou pour n'afficher qu'une partie d'entre eux dans la barre latérale, vous pouvez utiliser le format suivant:

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

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

Les documents sont classés par ordre numérique dans la barre latérale et le document "Ne pas afficher" ne s'affiche plus.

title

Par défaut, la barre latérale affiche l'en-tête du document (s'il commence par un en-tête) ou le nom du fichier (s'il n'y en a pas). 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 un autre label 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 la manière dont un document s'affiche dans la barre de navigation latérale du document, 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 comme Étiquette personnalisée pour le Document 2 dans la barre latérale.

section

Si vous souhaitez diviser 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 de texte Mon nom de section à la barre latérale.

Le titre du texte n'est pas un lien en soi. Il ne fait référence à aucun de vos fichiers de documents.

Fichiers de données

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

Le paramètre map_layer vous permet d'utiliser un fichier JSON comme carte personnalisée, qui peut ensuite être utilisée pour tracer vos données dans Looker.

Vous utilisez ensuite le paramètre map_layer_name avec une dimension afin d'associer une valeur de données (comme "Paris") à une zone 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 Afficher le fichier brut en sélectionnant le menu Afficher les actions sur le fichier à côté du nom du fichier pour afficher le fichier au format brut. Si vous disposez de l'extension appropriée pour afficher le fichier JSON dans votre navigateur, vous avez également la possibilité d'afficher le fichier au format Analysé.

Consultez la page de documentation Gérer les fichiers et dossiers LookML pour savoir comment importer un fichier JSON dans un projet LookML.

Fichiers manifestes d'un projet

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

Chaque projet ne peut contenir qu'un seul fichier manifeste, qui doit être nommé manifest.lkml et situé au niveau racine de la structure de répertoires de votre projet et dans votre dépôt Git.

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

Fichiers de verrouillage du fichier manifeste

Les fichiers de verrouillage du fichier manifeste sont créés automatiquement lorsqu'une dépendance distante est ajoutée au fichier manifeste du projet. Looker utilise le fichier de verrouillage du manifeste pour suivre la version des projets distants spécifiée dans le fichier manifeste. Le fichier de verrouillage du fichier manifeste est listé dans le panneau de l'explorateur de fichiers de l'IDE Looker et porte le nom de fichier manifest_lock.lkml.

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

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

Fichiers de chaînes de paramètres régionaux

Si vous localisez votre modèle de données, vous devez créer des fichiers de chaînes de paramètres régionaux pour chaque paramètre régional que vous souhaitez localiser, y compris votre paramètre régional par défaut (par exemple, souvent l'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 correspondant à 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 de documentation Localiser votre modèle LookML.

Consultez la page de documentation Gérer les fichiers et dossiers LookML pour obtenir des instructions sur la création de fichiers de projet LookML, y compris les fichiers de chaînes de paramètres régionaux.

Parcourir les fichiers

Une exploration est une vue sur laquelle les utilisateurs peuvent lancer une requête. Une exploration constitue le point de départ d'une requête ou, en termes SQL, le FROM d'une instruction SQL. Consultez la page de documentation Afficher et interagir avec les explorations dans Looker pour découvrir comment les utilisateurs interagissent avec les explorations pour interroger vos données.

Les explorations sont généralement définies dans un fichier de modèle. Cependant, il est parfois nécessaire d'avoir un fichier d'exploration distinct pour une table dérivée, ou pour extend ou affiner une exploration d'un modèle à l'autre.

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

Fichiers de test de données

Votre projet peut contenir des 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 de vue, mais si vos développeurs souhaitent utiliser les mêmes tests de données dans plusieurs modèles différents, il peut être utile de les conserver dans leur propre fichier dédié.

Consultez la page de documentation Gérer les fichiers et dossiers LookML pour obtenir des instructions sur la création de fichiers de projet LookML, y compris les fichiers de test de données.

Fichiers de suggestions

Votre projet peut contenir des fichiers utilisés pour les perfectionnements de LookML. Les améliorations LookML vous permettent d'adapter une vue ou une exploration existante sans modifier le fichier LookML qui la contient. Les perfectionnements LookML peuvent être inclus 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 les fichiers et les dossiers LookML pour savoir comment créer des fichiers de projet LookML, y compris des fichiers de perfectionnements.

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.