Looker IDE(集成开发环境)可让您访问 LookML 项目文件和 LookML 项目的设置。
访问 Looker IDE
如需查看 LookML 项目,您必须对项目中至少一个模型拥有 develop
权限。您可以通过 Looker 主导航菜单的 Develop 面板访问 Looker IDE:
- 在导航面板中选择开发,以打开开发面板。
- 在 Develop 面板中,选择要访问的项目的名称。
Looker 会打开 IDE 并定位到您选择的 LookML 项目。
或者,您也可以从“探索”或对象浏览器打开 IDE 以访问特定 LookML 对象。如需了解详情和其他选项,请参阅访问项目文件。
Looker IDE 的元素
Looker IDE 包含以下元素:
- “开发模式”横幅:此横幅表示您处于开发模式,您可以在该模式下更改 LookML 文件,并预览这些更改对实例中内容的影响。您可以点击横幅中的退出开发模式链接,进入生产模式。
- IDE 导航栏:使用导航栏可访问 Looker IDE 的不同功能。部分功能仅在开发模式下可用。从 IDE 导航栏中选择某项功能后,您可以再次选择该导航栏项以收起功能面板。IDE 导航栏可让您访问以下 IDE 功能:
- 文件浏览器:打开文件浏览器,以便您访问 LookML 项目中的文件和文件夹。
- 对象浏览器:打开对象浏览器,该浏览器会显示项目中的 LookML 对象,并显示这些对象之间的层次关系。
- 查找和替换:显示在项目中查找和替换页面,您可以使用该页面在所有项目文件中搜索文本,然后通过批量操作替换所有实例或所选实例。
- Git 操作:(仅在开发模式下显示)显示项目的 Git 分支,并显示可用于项目 Git 分支的 Git 命令。如需了解如何将 Git 与 LookML 项目搭配使用,请参阅使用版本控制和部署文档页面。
- 设置:(仅在开发模式下显示)显示项目的项目设置页面,您可以在其中配置项目版本控制选项、导入的项目的身份验证凭据、项目使用的 Git 分支以及 IDE 设置。
- 部署:(仅在开发模式下显示)对于使用高级部署模式设置的项目,此按钮会打开 Deployment Manager,具有
deploy
权限的开发者可以在其中将提交或标记部署到其 Looker 生产环境。
- 功能面板:提供用于文件浏览器和对象浏览器的 LookML 文件和对象导航,用于查找和替换功能的搜索参数,用于 Git 操作面板的可用 Git 命令,以及用于访问项目设置面板的不同设置的标签页。
- IDE 编辑器面板:LookML 文件的编辑器。在 IDE 导航栏中选择 File Browser 或 Object Browser 时,系统会显示该编辑器。如需详细了解该编辑器,请参阅 Looker IDE 编辑功能。
- 侧边栏选择器:点击一个选项即可打开 IDE 侧边栏功能:
- Project Health:打开 Project Health 面板。
- 快捷帮助:打开快捷帮助面板,其中包含一个标签页,用于访问元数据面板。
- 帮我编写代码:(适用于已启用 Gemini 的 Looker (Google Cloud Core) 实例)打开帮我编写代码面板。 再次点击侧边栏选择器选项以隐藏 IDE 侧边栏。
- IDE 侧边栏:显示所选的侧边栏功能:
- 项目运行状况:可让您检查是否有未构建的 PDT 或验证 LookML。如果您的 LookML 开发者定义了数据测试来验证项目的 LookML 逻辑,您还可以从项目健康状况面板运行数据测试。
- 快捷帮助:显示适用于光标在 LookML 文件中的位置的 LookML 选项,并提供指向每个 LookML 参数的 Looker 参考文档的链接。
- 元数据:提供与光标位置的 LookML 对象相关的上下文信息。
- 帮我编码:(适用于已启用 Gemini 的 Looker [Google Cloud Core] 实例):可让您在 Looker 中使用 Gemini 来帮助编写 LookML。
- Git 按钮:该按钮会显示您为将项目发布到生产环境而应执行的后续操作,具体取决于项目的状态,例如验证 LookML、将分支推送到远程或提交。点击相应按钮即可执行操作。如需了解该按钮可以显示和执行的可能命令,请参阅 Git 命令参考。
设置 Looker IDE
您可以通过以下方式自定义 Looker IDE:
- 选择文本编辑器模式
- 启用或停用换行模式
- 调整 IDE 侧边栏的大小
- 收起 IDE 侧边面板,以最大限度地扩大窗口中编辑器的宽度
文本编辑器模式
Looker IDE 支持三种文本编辑器模式:
如需更改文本编辑器模式,请按以下步骤操作:
- 在 Looker IDE 的左侧导航窗格中,选择设置图标。
- 从 IDE 设置中选择 Editor 标签页。
- 使用文本编辑器模式下拉菜单选择所需选项。
从下拉菜单中选择一个选项后,Looker IDE 会立即更新为使用所选的文本编辑器模式。
换行模式
默认情况下,Looker IDE 支持行换行。
如需启用或停用自动换行功能,请执行以下操作:
- 在 Looker IDE 的左侧导航窗格中,选择设置图标。
- 从 IDE 设置中选择 Editor 标签页。
- 使用换行模式切换开关可在 IDE 中启用或停用换行。
更改切换开关后,更新会应用于 Looker IDE。
调整 IDE 侧边栏的大小
您可以更改 IDE 中各个面板的宽度,包括功能面板(包含 File Browser、Object Browser 和 Git Actions 面板)和侧边栏(包含 Project Health、Quick Help 和 Metadata 面板)。
如需调整 IDE 面板的大小,请将光标悬停在面板边框上,然后拖动以调整面板的大小:
如果您使用的是开发模式,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 文件的查看文件操作菜单还提供了收起 LookML 和展开 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 状态包含以下内容:
- IDE 导航栏中已选项(例如文件浏览器、Git 操作、对象浏览器或项目设置)
- 打开文件浏览器中显示的 LookML 文件
- 文件浏览器和对象浏览器中项的展开或收起状态
- IDE 侧边面板的宽度
- IDE 右侧边栏中已选项(例如“快捷帮助”面板、“元数据”面板和“项目健康状况”面板)
- 编辑器的换行模式
如需将 IDE 重置为默认设置,请在 Looker IDE 的左侧导航窗格中选择 Settings 图标,然后从 IDE Settings 部分中选择 Editor 标签页,最后点击 Reset IDE Layout 按钮。当您继续打开文件并进行选择时,IDE 会再次保留您的状态。
跳转到对象或文件
在 Looker IDE 中,您可以使用跳转到对象或文件功能进行快速搜索,以便直接前往 LookML 对象和项目文件。点击文件浏览器或对象浏览器中的跳转到对象或文件图标,或使用键盘快捷键 Command-J (Mac) 或 Ctrl+J (Windows)。
如需了解详情,请参阅访问 LookML 项目文件文档页面。
“快捷帮助”面板
如需打开快捷帮助面板,请从文件浏览器或对象浏览器中选择快捷帮助图标:
快捷帮助面板会针对代码中的当前位置提供说明和选项:
- 在 IDE 编辑器面板中,您可以点击 LookML 文件中的字段和参数,快捷帮助面板将显示该 LookML 元素支持的选项和子参数。
- 在快捷帮助面板中,您可以点击参数名称,以打开该参数的 Looker 文档页面。
“帮我写代码”面板
如果您有Looker (Google Cloud Core) 实例且已启用 Gemini,则可以使用 Looker 中的 Gemini 来帮助编写 LookML:
如需了解详情,请参阅在 Looker 中借助 Gemini 编写 LookML 文档。
文件和文件夹的选项菜单
在文件浏览器中,左侧面板中的每个文件或文件夹都有一个菜单,用于显示相应项的可用操作。将光标悬停在文件和文件夹上,然后选择三点状 Folder Options 菜单(对于文件夹)或 File Options 菜单(对于文件)以打开菜单。对于名称较长或嵌套在多个文件夹中的项,您可以在文件浏览器面板中横向滚动以访问菜单。
您可以通过选项菜单创建文件夹和文件、上传文件,以及使用文件浏览器删除和移动文件和文件夹。如需了解详情,请参阅管理 LookML 文件和文件夹文档页面。
使用文件夹整理 LookML 文件后,您需要提交更改并将其部署到生产环境,其他 Looker 开发者才能看到这些更改。这就像您对 LookML 项目所做的任何更改一样。
在项目中查找和替换文本
Looker IDE 提供了查找和替换功能,您可以使用该功能在所有项目文件中搜索文本,然后通过批量操作替换所有实例或所选实例。
如需使用 Looker IDE 查找函数,请按以下步骤操作:
- 前往 IDE 中的搜索面板。
- 在查找字段中输入字词。
- (可选)您可以选择区分大小写,以便仅搜索与您在查找字段中输入的大小写匹配的实例;也可以选择 RegEX 以执行正则表达式搜索。
- 选择查找。
- (可选)您可以选择文件的名称,以在 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
视图文件,然后点击该文件中的保存更改按钮。
如需详细了解 ${TABLE}.state
,请参阅替换运算符。
创建测量
接下来,我们将向 user
视图添加一个新衡量指标,用于计算用户的平均年龄。此测量将为 type: average
,并对 age
列进行汇总。
此新衡量标准的 LookML 如下所示:
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
将此测量添加到 user
视图文件中,然后点击该文件中的保存更改按钮。
测试“探索”中的字段
您可以通过查询新维度来测试和衡量它们。保存更改后,这些字段将显示在“探索”中的字段选择器中。使用视图文件名旁边的查看文件操作下拉菜单,访问当前视图的“探索”部分。查看文件操作下拉菜单会列出基于该视图的所有探索,包括该视图联接到的探索。例如,如需访问名为 users
的视图的“探索”功能,您可以从查看文件操作下拉菜单中选择探索用户选项。
在用户探索中,您可以选择新字段将其添加到查询中。例如,您可以创建一个包含这两个新字段的查询,以显示来自加利福尼亚州或纽约的用户的平均年龄,以及不来自这两个州的用户的平均年龄: