使用 Looker Data Dictionary 扩展程序

Looker Data Dictionary 是一种扩展程序(使用 Looker 组件构建的 Web 应用),它是使用 Looker 扩展程序框架 开发并通过 Looker Marketplace 部署的。

Looker Data Dictionary 扩展程序提供了一个专用的集中式界面,用于搜索所有 Looker 字段和说明。您可以使用此扩展程序执行以下任务:

  • 为所有指标和说明提供可搜索的目录,以便用户确定适合分析的维度或度量。
  • 让外部利益相关者能够识别和查找唯一指标。
  • 审核 LookML 模型,以评估是否遵循一致的命名惯例、是否存在冗余字段,或者字段是否附有说明。
  • 添加和分享有关特定字段的评论(如果您的 Looker Data Dictionary 应用的版本为 2.0.0 或更高版本)。如需验证您是否拥有最新版本的 Data Dictionary,请前往 Looker Marketplace,选择管理,然后选择扩展程序旁边的更新按钮。

Data Dictionary 工作流

如需让用户访问和使用 Looker Data Dictionary,Looker 管理员必须执行以下步骤:

  1. 启用相应的 功能
  2. 安装 Looker Data Dictionary 扩展程序
  3. 授予访问 Looker Data Dictionary 的权限

向用户提供扩展程序后,您可以执行以下操作:

  1. 前往 Looker Data Dictionary 扩展程序
  2. 查看模型的元数据

准备工作

在从 Marketplace 安装 Looker Data Dictionary 之前,Looker 管理员必须启用以下功能:

  • Marketplace :用于访问 Looker Marketplace(默认启用)
  • 扩展程序框架:用于部署使用 Looker 扩展程序框架开发的扩展程序(默认启用)

如需从 Looker Marketplace 安装应用和工具(例如扩展程序),您必须拥有 developmanage_modelsdeploy 权限

安装 Looker Data Dictionary

如需了解如何从 Looker Marketplace 安装工具,请参阅使用 Looker Marketplace文档。安装 Data Dictionary 后,Looker 管理员必须授予用户执行以下任务的权限:

授予访问 Looker Data Dictionary 扩展程序的权限

安装 Looker Data Dictionary 后,系统会自动将名为 data-dictionary 的模型添加到 新建模型集修改模型集 页面上的可用模型列表中,这些页面可从 角色 面板中的 管理员 页面访问。

Looker 管理员必须授予用户 exploredevelop 权限,以便用户访问 data-dictionary 模型以及他们需要在 Data Dictionary 中探索的任何模型。如需了解如何授予用户访问和使用扩展程序的权限,请参阅设置 Looker 扩展程序的权限文档页面。

授予与字段评论互动的权限

字段评论让用户无需更新任何 LookML 即可为字段定义添加背景信息。默认情况下,所有有权访问 Data Dictionary 扩展程序的用户都可以查看所有评论,并添加修改和删除自己的评论。

Looker 管理员可以在管理员 面板的群组 页面上创建特定用户群组,并将用户分配给这些群组,从而管理用户与字段评论功能的互动方式。如需详细了解如何将用户分配给群组,请参阅群组文档页面。

创建用户群组时,必须使用下表中“群组名称”列中显示的预定义名称。该表还显示了分配给每个群组的用户将拥有的预定义权限。

群组名称 权限
marketplace_data_dictionary_comments_disabled 用户无法查看任何评论,也无法以其他方式与评论互动;所有评论功能均已停用。此群组的权限始终优先于其他群组的权限 - 即使 disabled 群组中的任何用户也属于另一个具有更高权限的群组,他们也无法查看或发表评论。
marketplace_data_dictionary_comments_reader 用户可以查看现有评论,但无法添加任何评论。
marketplace_data_dictionary_comments_writer 用户可以查看所有评论、添加新评论,以及修改/删除自己的评论。这是默认权限。
marketplace_data_dictionary_comments_manager 用户可以查看所有评论、添加新评论,以及修改/删除所有评论。

如果用户不属于这些群组中的任何一个,则默认情况下他们将属于 writer。如果用户被分配给多个群组(不包括 marketplace_data_dictionary_comments_disabled),则其更高的权限优先。

您可以从左侧边栏中已安装的应用和扩展程序列表中前往 Data Dictionary。

使用 Looker Data Dictionary 查看模型元数据

在 Looker Data Dictionary 中,对模型拥有 explore 权限的用户可以选择此 model 并查看其元数据,包括其 Explores 以及每个探索的 fields 列表(按 view 分组)。Looker Data Dictionary 会在左侧边栏中显示所选模型的探索,并在页面的主要部分显示所选探索的视图和字段。

用户可以通过选择 < 图标来收起边栏。

Looker Data Dictionary 会显示以下信息:

  1. 所选模型的名称
  2. 所选模型中包含的探索列表
  3. 所选探索
  4. 用于过滤探索中的字段的文本字段
  5. 用于根据所选特征缩小显示字段范围的快速过滤条件
  6. 视图名称
  7. 有关每个字段的元数据。选择查看选项 按钮,以选择要显示的元数据。在字段分析器中查看字段的整个元数据集。
  8. 包含给定视图中每个字段的元数据的行
  9. 导航到 Looker 界面中的探索

选择模型和探索

选择模型 下拉列表会列出用户拥有 explore 权限的所有模型。从选择模型 下拉菜单中选择模型时,左侧边栏将填充该模型的探索列表。

您还可以通过在搜索模型 搜索框中输入内容,在所选模型中搜索特定探索。探索列表将进行过滤,仅显示与搜索字词匹配的结果。

选择探索的名称,即可在页面的主要部分查看其字段(按视图分组)。

您还可以选择右上角的探索按钮,直接前往 Looker 中的探索页面。

过滤探索中的字段

您可以在过滤此探索中的字段 框中输入文本,以根据字段列表的字段标签说明 过滤显示的字段。

您还可以选择要过滤的特定元数据属性,例如字段是否:

查看字段元数据

Looker Data Dictionary 会显示探索的字段的元数据(按视图分组):

自定义显示的元数据

您可以指定为每个字段显示的元数据,方法是选择右上角的查看选项 按钮,然后选中或取消选中要查看的元数据的复选框。

使用字段评论

LookML 开发者通常会在字段级 description 参数中添加有关模型字段的其他信息或说明。但是,这些说明并非总是对所有用户都有意义或有用。借助字段级评论,用户可以为特定字段添加背景信息。其他用户可以查看这些评论,但这些评论不会影响模型的基础 LookML。

Looker 管理员必须授予用户能力,使其能够通过在管理员面板的群组页面上将用户添加到特定群组来与评论互动。默认情况下,所有有权访问 Data Dictionary 扩展程序的用户都可以查看所有评论,并添加修改和删除自己的评论。

添加字段评论

如需为字段添加评论,请执行以下操作:

  1. 将鼠标悬停在字段行上,以显示 + 图标(如果没有现有字段评论)或记事本图标(如果字段有现有评论)。点击该图标可打开评论标签页,该标签页位于字段分析器面板中。
  2. 点击添加评论 按钮。
  3. 输入您的评论,然后选择评论 按钮以保存您的条目。点击取消 以关闭字段分析器。您可以通过选择并拖动右下角来展开评论框。

添加评论后,该评论会显示在字段分析器的评论 标签页上,其他用户可以查看

查看字段评论

如果字段包含评论,则会显示一个记事本图标,其中包含该字段的评论数量。点击记事本图标,即可在字段分析器的评论 标签页中查看字段的评论列表。

该字段的评论数量也会在评论 标签页上以括号表示。每个评论条目都会显示以下信息:

  • 评论者的姓名
  • 显示添加评论的时间的时间戳
  • 评论的预览

修改或删除字段评论

如需修改或删除自己的字段评论,请执行以下操作:

  1. 选择字段的记事本图标。
  2. 评论 标签页上,找到并悬停在您要修改或删除的评论上。
  3. 点击三点状菜单,然后选择修改评论 以修改评论,或选择删除评论 以删除评论。如果要删除评论,请确认您的意图。
  4. 如果要修改评论,请在完成更改后选择保存

分享字段评论

每个字段的评论 标签页的网址都是唯一的,可以复制并分享给其他有权访问 Looker Data Dictionary 中该模型的用户。

使用字段分析器

点击特定字段行,即可打开字段分析器面板,其中会显示字段的整个元数据集、用于预览数值维度值的选项,以及用于导航到 Looker IDE“探索” 页面的按钮。

如果您使用的是 Looker Data Dictionary 扩展程序的 2.0.0 版或更高版本,则字段分析器默认会打开详细信息 标签页。

分布 部分中,选择计算 ,以显示柱形图的预览,该柱形图描绘了具有 type: count 的度量的视图中数值维度的计数值的分布。分布 部分还会显示数值维度序列的最小值、最大值和平均值。

下方,选择计算,以显示具有type: count的度量的视图中数值维度的计数值的预览。选择探索更多 按钮,以打开“探索”界面,其中数值维度和计数度量已从字段选择器中预先选择。

选择前往 LookML ,以从 Looker IDE 中与所选模型关联的 LookML 项目打开视图文件。

选择使用字段探索 按钮,以打开探索页面,其中该字段已从字段选择器中自动选择。