dashboards （旧版） 命令组

dashboards CLI 中的命令组允许管理旧仪表板对象。

databricks 仪表板创建

创建仪表板对象。

databricks dashboards create [flags]

论据

没有

选项

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

全局标志

例子

以下示例使用 JSON 文件创建仪表板：

databricks dashboards create --json @dashboard-config.json

databricks 仪表板删除

将仪表板移到回收站。 已删除的仪表板不会显示在列表视图或搜索结果中，且无法共享。

databricks dashboards delete DASHBOARD_ID [flags]

论据

DASHBOARD_ID

    要删除的仪表板的 ID。

选项

全局标志

例子

以下示例删除仪表板：

databricks dashboards delete 12345

databricks 仪表板读取

检索仪表板对象的 JSON 表示形式，包括其可视化效果和查询对象。

databricks dashboards get DASHBOARD_ID [flags]

论据

DASHBOARD_ID

    要检索的仪表板的 ID。

选项

全局标志

例子

以下示例检索仪表板定义：

databricks dashboards get 12345

Databricks 仪表板列表

获取仪表盘元素的分页列表。

databricks dashboards list [flags]

论据

没有

选项

--order ListOrder

    要排序的仪表板属性的名称。 支持的值：created_at、name。

--page int

    要检索的页码。

--page-size int

    每页要返回的仪表板数。

--q string

    全文搜索词。

全局标志

例子

以下示例列出所有仪表板：

databricks dashboards list

以下示例列出具有分页的仪表板：

databricks dashboards list --page 2 --page-size 10

以下示例列出按创建日期排序的仪表板：

databricks dashboards list --order created_at

以下示例按名称搜索仪表板：

databricks dashboards list --q "Sales Dashboard"

databricks 仪表板恢复

还原仪表板。

还原的仪表板显示在列表视图和搜索中，并且可以共享。

databricks dashboards restore DASHBOARD_ID [flags]

论据

DASHBOARD_ID

    要还原的仪表板的 ID。

选项

全局标志

例子

以下示例还原仪表板：

databricks dashboards restore 12345

Databricks 仪表板功能更新

更改仪表板定义。 此操作仅影响仪表板对象的属性。 它不会添加、修改或删除小组件。

注意：无法撤销此操作。

databricks dashboards update DASHBOARD_ID [flags]

论据

DASHBOARD_ID

    要更新的仪表板的 ID。

选项

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

    显示在列表视图和仪表板页面顶部的此仪表板的标题。

--run-as-role RunAsRole

    设置“运行方式”角色，适用于该对象。 支持的值：owner、viewer。

全局标志

例子

以下示例更新仪表板的名称：

databricks dashboards update 12345 --name "Updated Dashboard Name"

以下示例更新仪表板的运行方式角色：

databricks dashboards update 12345 --run-as-role viewer

全局标志

--debug

  是否启用调试日志记录。

-h 或 --help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型，text 或 json。 默认值是 text。

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。

-o, --output 类型

    命令输出类型为 text 或 json。 默认值是 text。

-p, --profile 字符串

    要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。 如果未指定此标志，并且存在命名为 DEFAULT 的配置文件，则使用该配置文件。

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如果适用，要使用的捆绑包目标