Looker 数据字典与数据字典块不同。
要充分利用 Looker 数据字典扩展程序的完整功能,管理员应将 Looker 数据字典应用更新至 2.0.0 版或更高版本。
Looker 数据字典是一个扩展程序(一种使用 Looker 组件构建的 Web 应用),它使用 Looker 扩展程序框架开发并通过 Looker Marketplace 进行部署。
Looker 数据字典扩展提供了一个专用的集中式界面,您可以在该界面中搜索所有 Looker 字段和说明。使用此扩展程序可以:
- 提供包含所有指标和说明的可搜索目录,以便用户确定合适的维度或衡量指标以进行分析
- 让外部利益相关方可轻松确定并定位独特的指标
- 审核 LookML 模型,以评估是否遵循一致的命名规范、是否存在多余的字段,或者字段是否带有说明注解
- 添加并分享关于特定字段的备注(如果您的 Looker 数据字典应用适用于 2.0.0 或更高版本)
要访问和使用 Looker 数据字典,Looker 管理员必须:
- 启用相应的功能。
- 安装 Looker 数据字典扩展程序。
- 授予访问 Looker 数据字典的权限。
在向用户提供此扩展程序后,您可以执行以下操作:
安装 Looker 数据字典
在从 Marketplace 安装 Looker 数据字典之前,Looker 管理员必须启用以下功能:
- Marketplace:访问 Looker Marketplace(默认处于启用状态)
- 扩展程序框架:用于部署使用 Looker 扩展程序框架开发的扩展程序(默认处于启用状态)
若要安装 Marketplace 中的应用和工具(例如扩展程序),您必须拥有 develop
、manage_models
和 deploy
权限。
如需了解如何从 Looker Marketplace 安装工具,请参阅使用 Looker Marketplace 文档。您可以通过以下方法确保始终使用最新版本的数据字典:前往 Looker Marketplace,选择管理,然后选择扩展程序旁边的更新按钮。
授予对 Looker 数据字典的访问权限
安装 Looker 数据字典后,系统会自动将模型“data-dictionary
”添加到新模型集和修改模型集页面(可通过管理面板的角色页面访问)的可用模型列表中。
Looker 管理员必须授予用户 explore
或 develop
权限,以访问 data-dictionary
模型以及他们在数据字典中需要探索的任何模型。请参阅为 Looker 扩展程序设置权限文档页面,了解如何向用户授予访问和使用扩展程序的权限。
授予与字段注释互动的权限
借助字段注释,用户可以向字段定义添加上下文,而无需更新任何 LookML。默认情况下,凡是有权访问数据字典扩展程序的用户,都能查看所有评论,以及添加、编辑和删除自己的评论。
如果需要,Looker 管理员可以在管理面板的群组页面上创建特定用户群组,并将其分配给这些群组,从而管理用户与字段评论功能互动的方式。请参阅群组文档页面,详细了解如何将用户分配到群组。
Looker 管理员必须使用预定义的名称创建这些群组,如下所示。
必须使用下表中显示的预定义名称创建用户群组。该表格还会显示用户为每个群组分配的预定义权限。
如果用户不属于上述任何群组,则默认为 writer
。如果用户被分配到多个群组(不包括 marketplace_data_dictionary_comments_disabled
),系统会优先授予其较高权限。
对评论组的更改(例如,添加或移除用户)(通过管理面板中的群组页面进行)会在硬更新数据字典页面或用户选择其他选项,然后返回到数据字典页面后生效。
前往 Looker 数据字典
您可以从左侧边栏的已安装应用和扩展程序列表中导航到数据字典。
使用 Looker 数据字典查看模型元数据
在 Looker 数据字典中,对模型具有 explore
权限的用户可以选择此模型并查看其元数据,包括其探索和每个探索的字段列表(按视图分组)。Looker 数据字典会在左侧边栏中显示所选模型的“探索”,并在页面主要部分显示所选“探索”的视图和字段。
用户可以通过选择 < 图标来收起边栏。
Looker 数据字典显示:
- 所选模型的名称
- 所选模型包含的探索列表
- 所选“探索”
- 用于过滤探索中的字段的文本字段
- 使用快速过滤器,根据所选特征缩小显示字段的范围
- 视图的名称
- 每个字段的元数据。通过选择查看选项按钮,选择显示哪些元数据。在字段性能分析器中查看字段的整组元数据。
- 包含给定视图中各个字段的元数据的行
- 在 Looker 界面中导航到探索
选择模型和探索
选择模型下拉菜单会列出用户具有 explore
权限的所有模型。从选择模型下拉菜单中选择模型时,左侧边栏中会显示该模型的“探索”列表。
您也可以在搜索模型搜索框中输入所选模型,以搜索特定的“探索”。“探索”列表会进行过滤,使系统仅显示与您的搜索字词匹配的结果。
选择“探索”的名称可查看其字段(按视图分组),显示在页面的主要部分。
您还可以选择右上角的探索按钮,直接前往 Looker 中的探索页面。
在“探索”中过滤字段
您可在在此“探索”中过滤字段框中输入文字来过滤所显示的字段,使其与字段的字段标签或说明列表匹配。
您还可以选择过滤特定的元数据属性,例如字段是否:
查看字段元数据
Looker 数据字典显示探索字段的元数据,按视图分组:
- 字段标签:根据字段的
label
参数指定的字段名称 - 类别:以维度或衡量方式表示的字段类别
- 说明:字段的描述,取决于字段的
description
参数 - LookML 名称:采用
view_name.field_name
语法的字段名称 - 类型:根据字段的
type
参数,将字段类型设置为字符串、日期、日期、邮政编码、计数、求和、平均、列表或未引用 - SQL:引用该字段的 SQL 表达式
- 标记:与该字段相关联的 LookML 标记
自定义显示的元数据
您可以为每个字段指定显示哪些元数据,方法是点击右上角的查看选项按钮,然后勾选或取消选中您要查看的元数据所对应的复选框。
使用字段注释
如果实例已有“市场”,管理员应确保“数据字典”扩展程序版本为 2.0.0 或更高版本,才能使用字段级注释。
LookML 开发者经常会在字段级 description
参数中添加与模型字段相关的其他信息或说明。但是,对所有用户来说,这些描述并不总是有意义或有用。通过字段级评论,用户可以将上下文添加到特定字段。这些注释可供其他用户查看,但不会影响模型的底层 LookML。
管理员必须在管理面板的群组页面上将评论添加到特定群组,才能授权相应用户与评论互动。默认情况下,所有有权访问数据字典扩展程序的用户都可以查看所有评论,以及添加、和删除自己的评论。
添加字段备注
要在字段中添加评论,请执行以下操作:
- 将鼠标悬停在字段行上,系统会显示 + 图标(如果该字段不存在评论)或记事本图标(如果字段包含现有评论)。点击该图标以打开字段性能分析器面板的评论标签页。
- 点击添加评论按钮。
- 输入评论内容,然后选择评论按钮保存您的条目。点击 Cancel 关闭字段性能分析器。选择并拖动右下角,展开评论框。
评论添加后,会显示在字段性能分析器的评论标签页中,并可供其他用户查看。
查看字段注释
当某个字段包含注释时,系统会显示一个记事本图标,显示该字段中存在的评论数量。点击记事本图标可查看字段性能分析器的 Comment(评论)标签页中列出的字段注释。
评论标签页的括号中也会显示该字段的评论数量。每个评论条目都会显示以下信息:
- 评论者的姓名
- 添加评论时显示的时间戳
- 评论预览
修改或删除字段注释
要修改或删除您自己的字段注释,请执行以下操作:
- 选择该字段的记事本图标。
- 在评论标签页上,找到要修改的评论或将鼠标悬停在该评论上。
- 点击三点状菜单,然后选择修改评论以修改评论,或选择删除评论以删除评论。如果您要删除评论,请确认意图。
- 如果您正在修改评论,修改后请选择保存。
分享字段评论
每个字段的评论标签页的网址都是独一无二的,您可以复制该网址并分享给 Looker 数据字典中有权访问该模型的其他用户。
使用字段性能分析器
点击特定字段行会在页面右侧打开字段性能分析器面板,其中显示了字段的整组元数据、用于预览数值维度值的选项,以及前往 Looker IDE 或探索页面的按钮。
如果您使用的是 Looker 数据字典扩展程序 2.0.0 版或更高版本,则字段分析器会默认打开详细信息标签页。
在分布部分,选择计算,即可显示柱形图的预览,柱形图描绘了带有 type: count
的视图的数值维度的计数值分布。分布部分还会显示数值维度系列的最小值、最大值和平均值。
在值下,选择计算即可在包含 type: count
的视图中显示数字维度的计数值预览。选择探索更多内容按钮,以打开带数字维度和计数指标且从字段选择器中选中的“探索”界面。
选择 Go to LookML,从 Looker IDE 中打开与所选模型关联的 LookML 项目的视图文件。
选择“使用字段探索”按钮,以打开探索页面,并在字段选择器中自动选择该字段。