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 扩展程序框架(默认处于启用状态)开发的扩展程序
您必须拥有 develop
、manage_models
和 deploy
权限,才能安装 Marketplace 中的应用和工具(例如扩展程序)。
如需了解如何安装 Looker Marketplace 中的工具,请参阅使用 Looker Marketplace 文档。您可以前往 Looker Marketplace,选择 Manage,然后选择扩展程序旁边的 Update 按钮,以确保您始终拥有最新版本的数据字典。
授予访问 Looker 数据字典的权限
安装 Looker 数据字典后,名为 data-dictionary
的模型会自动添加到新建模型集和修改模型集页面上的可用模型列表中,可通过管理面板的角色页面访问。
Looker 管理员必须向用户授予 explore
或 develop
权限,才能访问 data-dictionary
模型以及他们需要在数据字典中探索的任何模型。请参阅为 Looker 扩展程序设置权限文档页面,了解如何向用户授予访问和使用扩展程序的权限。
授予与字段注释互动的权限
字段注释使用户能够向字段定义添加上下文,而无需更新任何 LookML。默认情况下,有权访问数据字典扩展程序的所有用户均可查看所有评论,并添加、修改和删除自己的评论。
如果需要,Looker 管理员可以在管理面板的群组页面上创建特定的用户群组,然后将用户分配到这些群组,从而管理用户与字段评论功能互动的方式。如需详细了解如何将用户分配给群组,请参阅群组文档页面。
Looker 管理员必须使用如下所示的预定义名称创建群组。
必须使用下表中显示的预定义名称创建用户群组。该表还会显示分配到各个群组的用户将拥有的预定义权限。
如果用户不属于这些群组,则系统会默认使用writer
。如果将一位用户分配给多个群组(不包括 marketplace_data_dictionary_comments_disabled
),系统会优先考虑提升的权限。
通过管理面板中的群组页面对评论组所做的更改(例如添加或移除用户)将在硬刷新“数据字典”页面或用户选择其他选项并返回到“数据字典”页面后生效。
前往 Looker 数据字典
您可以从左侧边栏的已安装应用程序和扩展程序列表中导航到数据字典。
使用 Looker 数据字典查看模型元数据
在 Looker 数据字典中,对模型具有 explore
权限的用户可以选择此model并查看其元数据,包括其探索和每个探索的字段列表(按视图分组)。Looker 数据字典在左侧边栏中显示所选模型的探索,并在页面的主要部分显示所选探索的视图和字段。
用户可以通过选择 < 图标收起边栏。
Looker 数据字典会显示以下内容:
- 所选模型的名称
- 所选模型中包含的探索列表
- 所选的探索
- 用于过滤探索中字段的文本字段
- 使用快速过滤器可根据所选特征缩小显示范围
- 视图名称
- 关于每个字段的元数据。选择查看选项按钮,选择要显示的元数据。在字段分析器中查看字段的整组元数据。
- 包含给定视图中每个字段的元数据的行
- 在 Looker 界面中导航到“探索”
选择模型和探索
选择模型下拉列表列出了用户具有 explore
权限的所有模型。从选择模型下拉菜单中选择模型时,左侧边栏中会填充该模型的探索列表。
您还可以在搜索模型搜索框中输入内容,针对特定探索搜索所选模型。探索列表会过滤,仅显示与您的搜索字词匹配的结果。
选择探索的名称可查看其字段(按视图分组),显示在页面的主要部分。
您还可以选择右上角的探索按钮,直接进入 Looker 中的探索页面。
过滤探索中的字段
您可以在此探索的过滤字段框中输入文本,以与字段列表的字段标签或说明进行匹配,从而过滤显示的字段。
您还可以选择要依据特定元数据属性进行过滤,例如字段是否:
查看字段元数据
Looker 数据字典会显示探索字段的元数据,按视图分组:
- 字段标签:根据字段的
label
参数显示的字段名称 - 类别:作为维度或测量的字段类别
- 说明:根据字段的
description
参数提供的说明 - LookML 名称:采用
view_name.field_name
语法的字段名称 - 类型:根据字段的
type
参数,字段类型为 string、number、date、zipcode、count、sum、average、list 或不带英文引号 - SQL:引用该字段的 SQL 表达式
- 标记:与该字段关联的 LookML 标记
自定义显示的元数据
只需选择右上角的查看选项按钮,然后选中或取消选中您要查看的元数据的复选框,即可为每个字段指定显示哪些元数据。
使用字段注释
如果实例已具有 Marketplace,管理员应确保 Data Dictionary 扩展程序是 2.0.0 或更高版本,才能使用字段级注释。
LookML 开发者通常会在字段级 description
参数中添加有关模型字段的额外信息或说明。不过,这些说明并不总是对所有用户都有意义或有用。通过字段级注释,用户可以为特定字段添加上下文。这些注释可供其他用户查看,但不会影响模型的基础 LookML。
管理员必须在管理面板的群组页面上将评论添加到特定群组,从而向用户授予与评论互动的权限。默认情况下,有权访问数据字典扩展程序的所有用户均可查看所有评论,并添加、修改和删除自己的评论。
添加字段注释
如需向字段添加注释,请执行以下操作:
- 将鼠标悬停在字段行上即可显示 + 图标(如果没有现成的字段备注)或记事本图标(如果字段中已有备注)。点击该图标,打开字段分析器面板的备注标签页。
- 点击添加评论按钮。
- 输入您的评论,然后选择评论按钮以保存您的评论。点击 Cancel 以关闭字段性能分析器。您可以选择并拖动评论框的右下角展开评论框。
添加评论后,该评论会显示在字段性能分析器的评论标签中,并可供其他用户查看。
查看字段注释
当某个字段包含评论时,系统会显示一个记事本图标,其中显示该字段上的评论数量。点击记事本图标,查看字段性能分析器的备注标签页中列出的字段备注。
备注标签页上的括号中也会指明该字段的评论数。每个评论条目都会显示以下信息:
- 评论者的姓名
- 添加评论时显示的时间戳
- 评论预览
修改或删除字段注释
要编辑或删除您自己的字段注释:
- 选择字段的记事本图标。
- 在评论标签页中,找到并将鼠标悬停在要修改或删除的评论上。
- 点击三点状菜单,然后选择修改评论以修改评论,或选择删除评论以删除评论。如果要删除评论,请确认删除意图。
- 如果您要修改评论,请在完成更改后选择保存。
共享字段评论
每个字段的备注标签页的网址都是独一无二的,您可以复制该网址,并将其分享给有权访问 Looker 数据字典中相应模型的其他用户。
使用字段分析器
点击特定字段行会在页面右侧打开一个字段性能分析器面板,其中会显示相应字段的整组元数据、用于预览数字维度值的选项,以及用于前往 Looker IDE 或探索页面的按钮。
如果您使用的是 Looker Data Dictionary 扩展程序 2.0.0 或更高版本,则字段性能分析器会默认打开并转到 Details 标签页。
在分布部分选择计算,即可预览柱形图预览,其中显示了测量值为 type: count
的视图中数字维度的计数值分布情况。分布部分还会显示数值维度系列的最小值、最大值和平均值。
在值下方,选择计算,即可在所含测量值为 type: count
的视图上显示数字维度计数值的预览。选择探索更多按钮可打开“探索”界面,其中包含从字段选择器中预选的数字维度和数量测量值。
选择转到 LookML,以在 Looker IDE 中打开与所选模型关联的 LookML 项目中的视图文件。
选择“使用字段探索”按钮打开页面,系统将自动从字段选择器中选择该字段。