Looker IDE(集成开发环境)可让您访问 LookML 项目文件和 LookML 项目的设置。
访问 Looker IDE
如需查看 LookML 项目,您必须拥有项目中至少一个模型的 develop
权限。您可以通过 Looker 主导航菜单的开发面板访问 Looker IDE:
- 在导航面板中选择开发,以打开开发面板。
- 在 Develop 面板中,选择要访问的项目的名称。
Looker 会打开 IDE 并打开您选择的 LookML 项目。
或者,您也可以从“探索”或对象浏览器打开特定 LookML 对象并找到该 IDE。如需了解详情和其他选项,请参阅访问项目文件。
Looker IDE 的元素
Looker IDE 包含以下元素:
- “开发模式”横幅:此横幅表示您处于开发模式,在该模式下,您可以更改 LookML 文件,并预览它们将如何影响实例中的内容。您可以点击横幅中的退出开发模式链接,以进入生产模式。
- IDE 导航栏:使用导航栏可访问 Looker IDE 的不同功能。部分功能仅在开发模式下可用。从 IDE 导航栏中选择功能后,您可以再次选择导航栏项以收起功能面板。您可以通过 IDE 导航栏访问以下 IDE 功能:
- 文件浏览器:打开文件浏览器,您可以在其中访问 LookML 项目中的文件和文件夹。
- 对象浏览器:打开对象浏览器,该浏览器会显示项目中的 LookML 对象以及各个对象之间的层次结构关系。
- 查找和替换:显示查找和在项目中替换页面,您可以在其中搜索所有项目文件中的文本,然后通过批量操作替换所有实例或选定的实例。
- Git Actions:(仅在开发模式下可见)显示您项目中的 Git 分支,以及可用于项目的 Git 分支的 Git 命令。如需了解如何将 Git 与您的 LookML 项目搭配使用,请参阅使用版本控制和部署文档页面。
- Settings:(仅在开发模式下可见)显示项目的项目设置页面,您可以在其中配置项目版本控制选项、导入的项目的身份验证凭据、项目使用的 Git 分支以及 IDE 设置。
- 部署:(仅在开发模式下可见)对于设置了高级部署模式的项目,选择此选项会打开 Deployment Manager,拥有
deploy
权限的开发者可以在其中将提交内容或标记部署到其 Looker 生产环境。
- 功能面板:提供用于文件浏览器和对象浏览器的 LookML 文件和对象的导航、查找和替换函数的搜索参数、Git 操作面板可用的 Git 命令,以及用于访问项目设置面板不同设置的标签页。
- IDE 编辑器面板:LookML 文件的编辑器。在 IDE 导航栏中选择文件浏览器或对象浏览器后,系统就会显示编辑器。如需详细了解该编辑器,请参阅 Looker IDE 修改功能。
- 侧边栏选择器:点击一个选项即可打开 IDE 侧边栏功能:
- Project Health:打开 Project Health 面板。
- 快捷帮助:打开快捷帮助面板,其中包含一个用于访问元数据面板的标签页。再次点击侧边栏选择器选项以隐藏 IDE 侧边栏。
- IDE 侧边栏:显示所选的侧边栏功能:
- 项目运行状况:可让您检查未构建的 PDT 或验证 LookML。如果您的 LookML 开发者已定义数据测试来验证项目 LookML 的逻辑,您还可以在 Project Health 面板中运行数据测试。
- 快速帮助:显示 LookML 文件中适用于光标位置的 LookML 选项,并提供每个 LookML 参数的 Looker 参考文档链接。
- 元数据:提供有关光标所在位置的 LookML 对象的上下文相关信息。
- Git 按钮:根据项目的状态,该按钮显示您将项目发布到生产环境所应执行的下一项操作,例如验证 LookML、将分支推送到远程或提交。点击按钮以执行操作。如需了解该按钮可以显示和执行的命令,请参阅 Git 命令参考。
设置 Looker IDE
对于 Looker IDE,您可以自定义文本编辑器模式和换行模式,还可以收起 IDE 侧边栏,以最大化编辑器在窗口中的宽度。
文本编辑器模式
Looker IDE 支持三种文本编辑器模式:
如需更改文本编辑器模式,请按以下步骤操作:
- 在 Looker IDE 的左侧导航窗格中,选择设置图标。
- 从 IDE 设置中选择 Editor 标签页。
- 使用文本编辑器模式下拉菜单选择您的选项。
您从下拉菜单中选择某个选项后,Looker IDE 会立即更新,以便使用所选的文本编辑器模式。
换行模式
默认情况下,系统会为 Looker IDE 启用换行功能。
如需启用或停用换行,请执行以下操作:
- 从 Looker IDE 的左侧导航窗格中选择设置图标。
- 从 IDE Settings 中选择 Editor 标签页。
- 使用 Line wrap mode(换行模式)切换开关,在 IDE 中启用或停用换行。
当您更改切换开关后,相应更新便会应用于 Looker IDE。
收起 IDE 侧边栏
如果要最大化 IDE 编辑器面板的宽度,您可以收起 IDE 侧边栏:
- 如需显示或隐藏 IDE 功能面板,请使用键盘快捷键 Command-B (Mac) 或 Ctrl+B (Windows),或点击 IDE 导航栏中已选中的图标。
- 如需显示或隐藏 IDE 侧边栏,请点击侧边栏选择器中已选中的图标。
Looker IDE 修改功能
以下部分介绍了一些可以帮助您在 LookML 中进行开发的 Looker IDE 编辑功能:
自动建议
在您输入时,IDE 会向您建议可能与您输入内容的上下文相关的可能参数和值。例如,针对某个维度的 type
参数的建议将仅包含该参数的有效选项。此外,sql
参数中的字段必须带有 ${...}
标记,因此 IDE 会在建议字段时添加该语法。
自动补全功能会在可显示的地方自动显示。要将其关闭,请按键盘上的 Esc 键。如需随时查看,请按 Ctrl+Space(Windows)或 Control-Space(Mac)。
临时错误检查
在您输入内容时,IDE 会捕获语法错误。边线中的红色 X 表示语法错误,并以红色下划线标出。将光标悬停在红色 X 上,即可看到问题的简短描述。例如,如果您错误地将 avrage
而不是 average
作为测量的 type
参数的值,IDE 会显示错误 Invalid value for "type":avrage
。
执行完整的模型验证仍需使用 LookML 验证程序。某些错误(例如因缺少联接而导致的无效字段引用)需要全面了解模型,因此只有在运行 LookML 验证器运行时才会显示。
自动格式化
在开发模式下,您可以使用格式文件的键盘快捷键自动缩进 LookML 文件。缩进表示参数和子参数的层次结构,有助于您更轻松地阅读和理解 LookML。
折叠式
文件中每个顶级 LookML 参数开头的边线中会显示一个小箭头。选择此箭头可折叠或展开 LookML 的相应部分,以便您可以仅关注特定部分。
LookML 文件的 See file actions 菜单还提供 Fold LookML 和 Unfold LookML 选项,用于将所有 LookML 部分展开或收起到当前文件中的顶级参数。
您还可以使用键盘快捷键来折叠和展开 LookML。
评论
您可以向 LookML 添加注释,以提高其可读性。如需添加一条注释,请使用 #
字符:
dimension: name {
sql: ${TABLE}.name ;; # This is the customer's full name
}
您可以使用键盘快捷键注释掉整个代码块,具体步骤如下:
- 选择要注释掉的行。
- 按 Command + /(Mac)或 Ctrl + /(Windows)。
IDE 会向您选择的每行添加 #
字符。
注释掉 SQL 块
如果要注释掉完全位于 SQL 代码块内的行,请手动添加 SQL 注释表示法。
使用 SQL 注释块时,注释掉的部分仍会被解释为 LookML 代码。因此,您会在 LookML 生成的 SQL 中看到注释,但这些注释不会影响查询结果。
查看添加、更改和删除的内容
在 LookML IDE 中,当您处于开发模式且有未提交的更改时,系统始终会显示多个指标。
- 文件名称会在窗口左侧显示一个蓝点,表示文件是新建、更改或重命名的。
- 当您打开新文件或已更改的文件时,文件内的行号会以绿色突出显示,表示新增或更改的行,水平红线表示已移除的行。
IDE 状态持久性
在刷新和登录之后,Looker IDE 会保持用户的 IDE 状态,包括:
- IDE 导航栏中的选定项(例如文件浏览器、Git 操作、对象浏览器或项目设置)
- 在文件浏览器中打开 LookML 文件
- 文件浏览器和对象浏览器中的项处于展开或收起状态
- IDE 右边栏中的选定项(例如“快捷帮助”面板、“元数据”面板和“项目运行状况”面板)
- 编辑器的换行模式
如需将 IDE 重置为默认设置,请在 Looker IDE 的左侧导航窗格中选择设置图标,从 IDE 设置部分中选择编辑器标签页,然后点击重置 IDE 布局按钮。在您继续打开文件和进行选择时,IDE 将再次保留您的状态。
跳转到对象或文件
在 Looker IDE 中,您可以使用跳转到对象或文件功能进行快速搜索,以直接导航到 LookML 对象和项目文件。在文件浏览器或对象浏览器中点击跳转到对象或文件图标,或者使用键盘快捷键 Command-J (Mac) 或 Ctrl+J (Windows)。
如需了解详情,请参阅访问 LookML 项目文件文档页面。
“快捷帮助”面板
选择快捷帮助图标可打开快捷帮助面板,该面板会针对代码中的当前位置提供说明和选项。在边栏中选择一个参数名称,以打开该参数的 Looker 文档页面。
文件和文件夹的选项菜单
在文件浏览器中,左侧面板中的每个文件或文件夹都有一个菜单,显示该项可执行的操作。将光标悬停在相应文件和文件夹上,然后选择三点状文件夹选项菜单(适用于文件夹)或文件选项菜单(适用于文件)以打开菜单。如果某项的名称较长或嵌套在多个文件夹中,您可以在文件浏览器面板中侧向滚动来访问该菜单。
在选项菜单中,您可以使用文件浏览器创建文件夹和文件、上传文件,以及删除和移动文件和文件夹。如需了解详情,请参阅管理 LookML 文件和文件夹文档页面。
使用文件夹整理 LookML 文件时,您需要先提交更改并将更改部署到生产环境,然后其他 Looker 开发者才能看到这些更改。这就像您对 LookML 项目所做的任何更改一样。
查找和替换项目中的文本
Looker IDE 提供了查找和替换功能,您可以使用该功能在所有项目文件中搜索文本,然后通过批量操作替换所有实例或所选实例。
如需使用 Looker IDE 的查找功能,请按以下步骤操作:
- 前往 IDE 中的搜索面板。
- 在查找字段中输入一个字词。
- (可选)您可以选择区分大小写,以便仅搜索与您在查找字段中输入的大小写相匹配的实例;也可以选择正则表达式来执行正则表达式搜索。
- 选择查找。
- (可选)您可以选择文件名,以在 IDE 中打开该文件。
如果您处于开发模式,则还会看到替换为字段。如需替换项目中的文本,请按以下步骤操作:
在替换为字段中输入替换文本。(可选)如果您想删除查找字段中的文本(而非进行替换),可以将替换为字段留空。
选择选择和替换,预览您的文本在项目中的替换方式。
结果会突出显示项目中所有可替换的实例。您可以使用以下选项自定义要替换的实例:
- 使用结果摘要旁边的复选框可选择或取消选择整个项目中的所有实例。
- 使用单个实例旁边的复选框可选择或取消选择该实例。
选择替换所选内容按钮,将替换内容应用于您选择的实例。IDE 将显示所做更改。
创建和测试新字段
作为修改 LookML 的示例,我们将添加多个字段,然后对其进行测试。
创建维度
首先,我们将向 users
视图添加一个新维度,用于确定用户是来自加利福尼亚州还是纽约。该维度将为 type: yesno
,这意味着如果用户来自加利福尼亚州或纽约,它会返回 Yes,否则会返回 No。
新维度的 LookML 如下所示:
dimension: from_ca_or_ny {
type: yesno
sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}
将此维度添加到 user
视图文件,然后点击文件中的 Save Changes 按钮。
如需详细了解 ${TABLE}.state
,请参阅替换运算符。
创建测量
接下来,我们将在 user
视图中添加一项新度量,用于计算用户的平均年龄。此计量单位为“type: average
”,汇总范围为 age
列。
此新测量的 LookML 如下所示:
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
将此测量添加到 user
视图文件,然后点击文件中的 Save Changes 按钮。
测试“探索”中的字段
您可以通过查询来测试新维度和进行衡量。保存更改后,这些字段将显示在“探索”的字段选择器中。使用视图文件名旁边的查看文件操作下拉菜单可访问当前视图的“探索”。查看文件操作下拉菜单会列出基于该视图的所有探索,包括该视图联接到的探索。例如,如需访问名为 users
的视图的“探索”功能,您可以从查看文件操作下拉菜单中选择探索用户选项。
在用户探索中,您可以选择新字段以将其添加到查询中。例如,您可以创建一个包含以下两个新字段的查询:显示加利福尼亚州或纽约用户的平均年龄,以及非加利福尼亚州或纽约用户的平均年龄: