Gestion des fichiers et dossiers LookML

Les fichiers de projet LookML sont organisés en dossiers dans la section explorateur de fichiers de l'IDE Looker. Cette page fournit des instructions pour créer et gérer des dossiers et des fichiers dans un projet LookML.

Pour en savoir plus sur la structure et l'objectif de chaque type de fichier d'un projet LookML, consultez la page de documentation Types de fichiers dans un projet LookML.

Avant de commencer: Conventions importantes pour l'attribution de noms aux fichiers et aux dossiers

Lorsque vous créez des fichiers et des dossiers, il est préférable de garder à l'esprit les conventions d'attribution de noms suivantes:

• Sensibilité à la casse:LookML est sensible à la casse. Veillez à respecter les conventions de votre projet lorsque vous nommez vos dossiers. Par exemple, si votre convention consiste à utiliser toutes les lettres minuscules dans votre projet, vous devez nommer votre dossier views au lieu de Views. Cela fait une différence, surtout lorsque vous devez spécifier le chemin d'accès à un fichier, comme lorsque vous incluez des fichiers. En règle générale, il est recommandé d'utiliser systématiquement des lettres minuscules dans les noms d'objets et de dossiers LookML.
• Espaces et caractères spéciaux:les noms de fichiers ne peuvent pas contenir d'espaces ni aucun des caractères suivants: / ? * : | " < > %
• Extensions de fichier:lorsque vous créez des fichiers LookML avec l'IDE Looker, Looker ajoute automatiquement l'extension .lkml à la fin du nom de fichier si vous ne l'incluez pas manuellement. Par exemple, si vous saisissez le nom de fichier flights_data_tests, Looker le nommera flights_data_tests.lkml.
• Modifier le nom affiché d'un objet LookML:si vous souhaitez modifier le nom affiché d'un modèle ou d'un objet LookML, utilisez le paramètre label ou alias au lieu de renommer le fichier ou l'objet. Les paramètres label et alias modifient le nom affiché tout en conservant l'URL sous-jacente utilisée pour les e-mails ou d'autres systèmes. En règle générale, il convient de prendre les précautions nécessaires pour que les modifications apportées à un modèle soient aussi non invasives que possible. Si vous devez renommer un modèle ou un objet, utilisez l'outil de validation de contenu pour mettre à jour toutes les références à ces modèles ou objets.

Créer des dossiers

Vous pouvez créer des dossiers pour différents types de fichiers (des fichiers de vue ou des fichiers de modèle, par exemple). Vous pouvez même créer des sous-dossiers, ce qui est très utile si vous souhaitez include un sous-ensemble de vos vues.

Remarque :Lorsque vous créez des dossiers, n'oubliez pas que LookML est sensible à la casse. Veillez à respecter les conventions de votre projet lorsque vous nommez vos dossiers. C'est important, surtout lorsque vous devez spécifier le chemin d'accès d'un fichier, comme lorsque vous incluez des fichiers. En règle générale, il est recommandé d'utiliser systématiquement des lettres minuscules dans les noms d'objets et de dossiers LookML. Pour connaître les limites et les consignes relatives aux noms de fichiers et de dossiers, consultez les remarques importantes concernant la création de fichiers et de dossiers.

Pour créer un dossier, procédez comme suit :

1. Sélectionnez l'option Create Folder (Créer un dossier) dans le menu approprié :
   • Pour créer un dossier au premier niveau de votre structure de répertoires, utilisez le menu Ajouter un fichier ou un dossier, auquel vous pouvez accéder en sélectionnant l'icône + (plus) en haut du panneau Explorateur de fichiers.
   • Pour créer un sous-dossier dans un dossier existant, utilisez le menu à trois points Options des dossiers.
2. Saisissez le nom du nouveau dossier.
3. Sélectionnez Créer.

Le nouveau dossier est ajouté au volet de navigation.

Création de fichiers

Vous pouvez générer automatiquement un fichier de modèle et afficher les fichiers basés sur votre base de données lorsque vous créez un projet. Pour les projets existants, vous pouvez créer des fichiers manuellement.

Remarque :Il est recommandé d'utiliser l'IDE Looker pour ajouter des fichiers à votre projet LookML, soit en les créant dans l'IDE Looker comme décrit ci-dessous dans cette section, soit en les important dans l'IDE Looker. Si vous créez des fichiers en dehors de l'IDE Looker, puis utilisez l'IDE Looker pour utiliser l'option Extraire de (branche de production), veillez à utiliser les conventions d'attribution de noms appropriées et à inclure l'extension .lkml dans le nom du fichier (ou explore.lkml pour les fichiers d'exploration). Si un nom de fichier contient des caractères non pris en charge, l'explorateur de fichiers de l'IDE Looker affichera le nom du fichier en rouge, et vous ne pourrez pas voir son contenu tant que vous ne l'aurez pas renommé avec les caractères pris en charge. De plus, l'IDE Looker n'affichera pas du tout le fichier s'il ne porte pas l'extension .lkml.

Pour créer un fichier dans votre projet LookML:

1. Sélectionnez le menu approprié:

   • Pour créer un fichier au premier niveau de votre structure de répertoires, utilisez le menu Ajouter un fichier ou un dossier. Pour y accéder, sélectionnez l'icône + (plus) en haut du panneau Explorateur de fichiers.
   • Pour créer un fichier dans un dossier existant, utilisez le menu à trois points Options des dossiers.

2. Sélectionnez le type de fichier LookML que vous souhaitez créer. Cliquez sur les liens de la liste suivante pour obtenir une description plus détaillée de chaque type de fichier. Vous pouvez créer les types de fichiers suivants:

   • Fichiers de modèle avec l'extension .model.lkml
   • Afficher les fichiers avec l'extension .view.lkml*
   • Fichiers manifestes de projet toujours nommés manifest.lkml**
   • Fichiers de tableau de bord avec l'extension .dashboard.lookml
   • Fichiers de document avec l'extension .md
   • Fichiers de chaînes de paramètres régionaux avec l'extension .strings.json***
   • Des fichiers LookML génériques, utilisés pour les types de fichiers suivants :
     • Explorer les fichiers avec l'extension .explore.lkml****
     • Fichiers de test de données avec l'extension .lkml
     • Fichiers de filtres avec l'extension .lkml
     • Tout autre fichier que vous utilisez pour héberger des éléments LookML
   Remarque:

   ^* Consultez la section Éléments à prendre en compte pour créer des fichiers de vue sur cette page pour obtenir des instructions sur d'autres méthodes de création de fichiers de vue, y compris des instructions sur l'ajout de fichiers de vue basés sur des tables de base de données.

   ^** Vous ne pouvez créer des fichiers manifestes de projet qu'en sélectionnant l'icône + (plus) pour ouvrir le menu Ajouter un fichier ou un dossier en haut de l'explorateur de fichiers dans l'IDE Looker, et uniquement si le projet ne contient pas encore de fichier manifeste. En effet, un projet ne peut contenir qu'un seul fichier manifeste, qui doit se trouver au niveau racine de la structure de répertoires du projet.

   ^*** L'option Créer un fichier de chaînes de paramètres régionaux n'est disponible qu'à partir de l'icône Ajouter un fichier ou un dossier + (plus) en haut de l'explorateur de fichiers dans l'IDE Looker. Cependant, une fois qu'un fichier de chaînes de paramètres régionaux est créé (ou importé), vous pouvez le déplacer vers un dossier. Si vous créez des fichiers de chaînes de paramètres régionaux pour localiser votre modèle et que vous souhaitez également bénéficier de la localisation de l'interface utilisateur native de Looker, vous devez nommer vos fichiers de chaînes à l'aide de codes de paramètres régionaux spécifiques. Ces codes sont indiqués dans la section "Paramètres régionaux" de la page de documentation Utilisateurs.

   ^**** Lorsque vous créez un fichier d'exploration, le nom du fichier doit porter l'extension .explore.lkml. Si vous importez le fichier, vous devez utiliser l'extension .explore.lkml complète. Si vous utilisez l'IDE Looker pour créer le fichier avec l'option Fichiers LookML génériques, Looker ajoutera .lkml à la fin du nom de fichier si l'extension n'est pas présente, mais vous devez toujours ajouter manuellement la partie .explore de l'extension au nom de fichier. Par exemple, pour créer un fichier d'exploration nommé flights à l'aide de l'IDE Looker, vous pouvez saisir flights.explore ou flights.explore.lkml. Le fichier s'appellera flights.explore.lkml.

3. Dans la fenêtre pop-up Créer un fichier, saisissez le nom du nouveau fichier. Pour connaître les limites et les consignes relatives aux noms de fichiers, consultez les remarques importantes concernant la création de fichiers et de dossiers.

4. Sélectionnez Créer. Le nouveau fichier s'affiche là où vous l'avez créé. Si nécessaire, vous pouvez facilement le déplacer vers un autre dossier.

Important :Une fois le fichier créé, veillez à utiliser le paramètre include si vous souhaitez référencer des éléments du fichier dans d'autres fichiers LookML de votre projet. Pour en savoir plus, consultez la page de documentation du paramètre include.

Remarque :Si votre administrateur Looker a activé la fonctionnalité Labs Génération de code LookML améliorée, le menu Ajouter un fichier ou un dossier + (plus) en haut du panneau Explorateur de fichiers propose une option Générer du code LookML à partir de la base de données en plus des options indiquées ici.

Remarques concernant la création de fichiers de vue

La plupart des développeurs LookML commencent avec un ou plusieurs fichiers de vue, qui sont créés automatiquement lorsque le projet LookML est généré à partir d'un ensemble de tables dans une base de données. Toutefois, en plus des méthodes décrites sur cette page pour créer des fichiers de vue vides et importer des fichiers, il existe de nombreuses façons pour un développeur Looker en mode Développement d'ajouter des fichiers de vue à un projet LookML:

• Créer des fichiers de vue basés sur des tables dans une base de données:

  • Générer des fichiers de vue à partir de tables de base de données lors de votre première connexion à votre base de données, comme décrit sur la page de documentation Générer un modèle
  • Générer des fichiers de vue à partir de tables de base de données pour un projet déjà connecté à une base de données, comme décrit dans la section Ajouter une vue à partir d'une table de base de données existante de cette page

• Créer un fichier de vue pour une table dérivée:

  • Commencez par utiliser un fichier de vue vide en utilisant l'une des options décrites sur cette page, puis définissez manuellement votre table dérivée, comme indiqué dans la section Définir une table dérivée native dans LookML de la page de documentation Créer des tables dérivées natives.
  • Demander à Looker de créer le code LookML de la table dérivée à partir d'une exploration, comme décrit dans la section Utiliser une exploration pour commencer à définir vos tables dérivées natives de la page de documentation Créer des tables dérivées natives
  • Demander à Looker de créer le code LookML de la table dérivée à partir d'une requête SQL Runner, comme décrit sur la page de documentation Utiliser SQL Runner pour créer des tables dérivées

Pour utiliser une nouvelle vue, ajoutez-la à votre fichier de modèle à l'aide du paramètre explore ou utilisez le paramètre join pour la joindre à une exploration existante dans votre fichier de modèle.

Ajouter une vue à partir d'une table de base de données existante

Vous pouvez créer un fichier de vue à partir d'une table de base de données existante en mode Développement.

1. Dans un projet, sélectionnez le menu Ajouter un fichier ou un dossier en sélectionnant le signe + (plus) en haut de la liste des fichiers du projet dans l'IDE Looker. Vous pouvez également sélectionner le menu d'un dossier pour créer le fichier à l'intérieur du dossier.

2. Sélectionnez Créer une vue à partir d'une table.

3. Looker affiche une liste de tables associées à l'une de vos connexions. Pour modifier la connexion, utilisez le menu déroulant Connexion situé en haut à gauche.

4. Sélectionnez les tables à partir desquelles vous souhaitez créer des vues en cochant la case à gauche de leur nom. Vous pouvez réduire et développer les bases de données ou les schémas de cette liste pour accéder à toutes les tables disponibles.

5. Faites défiler la page jusqu'en bas, puis sélectionnez Créer des vues.

6. Looker génère des vues contenant du code LookML pour toutes les colonnes de la table.

Importer des fichiers

Vous pouvez également importer des fichiers dans votre projet depuis votre ordinateur. Cela peut être utile si vous avez créé des fichiers de données JSON ou des fichiers LookML localement sur votre ordinateur.

Remarque :Consultez les remarques importantes concernant la création de fichiers et de dossiers pour connaître les limites et les consignes relatives aux noms de fichiers.

Pour importer un fichier dans votre projet, utilisez la fonction de glisser-déposer dans l'IDE Looker:

1. Accédez aux fichiers de votre projet.
2. Faites glisser le fichier de votre ordinateur dans l'IDE Looker. Le fichier sera affiché à la racine de votre structure de répertoires.
3. Une fois le fichier importé, déplacez l'élément vers un autre dossier.

Important :Une fois le fichier importé, veillez à utiliser le paramètre include si vous souhaitez référencer le fichier ou ses éléments dans d'autres fichiers LookML de votre projet. Pour en savoir plus, consultez la page de documentation du paramètre include.

Supprimer des fichiers et des dossiers

Supprimez un dossier ou un fichier en sélectionnant Delete (Supprimer) dans le menu à trois points File Options (Options de fichier) de l'élément dans le panneau de gauche de l'IDE.

Remarque:La suppression d'un dossier entraîne également celle de son contenu. Soyez donc prudent lorsque vous supprimez des dossiers. Avant de supprimer un dossier, procédez comme suit :

• Vérifiez que vous souhaitez supprimer les fichiers du dossier ou déplacez-les vers un autre emplacement avant de supprimer le dossier.
• Vérifiez que le dossier ne contient aucun fichier mentionné dans les instructions include de votre projet. Pour en savoir plus sur l'utilisation de include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation sur le paramètre include.

Lorsque vous supprimez un dossier, l'IDE affiche un pop-up de confirmation. La fenêtre pop-up indique le nombre d'éléments inclus dans la suppression, y compris le dossier et tous les fichiers qu'il contient.

Remarque :Si vous supprimez un fichier de modèle, le modèle n'est pas supprimé des ensembles de modèles auxquels il appartenait. Si vous créez un fichier de modèle portant le même nom qu'un modèle supprimé, le nouveau modèle est inclus dans tous les ensembles de modèles incluant le modèle supprimé. Cela peut donner lieu à un accès indésirable au nouveau fichier de modèle. Pour éviter ce problème, les administrateurs Looker peuvent modifier des ensembles de modèles et supprimer un modèle supprimé.

Supprimer des fichiers et des dossiers de manière groupée

Pour supprimer des dossiers et des fichiers de manière groupée:

Remarque :La suppression d'un dossier entraîne la suppression de tout son contenu. Avant de supprimer un dossier, vérifiez que vous souhaitez bien supprimer les fichiers qu'il contient. Si vous souhaitez les conserver, déplacez-les vers un autre emplacement avant de supprimer le dossier.

1. Sélectionnez l'icône Modification groupée en haut du panneau Explorateur de fichiers.

   

2. Sélectionnez les éléments à supprimer. Le nombre de fichiers sélectionnés s'affiche à côté de l'en-tête Sélectionner des fichiers.

   

   • Pour sélectionner ou désélectionner des fichiers individuels, développez leurs dossiers et cochez la case à côté de leur nom.
   • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté de leur nom.
   • Pour sélectionner une section entière de la liste de répertoires, appuyez sur Maj+clic. Cochez la case du premier élément de la plage, puis maintenez la touche Maj enfoncée et cochez la case du dernier élément de la liste. Les éléments et tous les éléments intermédiaires sont sélectionnés. Vous pouvez également cliquer sur un élément en maintenant la touche Maj enfoncée pour le sélectionner et tous les éléments situés au-dessus dans la liste des répertoires.

3. Sélectionnez l'icône de la corbeille Supprimer des éléments. L'IDE affiche alors un menu pop-up listant les éléments sélectionnés.

   

4. Confirmez les éléments à supprimer en sélectionnant Oui, Supprimer, ou revenez à la sélection en sélectionnant Annuler.

5. Sélectionnez le X dans l'en-tête Sélectionner des fichiers pour quitter le mode de modification groupée.

Déplacer des éléments dans un projet en dossiers

Pour déplacer des fichiers, glissez-déposez un fichier ou un dossier dans un autre dossier.

Il n'est pas nécessaire de développer le dossier de destination pour recevoir d'autres dossiers ou fichiers. Un dossier se développe automatiquement lorsque vous pointez dessus.

Remarque :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 au fichier. Pour en savoir plus sur l'utilisation de include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation sur le paramètre include.

Sachez également que lorsque vous modifiez le chemin d'accès d'un fichier, Git le supprime et en crée un nouveau avec le nouveau chemin d'accès. Cela signifie que l'historique Git du fichier sera vide, car Git le considère comme un nouveau fichier. Pour afficher l'historique Git du fichier avant son déplacement, utilisez votre interface Git pour accéder au fichier à son emplacement d'origine et afficher l'historique Git à partir de là. (La même logique s'applique pour un fichier renommé, puisque Git supprime effectivement le fichier et en crée un nouveau avec un nom différent.)

Déplacer des fichiers et des dossiers de manière groupée

Pour déplacer des dossiers et des fichiers de manière groupée:

1. Sélectionnez l'icône Modification groupée en haut du panneau Explorateur de fichiers.

   

2. Sélectionnez les éléments à déplacer. Le nombre de fichiers sélectionnés s'affiche à côté de l'en-tête Sélectionner des fichiers.

   

   • Pour sélectionner ou désélectionner des fichiers individuels, développez leurs dossiers et cochez la case à côté de leur nom.
   • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté de leur nom.
   • Pour sélectionner une section entière de la liste de répertoires, appuyez sur Maj+clic. Cochez la case du premier élément de la plage, puis maintenez la touche Maj enfoncée et cochez la case du dernier élément de la liste. Les éléments et tous les éléments intermédiaires sont sélectionnés. Vous pouvez également cliquer sur un élément en maintenant la touche Maj enfoncée pour le sélectionner et tous les éléments situés au-dessus dans la liste des répertoires.

3. Sélectionnez l'icône de dossier Move Items (Déplacer des éléments). L'IDE affiche alors un menu pop-up de sélection de dossiers.

   

4. Dans le menu pop-up Déplacer vers, choisissez un dossier pour les éléments sélectionnés ou sélectionnez Nouveau dossier pour en créer un. Le nom du projet affiche le chemin d'accès au dossier que vous avez sélectionné en haut de la page de menu suivante. Pour déplacer des éléments vers le répertoire racine de votre projet, sélectionnez Déplacer sans dossier sélectionné.

5. Confirmez la destination sélectionnée en sélectionnant Déplacer, créez un nouveau dossier dans le dossier sélectionné en sélectionnant Nouveau dossier, ou revenez au menu principal d'options du dossier en sélectionnant le lien correspondant au nom du projet dans le chemin d'accès au fichier.

6. Sélectionnez le X dans l'en-tête Sélectionner des fichiers pour quitter le mode de modification groupée.

Remarque :Après avoir modifié 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 au fichier. Pour en savoir plus sur l'utilisation de include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation sur le paramètre include.

Sachez également que lorsque vous modifiez le chemin d'accès d'un fichier, Git le supprime et en crée un nouveau avec le nouveau chemin d'accès. Cela signifie que l'historique Git du fichier sera vide, car Git le considère comme un nouveau fichier. Pour afficher l'historique Git du fichier avant son déplacement, utilisez votre interface Git pour accéder au fichier à son emplacement d'origine et afficher l'historique Git à partir de là. (La même logique s'applique pour un fichier renommé, puisque Git supprime effectivement le fichier et en crée un nouveau avec un nom différent.)