dashboards （旧版） 命令组

The dashboards command group within the Databricks CLI allows you to manage legacy dashboard objects.

databricks 仪表板创建

创建仪表板对象。

databricks dashboards create [flags]

Arguments

None

选项

--json JSON

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

Global flags

Examples

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

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

databricks 仪表板删除

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

databricks dashboards delete DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    要删除的仪表板的 ID。

选项

Global flags

Examples

以下示例删除仪表板：

databricks dashboards delete 12345

databricks 仪表板获取

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

databricks dashboards get DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    要检索的仪表板的 ID。

选项

Global flags

Examples

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

databricks dashboards get 12345

databricks 仪表板列表

提取仪表板对象的分页列表。

databricks dashboards list [flags]

Arguments

None

选项

--order ListOrder

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

--page int

    要检索的页码。

--page-size int

    每页要返回的仪表板数。

--q string

    全文搜索词。

Global flags

Examples

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

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]

Arguments

DASHBOARD_ID

    要还原的仪表板的 ID。

选项

Global flags

Examples

以下示例还原仪表板：

databricks dashboards restore 12345

databricks 仪表板更新

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

Note: You cannot undo this operation.

databricks dashboards update DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    要更新的仪表板的 ID。

选项

--json JSON

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

--name string

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

--run-as-role RunAsRole

    Sets the Run as role for the object. 支持的值：owner、viewer。

Global flags

Examples

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

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

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

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

Global flags

--debug

  是否启用调试日志记录。

-h 或 --help

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

--log-file 字符串

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

--log-format 格式

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

--log-level 字符串

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

-o, --output 类型

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

-p, --profile 字符串

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

--progress-format 格式

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

-t, --target 字符串

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