Databricks SQL 仪表板

可以使用 SQL 编辑器构建一个 Databricks SQL 仪表板,该仪表板结合使用了可视化效果和为数据提供上下文的文本框。

查看和整理仪表板

使用以下选项之一查看仪表板:

  • 单击边栏中的工作区图标工作区”,从工作区浏览器查看仪表板。 默认情况下,仪表板存储在“主页”文件夹中。 用户可将仪表板连同其他 Azure Databricks 对象一起组织到工作区浏览器的文件夹中。
  • 若要查看所有仪表板,请单击边栏中的仪表板图标仪表板”。

默认情况下,仪表板以时间倒序排序。 通过单击列标题重新对列表进行排序。

将仪表板整理到工作区浏览器中的文件夹中

将新仪表板和现有仪表板连同其他 Azure Databricks 对象一起组织到工作区浏览器的文件夹中。 请参阅工作区浏览器

筛选已保存的仪表板的列表

可按照你所创建的仪表板(“我的仪表板”)、收藏夹标记来筛选所有仪表板列表。

创建仪表板

执行下列步骤,创建新的仪表板。 若要克隆现有仪表板,请参阅克隆仪表板

  1. 执行下列操作之一:
    • 单击边栏中的新建图标“新建”,然后选择“仪表板”。
    • 单击边栏中的 仪表板图标“仪表板”,然后单击“+ 创建仪表板”。
    • 单击边栏中的 工作区图标“工作区”,然后单击“+ 创建仪表板”。
    • 如果你不想从空仪表板开始,可以创建一个快速仪表板:
      1. 点击边栏中的目录图标目录
      2. 浏览到表,然后在“操作”菜单中,单击“创建快速仪表板”。
      3. 在配置页面中,选择感兴趣的列,然后创建仪表板和支持查询,这些查询使用这些列提供一些基本信息,并展示仪表板级参数和其他功能。
      4. 继续执行以下步骤,自定义仪表板。
  2. 输入仪表板的名称。
  3. 创建仪表板时,可以选择指定要用于手动刷新的仓库。 如果不选择仓库并将其保存到仪表板中,它将回退为使用为单个查询保存的仓库。

注意

如果你选择一个仓库并将其保存到仪表板,然后它被删除或变得不可用,则手动刷新将失败,直到分配了一个新仓库。

  1. 通过单击“添加”并选择要添加的内容类型,将内容添加到仪表板:

    • 单击“上下文”以添加注释。

      输入文字。 使用 Markdown 为文本框制定样式。

      • 要在文本框中添加静态图像,请使用带有所需说明和公开可用 URL 的 Markdown 图像语法:![description](url)。 例如,以下 Markdown 将插入 Databricks 徽标的图像:![The Databricks Logo](https://static.docs.com/ui/media/product/azure/databricks.svg)。 若要调整图像大小,请调整小组件尺寸的大小。
      • 若要从 DBFS 添加图像,请添加带有所需说明和 FileStore 路径的 markdown 图像语法:![description](files/path_to_dbfs_image)。 若要调整图像大小,请调整小组件尺寸的大小。

      重要

      执行按需 pdf 或订阅时,存储在 DBFS 中的仪表板中使用的图像将不会呈现

    • 单击“可视化效果”,添加查询可视化效果。

      1. 选择查询。 搜索现有查询或从预先填充的列表中选取最近的查询。 如果使用“限制为 1000”设置来保存查询,则仪表板中的查询会将结果限制为 1000 行。

      2. 在“选择可视化效果”下拉列表中,选择可视化效果类型。

        添加到仪表板

  2. 单击“添加到仪表板”。

  3. 拖放仪表板上的内容块。

  4. 单击“完成编辑”。

    完成仪表板

还可使用 Databricks Terraform 提供程序databricks_sql_dashboard 创建仪表板。 可以使用 databricks_sql_widget 为仪表板创建小组件。 可以使用 dbsql-nyc-taxi-trip-analysis创建示例仪表板。

克隆仪表板

如果对仪表板及其每个上游查询具有“可运行”、“可编辑”和“可管理”权限,则可以克隆仪表板和所有上游查询。 你已成为新仪表板和查询的所有者。

重要

共享设置、警报和订阅不会复制到新仪表板中。

克隆仪表板:

  1. 打开仪表板右上角的 Kebab 菜单 串形菜单,然后选择“克隆”。
  2. 输入新仪表板的名称,然后单击“确认”。

注意

可以保证克隆能够可靠地处理少于 50 个可视化效果和少于 30 个查询,包括用于生成基于查询的下拉列表参数的查询。 尝试使用超出这些限制的可视化效果或查询克隆仪表板可能会失败。

有关基于查询的下拉列表参数的详细信息,请参阅基于查询的下拉列表

在仪表板中使用查询参数

查询可以选择性地利用参数或静态值。 将基于参数化查询的可视化效果添加到仪表板时,可以将可视化效果配置为使用:

  • 小组件参数

    小组件参数特定于仪表板中的单个可视化效果,显示在可视化效果面板中,指定的参数值仅适用于可视化效果的基础查询。

  • 仪表板参数

    仪表板参数可以应用于多个可视化效果。 在将基于参数化查询的可视化效果添加到仪表板时,默认情况下,该参数将被视为仪表板参数。 仪表板参数针对仪表板中的一个或多个可视化效果进行配置,并显示在仪表板顶部。 为仪表板参数指定的参数值适用于重用该特定仪表板参数的可视化效果。 仪表板可以有多个参数,每个参数可能适用于某些可视化效果,而不适用于其他可视化效果。

  • 静态值

    使用静态值而不是响应更改的参数。 使用静态值,你可以对某个值进行硬编码来代替参数,并使之前显示在仪表板或小组件中的参数“消失”。

添加包含参数化查询的可视化效果时,可以通过单击相应的铅笔图标 铅笔图标 在可视化效果查询中选择参数的标题和源。 还可以选择关键字和默认值。 请参阅参数属性

参数映射

将可视化效果添加到仪表板后,可以通过单击仪表板小组件右上角的 Kebab 菜单 串形菜单,然后单击“更改小组件设置”来访问参数映射界面。

打开仪表板参数映射

更改参数映射视图

参数属性

仪表板小组件参数属性为:

  • 标题:显示在仪表板上的值选择器旁边的显示名称。 它默认为查询编辑器中设置的标题。 若要编辑它在仪表板中的显示方式,请单击铅笔图标 铅笔图标。 静态仪表板参数不显示标题,因为值选择器是隐藏的。 如果选择“静态值”作为值源,则标题字段将灰显。

  • 关键字:基础查询中此参数的字符串字面量。 这有助于在仪表板未返回预期结果的情况下进行调试。

  • 默认值:在仪表板加载时为该参数设置的值,直到选择另一个参数并应用更改。 若要更改此默认值,请在 SQL 编辑器中打开基础查询,将参数更改为所需的值,然后单击“保存”按钮。

  • 值源:参数值的源。 若要选择源,请单击铅笔图标 铅笔图标

    • 新的仪表板参数:创建新的仪表板级别参数。 这样,你就可在你的仪表板上的一个位置中设置参数值,并将其映射到一个或多个可视化效果。 参数在仪表板中必须具有唯一的名称。
    • 现有仪表板参数:将此可视化效果的参数映射到现有仪表板参数。 必须指定预先存在的仪表板参数。
    • 小组件参数:显示仪表板小组件中的值选择器。 对于不在小组件之间共享的一次性参数,这非常有用。
    • 静态值:为小组件选择一个静态值,而不考虑在其他小组件上使用的值。 静态映射的参数值不会在更紧凑的仪表板上的任何位置显示值选择器。 这使你能够利用查询参数的灵活性,当某些参数预计不会频繁更改时,让仪表板上的用户界面不因此混乱。

    更改参数映射

编辑仪表板

要打开仪表板进行编辑,请打开仪表板右上角的 Kebab 菜单 串形菜单,然后选择“编辑”。

编辑仪表板

编辑时,可添加和移除内容、编辑可视化效果以及应用筛选器。 要更改参数的显示顺序,可以单击每个参数并将其拖动到所需位置。

跨多个查询进行筛选

若要在仪表板上跨多个查询进行筛选,请执行以下操作:

  1. 转到你的 Databricks SQL 仪表板。
  2. 在“编辑”模式下,单击“添加”,然后单击“筛选”。
  3. 选择“新建仪表板筛选器”,然后选择要筛选的查询和列。 还可以选择从现有查询导入筛选器,方法是选择“现有查询筛选器”,然后选择从 SQL 查询编辑器导入筛选器。 所选查询必须属于同一目录和架构。
  4. 单击“ 保存”。 这会创建一个筛选器,其中包含所有下拉选项的联合。

注意

所选查询必须属于同一目录和架构。 某些旧查询可能与跨多个查询进行筛选的功能不兼容。

编辑仪表板可视化效果

要在编辑模式下编辑仪表板上的可视化效果,请选择要编辑的可视化效果,然后单击可视化效果右上角的 Kebab 菜单 串形菜单。 在显示的列表中,选择“编辑可视化效果”。

编辑可视化效果

将内容添加到仪表板

  1. 打开仪表板进行编辑
  2. 单击“添加文本框”或“添加小组件” 。
  3. 单击“添加到仪表板”。
  4. 单击“完成编辑”。

还可将可视化效果添加到 SQL 编辑器中的仪表板

删除仪表板中的内容

  1. 单击 SQL Delete Icon 或将鼠标悬停在对象上,单击小組件右上角的 Kebab 菜单 串形菜单,然后选择“从仪表板移除”。
  2. 单击 “删除”

仪表板筛选器

当查询具有筛选器时,还必须在仪表板级别应用筛选器。 选择“使用仪表板级别筛选器”复选框以将筛选器应用到所有查询。

自定义仪表板颜色

可以自定义仪表板调色板,包括创建调色板。

创建调色板

若要为仪表板创建自定义调色板,请执行以下操作:

  1. 单击右上角的 Kebab 菜单 串形菜单,然后单击“编辑”。
  2. 单击“颜色”。
  3. 若要导入现有调色板,单击“导入”并选择调色板。 可以自定义导入的调色板。
  4. 若要新建调色板或自定义导入的调色板,请执行以下操作:
    1. 若要添加新的颜色,请单击“添加”。
    2. 对于新添加的颜色或现有颜色,请通过执行以下操作之一指定颜色:
      • 单击正方形,然后在颜色选择器中单击新颜色或使用吸管选择新颜色。
      • 单击正方形旁边的文本字段,然后输入十六进制值。
  5. 单击“应用” 。

停止使用自定义调色板

若要删除自定义调色板,请执行以下操作:

  1. 单击右上角的 Kebab 菜单 串形菜单,然后单击“编辑”。
  2. 单击“颜色”。
  3. 单击“清除”。
  4. 单击“应用” 。

对可视化效果使用其他调色板

默认情况下,如果调色板已在仪表板中应用,则所有可视化效果都将使用该调色板。 如果要对可视化效果使用其他颜色,可以重写以下行为:

  1. 单击仪表板中可视化效果的 Kebab 菜单 串形菜单,然后单击“编辑”。
  2. 单击“保留对可视化效果指定的颜色”旁边的复选框。
  3. 单击“确定”。

刷新仪表板

Databricks SQL 仪表板的设计可实现高效加载,因为它们会从缓存中检索数据,而缓存会在每次查询运行时更新。 但是如果不定期运行关联的查询,仪表板可能会过时。 要防止仪表板过时,可以刷新仪表板以重新运行关联的查询。

每次手动刷新或按计划刷新仪表板时,仪表板中引用的所有查询都会刷新。 刷新单个可视化效果时,将刷新上游查询。 手动刷新仪表板或单个可视化效果时,不会刷新在基于查询的下拉列表中使用的查询。 有关基于查询的下拉列表的详细信息,请参阅基于查询的下拉列表

刷新行为和执行上下文

当“以所有者身份运行”仪表板且已添加计划时,所有者的凭据将用于执行,且任何至少具有“可运行”权限的人都会看到那些已刷新查询的结果。

当仪表板为“以查看者身份运行”并已添加计划时,所有者的凭据将用于执行,但只有所有者才能看到已刷新查询的结果;所有其他查看者都必须手动刷新才能看到更新的查询结果。

手动刷新仪表板

要强制刷新,请单击仪表板右上方的“刷新”。 此操作将运行所有仪表板查询并更新其可视化效果。

自动刷新仪表板

仪表板的所有者和具有“可编辑”权限的用户可将仪表板配置为按计划自动刷新。 若要自动刷新仪表板,请执行以下操作:

  1. 单击仪表板右上角的“计划”。 然后,单击“添加计划”。

  2. 使用下拉选择器可以指定频率、时段、开始时间和时区。 (可选)选择“显示 cron 语法”复选框以在“Quartz Cron 语法”中编辑时间表。

  3. 选择“更多选项”以显示可选设置。 您可以选择:

    • 计划的名称。
    • 为查询提供支持的 SQL 仓库。 默认情况下,用于临时查询执行的 SQL 仓库也用于计划作业。 使用此可选设置可以选择其他仓库来运行计划查询。

    注意

    此仓库可能不同于用于手动刷新的仓库。

  4. 可选:在“订阅服务器”选项卡中,输入要在仪表板自动更新时通知的电子邮件地址列表。 每个电子邮件地址必须与具有工作区访问权限的 Azure Databricks 帐户相关联,或在工作区设置中定义为通知目标。 通知目标由工作区管理员配置。

  5. 单击 “创建” 。 “计划”标签更改为“计划 (1)”。

  6. 编辑共享设置。

    注意

    仪表板权限未链接到计划权限。 创建计划刷新间隔后,请编辑计划权限以向其他用户提供访问权限。 只有具有“可管理”权限的用户才能编辑计划或编辑订阅者列表。

    • 单击 Kebab 菜单 串形菜单。
    • 单击“编辑计划权限”。
    • 从对话框的下拉菜单中选择用户或组。
    • 选择“可编辑”以允许所选用户查看计划配置。

“可编辑”和“可管理”权限允许分配的接受者查看计划是否存在,以及报表节奏和订阅者数等属性。 “可管理”允许接受者修改计划、订阅者列表和计划权限。 “可管理”权限还允许接受者暂停或取消暂停计划。

打开的仪表板上的刷新行为

当你打开设置为 Run as Owner 的仪表板时,它会显示最新仪表板更新中的数据,无论更新是计划的还是手动刷新的。 如果在浏览器窗口中打开了仪表板,并且修改了查询或计划运行更新了仪表板结果,则不会立即反映更改。 下次打开仪表板或刷新打开的浏览器窗口时,将显示更新后的结果。

仪表板快照订阅

你可以定期导出仪表板快照并发送电子邮件。 仪表板快照是从默认仪表板状态拍摄的,这表示快照中不包括与筛选器和可视化效果的任何交互。

如果你至少拥有“可编辑”权限,则可以创建一个刷新计划并订阅其他用户,这些用户将在每次仪表板被刷新时收到仪表板的电子邮件快照。 要添加订阅服务器,请如上所述在“订阅服务器”选项卡中输入用户或组。 符合条件的订阅者包括工作区用户和通知目标。

注意

通知目标由工作区管理员配置。若要了解如何配置通知目标,请参阅管理通知目标

电子邮件附件的文件大小限制为 6 MB。 如果仪表板订阅电子邮件超过 6 MB 大小限制,则电子邮件将省略内联仪表板快照,并仅包含仪表板快照的 PDF。

如果 PDF 快照文件超过 6 MB,订阅电子邮件将省略 PDF,而改为包含指向刷新的仪表板的链接。 电子邮件中会有警告说明,详细说明当前仪表板的大小。 (用户可以通过手动下载仪表板的 PDF 来测试 PDF 快照大小。)

临时暂停计划的仪表板更新

如果仪表板配置为自动更新,并且你至少对计划具有“可查看”权限,则“计划”按钮上的标签会显示Schedule(#), 其中 # 是对你可见的计划事件数量。 此外,如果你至少对计划拥有“可管理”权限,则可以暂时暂停计划。 这有助于避免在测试对仪表板的更改时发送更新。 暂时暂停计划的仪表板更新而不修改订阅者列表:

  1. 单击“计划 (#)”。
  2. 单击 Kebab 菜单 串形菜单。
  3. 单击“暂停”。

停止自动更新仪表板

停止自动更新仪表板并删除其订阅:

  1. 单击“计划 (#)”。
  2. 单击 Kebab 菜单 串形菜单>“删除”。

注意

必须至少对计划拥有“可管理”权限才能将其删除。

以 PDF 格式下载

要将仪表板下载为 PDF 文件,请单击仪表板右上角的 Kebab 菜单 串形菜单,然后选择“下载为 PDF”。

将仪表板移至回收站

要将仪表板移动到垃圾箱,请单击仪表板右上角的 Kebab 菜单 串形菜单,然后选择“移动到垃圾桶”。 单击“移至回收站”进行确认。

从回收站还原仪表板

  1. 单击边栏中的 Dashboards Icon“仪表板”。
  2. 单击 Trash Button
  3. 单击仪表板。
  4. 单击仪表板右上角的 Kebab 菜单 串形菜单,然后选择“还原”。

永久删除仪表板

  1. 在“所有仪表板”列表中,单击 Trash Button
  2. 单击仪表板。
  3. 单击仪表板右上角的 Kebab 菜单 串形菜单,然后选择“删除”。

打开查询

要在 SQL 编辑器中打开小组件中显示的查询,请单击小组件右上角的 Kebab 菜单 肉形菜单,然后选择“查看查询”。

配置仪表板权限和仪表板所有权

要配置可以管理和运行仪表板的人员并转让仪表板所有权,请参阅共享 Databricks SQL 仪表板

访问管理员视图

Azure Databricks 工作区管理员用户有权查看工作区中所有仪表板。 在此视图中,工作区管理员可查看和删除任何仪表板。 但是,当共享设置凭据设置为“以所有者身份运行”时,工作区管理员无法编辑仪表板。

若要查看所有仪表板:

  1. 单击边栏中的 Dashboards Icon“仪表板”。
  2. 单击屏幕顶部附近的“所有查询”选项卡。