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