管理 LookML 文件和文件夹

LookML 项目文件会在 Looker IDE 的文件浏览器部分整理到文件夹中。本页介绍了如何在 LookML 项目中创建和管理文件夹和文件。

如需了解 LookML 项目中每种类型文件的结构和用途,请参阅 LookML 项目中的文件类型文档页面。

重要文件和文件夹命名惯例

创建文件和文件夹时,请遵循以下命名惯例:

  • 区分大小写LookML 区分大小写。为文件夹命名时,请务必遵循项目的惯例。例如,如果您的惯例是在项目中使用全部小写字母,则应将文件夹命名为 views,而不是 Views。这在需要指定文件路径时尤为重要,例如在添加文件时。通常,在为 LookML 对象和文件夹命名时,最好始终使用小写字母。
  • 空格和特殊字符:文件名不得包含空格或以下任何字符:/ ? * : | " < > %
  • 文件扩展名使用 Looker IDE 创建 LookML 文件时,如果您未手动添加扩展名,Looker 会自动在文件名末尾添加 .lkml 扩展名。例如,如果您输入文件名 flights_data_tests,Looker 会将文件命名为 flights_data_tests.lkml
  • 更改 LookML 对象的显示名称:如果您想更改模型或 LookML 对象的显示名称,不妨考虑使用 label 参数或 alias 参数,而不是重命名文件或对象。labelalias 参数会更改显示名称,同时保留用于电子邮件或其他系统的基础网址。一般来说,您应采取预防措施,尽可能以非侵入性的方式更改模型。如果您确实需要重命名模型或对象,请使用内容验证器更新对该模型或对象的所有引用。

创建文件夹

您可以为不同类型的文件(例如视图文件模型文件)创建文件夹。您甚至可以创建子文件夹,如果您想include视图的子集,这非常有用。

要创建文件夹,请执行以下操作:

  1. 从相应的菜单中选择创建文件夹选项:
    • 如需在目录结构的顶层创建新文件夹,请使用添加文件或文件夹菜单,您可以通过选择文件浏览器面板顶部的 +(加号)图标来访问该菜单。
    • 如需在现有文件夹下创建新的子文件夹,请使用现有文件夹的三点状图标 Folder Options(文件夹选项)菜单。
  2. 输入新文件夹的名称。
  3. 选择创建

新文件夹会添加到导航窗格中。

创建文件

当您生成模型时,Looker 会自动创建基于您数据库的模型文件和视图文件。对于现有项目,您可以手动创建新文件。

如需在 LookML 项目中创建新文件,请执行以下操作:

  1. 选择相应的菜单:

    • 如需在目录结构的顶层创建新文件,请使用添加文件或文件夹菜单,您可以通过选择文件浏览器面板顶部的 +(加号)图标来访问该菜单。
    • 如需在现有文件夹下创建新文件,请使用现有文件夹的三点状 Folder Options(文件夹选项)菜单。
  2. 选择要创建的 LookML 文件类型。请选择以下列表中的链接,详细了解每种类型的文件。您可以创建以下类型的文件:

  3. Create File 对话框中,为新文件输入一个名称。如需了解文件命名的限制和准则,请参阅重要文件和文件夹命名惯例部分。

  4. 选择创建。新文件将显示在您创建它的位置。如有必要,您可以将其移至其他文件夹

创建文件的注意事项

创建文件时,请注意以下注意事项:

  • 建议您使用 Looker IDE 将文件添加到 LookML 项目,方法是在 Looker IDE 中创建文件在 Looker IDE 中上传文件。如果您改为在 Looker IDE 之外创建文件,然后使用 Looker IDE 从(生产分支)拉取,请务必使用正确的命名惯例,并在文件名中添加 .lkml 扩展名(对于探索文件,则为 explore.lkml)。如果文件名包含不受支持的字符,Looker IDE 文件浏览器会以红色显示文件名,并且您将无法看到文件内容,除非您使用受支持的字符重命名文件。此外,如果文件没有 .lkml 扩展名,Looker IDE 将完全不显示该文件。
  • 创建文件后,如果您想在项目的其他 LookML 文件中引用该文件中的元素,请务必使用 include 参数。如需了解详情,请参阅 include 参数文档页面。
  • 如果您创建的文件嵌套在 7 个或更多文件夹下,文件资源管理器将不会显示该文件。
  • 只有在项目中尚无清单文件的情况下,您才能创建项目清单文件,方法是选择 +(加号)图标以打开 Looker IDE 中文件浏览器顶部的添加文件或文件夹菜单。这是因为一个项目只能有一个清单文件,并且清单文件必须位于项目目录结构的根级别。
  • 创建语言区域字符串文件选项仅通过 Looker IDE 中文件浏览器顶部的添加文件或文件夹 +(加号)图标提供。不过,语言区域字符串文件创建(或上传)后,您可以将文件移至文件夹。如果您要创建语言区域字符串文件以本地化模型,同时还想利用 Looker 内置界面本地化功能,则必须使用特定语言区域代码为字符串文件命名,这些代码可在用户文档页面的语言区域部分找到。
  • 创建探索文件时,文件名末尾必须带有 .explore.lkml 扩展名。如果您要上传文件,则必须使用完整的 .explore.lkml 扩展名。如果您使用 Generic LookML files 选项通过 Looker IDE 创建文件,如果文件名中没有扩展名,Looker 会将 .lkml 添加到文件名末尾,但您仍然必须手动将扩展名的 .explore 部分添加到文件名中。例如,如需使用 Looker IDE 创建名为 flights 的探索文件,您可以输入 flights.exploreflights.explore.lkml,文件将命名为 flights.explore.lkml

创建视图文件的注意事项

大多数 LookML 开发者都是从一个或多个视图文件开始的,这些文件是在从数据库中一组表生成 LookML 项目时自动创建的。不过,除了本页介绍的创建空白视图文件上传文件的方法之外,开发模式下的 Looker 开发者还可以通过多种方式将视图文件添加到 LookML 项目中:

如需使用新视图,请使用 explore 参数将其添加到模型文件中,或使用 join 参数将其联接到模型文件中的现有探索。

从现有数据库表添加新视图

您可以在开发模式下根据现有数据库表创建视图文件。

  1. 在项目中,通过选择 Looker IDE 中项目文件列表顶部的 +(加号)来选择添加文件或文件夹菜单,或者您也可以选择文件夹的菜单以在文件夹中创建文件

  2. 选择基于表创建视图

  3. Looker 会显示与您的某个连接关联的表的列表。如需更改关联,请使用左上角的关联下拉菜单。

  4. 选中表名称左侧的复选框,选择要用于创建视图的任意表。您可以收起和展开此列表中的数据库或架构,以访问所有可用表。

  5. 前往页面底部,然后选择创建视图

  6. Looker 会为所有表格列生成包含 LookML 的视图。

上传文件

您还可以通过计算机将文件上传到项目中。如果您在计算机上本地创建了 JSON 数据文件或 LookML 文件,这将非常有用。

如需将文件上传到项目,请使用 Looker IDE 中的拖放功能,按照以下步骤操作:

  1. 前往您的项目文件
  2. 将文件从计算机拖动到 Looker IDE 中。该文件将显示在目录结构的根目录中。
  3. 文件上传完毕后,将该内容移至其他文件夹

删除文件和文件夹

删除文件夹的同时也会删除其内容,因此请谨慎删除文件夹。在删除文件夹之前,请按以下步骤操作:

  • 在删除文件夹之前,请先确认您要删除文件夹中的文件,或将文件移至其他位置
  • 验证该文件夹不包含项目中的 include 语句中引用的任何文件。如需了解如何将 include 与 IDE 文件夹搭配使用,请参阅 include 参数文档页面的include 与 IDE 文件夹搭配使用部分。

如需删除文件夹或文件,请从 IDE 左侧面板中相应项目的三点状 File Options(文件选项)菜单中选择 Delete(删除)。

删除文件夹时,IDE 会显示一个确认对话框。该对话框会指明要删除的项数量,其中包括文件夹和文件夹内的所有文件。

如果您删除模型文件,该模型不会从其所属的任何模型集中移除。如果创建的新模型文件与已删除的模型同名,则新模型会包含在包含已删除模型的所有模型集中。这可能会导致向新模型文件授予不必要的访问权限。Looker 管理员可以修改模型集并移除已删除的模型,以避免此问题。

批量删除文件和文件夹

删除文件夹的同时也会删除其内容,因此请谨慎删除文件夹。在删除文件夹之前,请按以下步骤操作:

  • 在删除文件夹之前,请先确认您要删除文件夹中的文件,或将文件移至其他位置
  • 验证该文件夹不包含项目中的 include 语句中引用的任何文件。如需了解如何将 include 与 IDE 文件夹搭配使用,请参阅 include 参数文档页面的include 与 IDE 文件夹搭配使用部分。

如需批量删除文件夹和文件,请按以下步骤操作:

  1. 选择文件浏览器面板顶部的批量修改图标。

  2. 选择要删除的内容。所选文件的数量会显示在选择文件标题旁边。

    • 如需选择或取消选择个别文件,请展开相应文件夹,然后选中文件名旁边的复选框。
    • 如需选择或取消选择整个文件夹及其内容,请选中文件夹名称旁边的复选框。
    • 如需选择目录列表的整个部分,请按住 Shift 键并点击。选中范围中顶部项目对应的复选框,然后按住 Shift 键并选中列表中最后一个项目对应的复选框。系统会同时选中这两个项目以及它们之间的所有项目。您还可以按住 Shift 键点击某个项目,以选择该项目以及目录列表中该项目前面的所有项目。
  3. 选择删除商品回收站图标。然后,IDE 会显示一个列出所选项目的对话框。

  4. 选择是,删除确认要删除的项目,或选择取消返回到项目选择界面。

  5. 选择选择文件标题中的 X 以退出批量修改模式。

在文件夹型项目中移动项目

如要移动文件,请将文件或文件夹拖动到另一个文件夹中。

目标文件夹无需展开即可接收其他文件夹或文件。当您将鼠标悬停在文件夹上时,该文件夹会自动展开。

更改文件的路径时,请务必更新项目中的所有 include 语句,使其与新路径相匹配。如需了解如何将 include 与 IDE 文件夹搭配使用,请参阅 include 参数文档页面的include 与 IDE 文件夹搭配使用部分。

另请注意,当您更改文件的路径时,Git 会有效删除该文件,并使用新路径创建一个新文件。这意味着,该文件的 Git 历史记录将为空,因为 Git 会将其视为新文件。如需查看文件在移动之前的 Git 历史记录,请使用 Git 界面前往文件的原始位置,然后在该位置查看 Git 历史记录。(对于重命名的文件,也适用相同的逻辑,因为 Git 会有效地删除该文件并创建一个具有不同名称的新文件。)

批量移动文件和文件夹

如需批量移动文件夹和文件,请执行以下操作:

  1. 选择文件浏览器面板顶部的批量修改图标。

  2. 选择要移动的内容。所选文件的数量会显示在选择文件标题旁边。

    • 如需选择或取消选择个别文件,请展开相应文件夹,然后选中文件名旁边的复选框。
    • 如需选择或取消选择整个文件夹及其内容,请选中文件夹名称旁边的复选框。
    • 如需选择目录列表的整个部分,请按住 Shift 键并点击。选中范围中顶部项目对应的复选框,然后按住 Shift 键并选中列表中最后一个项目对应的复选框。系统会同时选中这两个项目以及它们之间的所有项目。您还可以按住 Shift 键点击某个项目,以选择该项目以及目录列表中的所有前置文件
  3. 选择移动内容文件夹图标以选择选项。然后,IDE 会显示文件夹选择对话框。

  4. 移至对话框中,为所选内容选择一个文件夹,或选择新建文件夹以创建新文件夹。项目名称将显示在下一个菜单页面顶部,并显示您选择的文件夹的路径。如需将项目移至项目的根目录,请在不选择任何文件夹的情况下选择移动

  5. 选择移动确认所选目标位置,选择新建文件夹在所选文件夹中创建新文件夹,或选择路径中的项目名称链接返回到主文件夹选项菜单。

  6. 选择选择文件标题中的 X 以退出批量修改模式。

更改文件的路径后,请务必更新项目中的所有 include 语句,使其与新路径相匹配。如需了解如何将 include 与 IDE 文件夹搭配使用,请参阅 include 参数文档页面的include 与 IDE 文件夹搭配使用部分。

另请注意,当您更改文件的路径时,Git 会有效删除该文件,并使用新路径创建一个新文件。这意味着,该文件的 Git 历史记录将为空,因为 Git 会将其视为新文件。如需查看文件在移动之前的 Git 历史记录,请使用 Git 界面前往文件的原始位置,然后在该位置查看 Git 历史记录。(对于重命名的文件,也适用相同的逻辑,因为 Git 会有效删除文件并创建一个具有不同名称的新文件。)