Un projet LookML est un ensemble de fichiers LookML qui indiquent à Looker comment se connecter à votre base de données, comment interroger vos données et comment 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 de certains des 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 :
- Fichiers de modèle avec l'extension
.model.lkml - Fichiers de vue avec l'extension
.view.lkml - Fichiers de tableau de bord avec l'extension
.dashboard.lookml - Fichiers de données avec l'extension
.topojsonou.geojsonou.json - Fichiers de document avec l'extension
.md - Fichiers manifestes de projet toujours nommés
manifest.lkml - Fichiers de verrouillage de manifeste avec l'extension
.lkml - Fichiers de chaînes de paramètres régionaux avec l'extension
.strings.json - Fichiers d'exploration avec l'extension
.explore.lkml - Fichiers de test de données avec l'extension
.lkml - Fichiers d'affinements avec l'extension
.lkml - Autres fichiers avec une extension de fichier non répertoriée précédemment
Une fois que vous avez créé un projet LookML, vous pouvez accéder aux fichiers du projet et ajouter de nouveaux fichiers et 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 d'explorations qui utilisent cette connexion. Un fichier de modèle définit également les explorations elles-mêmes et leurs relations avec d'autres vues. Une exploration est un point de départ pour interroger vos données. En termes SQL, une exploration est 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.
Notez les points suivants concernant les fichiers de modèle :
- Les explorations sont généralement définies dans un fichier de modèle. Toutefois, vous avez parfois besoin d'un fichier d'exploration distinct pour une table dérivée, ou pour étendre une exploration ou pour affiner une exploration sur plusieurs modèles.
- Un fichier de modèle doit avoir un nom unique dans tous les projets de votre instance. Si votre instance contient deux fichiers
.model.lkmlportant le même nom, il est probable que vous rencontriez des erreurs, telles que des erreurs de configuration de modèle sur la page Projets LookML et des erreurs de rendu pour les erreurs de tableau de bord LookML, car les tableaux de bord LookML utilisent le nom du modèle dans leur format d'URL (<hostname>/dashboard/model_name::<dashboard_name>
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 des fichiers de modèle.
Structure et syntaxe générale
Entre les accolades d'une exploration, { }, vous définissez des paramètres pour 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
}
}
Cette définition LookML fait apparaître Inventory Items (Articles 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.
Pour obtenir des informations plus spécifiques sur les structures LookML dans un fichier de modèle, consultez la page de documentation Termes et concepts LookML.
Consultez les pages de documentation Paramètres de modèle, Paramètres d'exploration et Paramètres de jointure pour en savoir plus sur les paramètres LookML dans le fichier de modèle.
Fichiers de vue
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 dossiers LookML pour obtenir des instructions sur la création de fichiers de projet LookML, y compris des fichiers de vue.
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 de la table sous-jacente ou à un calcul dans Looker. Looker classe la plupart de ces définitions en tant que dimensions ou mesures.
Dans l'exemple suivant d'un fichier de vue, le orders.view fichier 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 expose les champs Created Date (Date de création), ID, Status (État), User ID (ID utilisateur) et Count (Nombre) dans le sélecteur de champs de l'exploration Orders (Commandes).
Les utilisateurs ayant accès à l'exploration Orders (Commandes) peuvent interroger l'exploration Orders (Commandes) en sélectionnant et en filtrant ces champs.
Outre les dimensions et les 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 avec des 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 consultez la page de documentation Paramètres de champ pour obtenir des informations 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 de tableau de bord
Looker est compatible avec deux types de tableaux de bord :
- Tableaux de bord définis par l'utilisateur, qui peuvent être créés par des utilisateurs non développeurs 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 contrôlés par version 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.
Documents
Les fichiers de document Looker vous permettent de rédiger de la documentation ou d'autres notes sur votre modèle de données Looker à l'aide de Markdown de type GitHub. Cela peut aider vos utilisateurs à se familiariser avec la façon dont votre organisation utilise Looker.
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 des fichiers de document.
Afficher le document en dehors de l'IDE
Pour afficher un document en dehors de l'IDE, ce que vous devrez faire 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 résultante à d'autres utilisateurs afin qu'ils puissent accéder directement au document sans avoir à parcourir le menu Développer de Looker.
Ajouter une structure de navigation à votre document
Vous pouvez ajouter une barre latérale à vos fichiers de document afin que les utilisateurs puissent voir la structure des informations et naviguer entre les documents.
Pour ajouter une navigation dans la barre latérale d'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 :
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 liste tous les documents du projet par ordre alphabétique selon le nom de fichier.
Vous constaterez peut-être 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 :
Dans cet exemple, vous pouvez afficher les documents Document One (Document 1), Document Two (Document 2), Document Three (Document 3) et Document Four (Document 4) par ordre numérique plutôt que par ordre alphabétique, et masquer le document Do Not Display (Ne pas afficher) dans la barre latérale de navigation.
Pour modifier l'ordre des documents dans la barre latérale de navigation ou 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
---
La navigation n'affiche désormais que les fichiers de document que vous souhaitez afficher, et ils apparaissent dans un ordre plus logique :
title
Par défaut, la barre latérale affiche l'en-tête du document (si le document commence par un en-tête) ou le nom de fichier du document s'il n'y a pas d'en-tête dans le fichier. Vous pouvez ajouter un paramètre title en haut d'un document pour modifier l'affichage du document dans les barres latérales de navigation :
---
title: New Title for Users
---
Ce titre sera utilisé comme texte de lien dans les barres latérales de navigation de tous les documents, sauf si vous spécifiez un label différent dans la section de navigation d'un document.
label
Si vous souhaitez modifier la façon dont un document est listé 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 façon dont un document est affiché dans la navigation de la barre latérale du document, même si le document auquel il fait référence possède son propre title paramètre.
L'exemple précédent se présente comme suit dans la barre latérale du document :
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 My Section Name (Nom de ma section) à la barre latérale.
L'en-tête de texte n'est pas un lien en soi ; 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 avec l'extension .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.
map_layer_nameètre avec une dimension afin de pouvoir associer une valeur de données (comme "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 Afficher le code 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 format JSON dans votre navigateur, vous aurez également la possibilité d'afficher le fichier au format Analysé.
Consultez la page de documentation Gérer les fichiers et dossiers LookML pour obtenir des instructions sur l'importation d'un fichier JSON dans un projet LookML.
Fichiers manifestes de projet
Votre projet peut contenir un fichier manifeste de projet, qui est utilisé pour les tâches suivantes :
- Spécifier d'autres projets à importer dans le projet actuel
- Spécifier les paramètres de localisation du modèle
- Définir des constantes LookML
- Ajouter une extension à votre projet
- Ajouter une visualisation personnalisée à votre projet
Consultez la page de documentation Paramètres du manifeste de projet pour voir un exemple de fichier manifeste et les paramètres possibles pour les fichiers manifestes. 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 des fichiers manifestes de projet.
Notez les points suivants concernant les fichiers manifestes de projet :
- Chaque projet ne peut contenir qu'un seul fichier manifeste, qui doit être nommé
manifest.lkmlet se trouver au niveau racine de la structure de répertoire de votre projet et dans votre dépôt Git. - Looker n'est pas compatible avec un fichier manifeste de projet vide. Si votre fichier manifeste est vide, supprimez-le.
- Chaque projet ne peut contenir qu'un seul fichier manifeste.
- Le fichier manifeste du projet doit être nommé
manifest.lkmlet se trouver au niveau racine de la structure de répertoire de votre projet.
Fichiers de verrouillage de manifeste
Les fichiers de verrouillage de manifeste sont créés automatiquement lorsqu'une dépendance à distance est ajoutée au fichier manifeste du projet. Looker utilise le fichier de verrouillage de manifeste pour suivre la version des projets distants spécifiés dans le fichier manifeste. Le fichier de verrouillage de 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 depuis 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 listent 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 ce paramètre régional pour 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 des fichiers de chaînes de paramètres régionaux.
Fichiers d'exploration
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, la clause FROM d'une instruction SQL. Consultez la page de documentation Afficher les explorations et interagir avec elles dans Looker pour savoir 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. Toutefois, vous avez parfois besoin d'un fichier d'exploration distinct pour une table dérivée, ou pour étendre ou affiner une exploration sur plusieurs modèles.
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 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 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 les fichiers et dossiers LookML pour obtenir des instructions sur la création de fichiers de projet LookML, y compris des fichiers de test de données.
Fichiers d'affinements
Votre projet peut contenir des fichiers utilisés pour les affinements LookML. Avec les affinements LookML, vous pouvez adapter une vue ou une exploration existante sans modifier le fichier LookML qui la contient. Les affinements 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 les fichiers et dossiers LookML pour obtenir des instructions sur la création de fichiers de projet LookML, y compris des fichiers d'affinements.
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.