Gérer les fichiers et dossiers LookML

Les fichiers de projet LookML sont organisés en dossiers dans la section du navigateur de fichiers de l'IDE Looker. Cette page explique comment 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 dans un projet LookML, consultez la page de documentation Types de fichiers dans un projet LookML.

Conventions de nommage importantes pour les fichiers et les dossiers

Lorsque vous créez des fichiers et des dossiers, tenez compte des conventions de dénomination suivantes:

  • Sensibilité à la casse:LookML est sensible à la casse. Veillez à respecter les conventions de votre projet lorsque vous nommez vos dossiers. Par exemple, si vous utilisez toutes les lettres minuscules dans votre projet, vous devez nommer votre dossier views au lieu de Views. Cela est particulièrement important lorsque vous devez spécifier le chemin d'accès d'un fichier, par exemple lorsque vous incluez des fichiers. Nous recommandons généralement d'utiliser systématiquement des minuscules pour nommer des objets et des dossiers LookML.
  • Espaces et caractères spéciaux:les noms de fichiers ne doivent 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 nomme 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, envisagez d'utiliser le paramètre label ou le paramètre 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 général, vous devez prendre des précautions pour que les modifications apportées au modèle soient aussi peu invasives que possible. Si vous devez renommer un modèle ou un objet, utilisez l'outil de validation du contenu pour mettre à jour toutes les références au modèle ou à l'objet.

Créer des dossiers

Vous pouvez créer des dossiers pour différents types de fichiers (par exemple, des fichiers de vue ou des fichiers de modèle). 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.

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

  1. Sélectionnez l'option Créer un dossier dans le menu approprié :
    • Pour créer un dossier au niveau supérieur 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 Navigateur de fichiers.
    • Pour créer un sous-dossier dans un dossier existant, utilisez le menu à trois points Options de dossier du dossier existant.
  2. Saisissez un nom pour le nouveau dossier.
  3. Sélectionnez Créer.

Le nouveau dossier est ajouté au volet de navigation.

Création de fichiers

Lorsque vous générez un modèle, Looker crée automatiquement un fichier de modèle et des fichiers de vue basés sur votre base de données. Pour les projets existants, vous pouvez créer des fichiers manuellement.

Pour créer un fichier dans votre projet LookML:

  1. Sélectionnez le menu approprié:

    • Pour créer un fichier au niveau supérieur 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 Navigateur de fichiers.
    • Pour créer un fichier dans un dossier existant, utilisez le menu à trois points Options de dossier du dossier existant.

  2. Sélectionnez le type de fichier LookML que vous souhaitez créer. Sélectionnez 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:

  3. Dans la boîte de dialogue Create File (Créer un fichier), saisissez un nom pour le nouveau fichier. Consultez la section Conventions de dénomination importantes pour les fichiers et les dossiers pour connaître les limites et les consignes concernant l'attribution de noms à vos fichiers.

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

Éléments à prendre en compte lors de la création de fichiers

Tenez compte des points suivants lorsque vous créez des fichiers:

  • Nous vous recommandons d'utiliser l'IDE Looker pour ajouter des fichiers à votre projet LookML, soit en les créant dans l'IDE Looker, 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 extraire à partir de (branche de production), veillez à utiliser les conventions de dénomination appropriées et à inclure l'extension .lkml dans le nom de fichier (ou explore.lkml pour les fichiers d'exploration). Si un nom de fichier inclut des caractères non acceptés, le navigateur de fichiers de l'IDE Looker affiche le nom de fichier en rouge. Vous ne pourrez pas voir le contenu du fichier tant que vous ne l'aurez pas renommé avec des caractères acceptés. De plus, l'IDE Looker n'affiche pas du tout le fichier s'il n'a pas l'extension .lkml.
  • Une fois que vous avez créé un fichier, 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.
  • Si vous créez un fichier imbriqué dans sept dossiers ou plus, l'explorateur de fichiers ne l'affiche pas.
  • 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 du navigateur de fichiers de l'IDE Looker, et uniquement si le projet ne dispose pas déjà d'un 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 Create Locale Strings File (Créer un fichier de chaînes de paramètres régionaux) n'est disponible que depuis l'icône Add file or folder + (Ajouter un fichier ou un dossier) en haut du navigateur de fichiers de l'IDE Looker. Toutefois, une fois un fichier de chaînes de paramètres régionaux 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 profiter de la localisation de l'UI intégrée de Looker, vous devez nommer vos fichiers de chaînes à l'aide de codes de paramètres régionaux spécifiques, que vous trouverez dans la section Paramètres régionaux de la page de documentation Utilisateurs.
  • Lorsque vous créez un fichier d'exploration, il doit comporter l'extension .explore.lkml à la fin de son nom de fichier. 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 ajoute .lkml à la fin du nom de fichier si l'extension n'est pas présente. Vous devez toutefois ajouter manuellement la partie .explore de l'extension au nom de fichier. Par exemple, pour créer un fichier d'exploration appelé flights à l'aide de l'IDE Looker, vous pouvez saisir flights.explore ou flights.explore.lkml. Le fichier sera alors nommé flights.explore.lkml.

Éléments à prendre en compte lors de la création de fichiers de vue

La plupart des développeurs LookML commencent par 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 vierges et pour importer des fichiers, un développeur Looker en mode développement peut ajouter des fichiers de vue à un projet LookML de différentes manières:

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 cliquant sur 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 dans le dossier.

  2. Sélectionnez Créer une vue à partir de la table.

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

  4. Cochez les cases à gauche des tables à partir desquelles vous souhaitez créer des vues. 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 est utile si vous avez créé des fichiers de données JSON ou des fichiers LookML localement sur votre ordinateur.

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

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

Supprimer des fichiers et des dossiers

La suppression d'un dossier entraîne également la suppression de son contenu. Faites donc attention 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 les déplacer vers un autre emplacement avant de supprimer le dossier.
  • Vérifiez que le dossier ne contient aucun fichier auquel font référence les instructions include de votre projet. Pour savoir comment utiliser include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation du paramètre include.

Pour supprimer un dossier ou un fichier, sélectionnez Supprimer dans le menu à trois points Options de fichier de l'élément dans le panneau de gauche de l'IDE.

Lorsque vous supprimez un dossier, l'IDE affiche une boîte de dialogue de confirmation. La boîte de dialogue indique le nombre d'éléments inclus dans la suppression, y compris le dossier et les fichiers qu'il contient.

Si vous supprimez un fichier de modèle, le modèle n'est pas supprimé des ensembles de modèles auxquels il appartenait. Si un fichier de modèle est créé avec le même nom qu'un modèle supprimé, le nouveau modèle est inclus dans tous les ensembles de modèles qui incluaient le modèle supprimé. Cela peut entraîner 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

La suppression d'un dossier entraîne également la suppression de son contenu. Faites donc attention 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 les déplacer vers un autre emplacement avant de supprimer le dossier.
  • Vérifiez que le dossier ne contient aucun fichier auquel font référence les instructions include de votre projet. Pour savoir comment utiliser include avec les dossiers de l'IDE, consultez la section Utiliser include avec les dossiers de l'IDE de la page de documentation du paramètre include.

Pour supprimer des dossiers et des fichiers de manière groupée, procédez comme suit:

  1. Sélectionnez l'icône Modifier de manière groupée en haut du panneau File Browser (Navigateur 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, puis cochez la case à côté de leur nom de fichier.
    • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté du nom du dossier.
    • Pour sélectionner une section complète de la liste de répertoires, appuyez sur Maj+clic. Cochez la case de l'élément le plus haut de la plage, puis appuyez sur la touche Maj et cochez la case de l'élément le plus bas de la liste. Les deux éléments, ainsi que tous les éléments situés entre eux, seront sélectionnés. Vous pouvez également cliquer sur un élément tout en maintenant la touche Maj enfoncée pour le sélectionner, ainsi que tous les éléments qui le précèdent dans la liste du répertoire.

  3. Sélectionnez l'icône Corbeille Supprimer des éléments. L'IDE affiche alors une boîte de dialogue listant les éléments sélectionnés.

  4. Confirmez les éléments à supprimer en sélectionnant Oui, supprimer, ou revenez à la sélection d'éléments 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 organisé en dossiers

Pour déplacer des fichiers, faites glisser un fichier ou un dossier dans un autre dossier.

Vous n'avez pas besoin d'étendre le dossier de destination pour recevoir d'autres dossiers ou fichiers. Un dossier se développe automatiquement lorsque vous le pointez.

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. Pour savoir comment utiliser include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation du 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 autre 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 dans son emplacement d'origine et afficher l'historique Git à partir de là. (La même logique s'applique aux fichiers renommés, car Git les supprime et crée un nouveau fichier 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 Modifier de manière groupée en haut du panneau File Browser (Navigateur 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, puis cochez la case à côté de leur nom de fichier.
    • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté du nom du dossier.
    • Pour sélectionner une section complète de la liste de répertoires, appuyez sur Maj+clic. Cochez la case de l'élément le plus haut de la plage, puis appuyez sur la touche Maj et cochez la case de l'élément le plus bas de la liste. Les deux éléments, ainsi que tous les éléments situés entre eux, seront sélectionnés. Vous pouvez également cliquer sur un élément tout en maintenant la touche Maj enfoncée pour le sélectionner, ainsi que tous les fichiers précédents dans la liste du répertoire.

  3. Sélectionnez l'icône de dossier Déplacer les éléments pour sélectionner l'option. L'IDE affiche alors une boîte de dialogue de sélection de dossier.

  4. Dans la boîte de dialogue Déplacer vers, sélectionnez un dossier pour les éléments sélectionnés ou Nouveau dossier pour en créer un. Le nom du projet affiche le chemin d'accès du 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 sélectionner de dossier.

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

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

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. Pour savoir comment utiliser include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation du 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 autre 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 dans son emplacement d'origine et afficher l'historique Git à partir de là. (La même logique s'applique aux fichiers renommés, car Git les supprime et crée un fichier avec un nom différent.)