通过

lakeview 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The lakeview command group within the Databricks CLI contains commands for specific management operations for Lakeview dashboards. See Dashboards.

databricks lakeview create

创建草稿仪表板。

databricks lakeview create [flags]

选项

--display-name string

    仪表板的显示名称。

--json JSON

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

--serialized-dashboard string

    以序列化字符串形式表示的仪表板的内容。

--warehouse-id string

    用于运行仪表板的仓库 ID。

Global flags

Examples

以下示例创建一个显示名称的新仪表板：

databricks lakeview create --display-name "Sales Dashboard" --warehouse-id "abc123"

以下示例使用 JSON 配置创建仪表板：

databricks lakeview create --json '{"display_name": "Revenue Report", "warehouse_id": "xyz789"}'

databricks lakeview create-schedule

为仪表板创建计划。

databricks lakeview create-schedule DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识计划所属仪表板的 UUID。

选项

--display-name string

    计划的显示名称。

--json JSON

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

--pause-status SchedulePauseStatus

    状态指示此计划是否已暂停。 支持的值： PAUSED、 UNPAUSED

--warehouse-id string

    用于运行计划仪表板的仓库 ID。

Global flags

Examples

以下示例创建仪表板计划：

databricks lakeview create-schedule abc123 --display-name "Daily Sales Report" --warehouse-id "wh456"

以下示例创建暂停的计划：

databricks lakeview create-schedule abc123 --display-name "Weekly Report" --pause-status PAUSED --warehouse-id "wh456"

databricks lakeview create-subscription

为仪表板计划创建订阅。

databricks lakeview create-subscription DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    标识订阅所属仪表板的 UUID。

SCHEDULE_ID

    标识订阅所属的计划的 UUID。

选项

--json JSON

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

Global flags

Examples

以下示例为计划创建订阅：

databricks lakeview create-subscription abc123 sch456 --json '{"email": "someone@example.com"}'

databricks lakeview delete-schedule

删除仪表板的计划。

databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    标识计划所属仪表板的 UUID。

SCHEDULE_ID

    标识计划的 UUID。

选项

--etag string

    计划的 etag。

Global flags

Examples

以下示例删除仪表板计划：

databricks lakeview delete-schedule abc123 sch456

以下示例使用 etag 删除计划：

databricks lakeview delete-schedule abc123 sch456 --etag "v1.0"

databricks lakeview delete-subscription

删除仪表板计划的订阅。

databricks lakeview delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

Arguments

DASHBOARD_ID

    标识订阅所属仪表板的 UUID。

SCHEDULE_ID

    标识订阅所属的计划的 UUID。

SUBSCRIPTION_ID

    标识订阅的 UUID。

选项

--etag string

    订阅的 etag。

Global flags

Examples

以下示例删除订阅：

databricks lakeview delete-subscription abc123 sch456 sub789

以下示例删除带有 etag 的订阅：

databricks lakeview delete-subscription abc123 sch456 sub789 --etag "v1.0"

databricks lakeview get

获取草稿仪表板。

databricks lakeview get DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识仪表板的 UUID。

选项

Global flags

Examples

以下示例获取仪表板：

databricks lakeview get abc123

databricks lakeview get-published

获取当前发布的仪表板。

databricks lakeview get-published DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识已发布仪表板的 UUID。

选项

Global flags

Examples

以下示例获取已发布的仪表板：

databricks lakeview get-published abc123

databricks lakeview get-schedule

获取仪表板的计划。

databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    标识计划所属仪表板的 UUID。

SCHEDULE_ID

    标识计划的 UUID。

选项

Global flags

Examples

以下示例获取仪表板计划：

databricks lakeview get-schedule abc123 sch456

databricks lakeview get-subscription

获取仪表板计划的订阅。

databricks lakeview get-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

Arguments

DASHBOARD_ID

    标识订阅所属仪表板的 UUID。

SCHEDULE_ID

    标识订阅所属的计划的 UUID。

SUBSCRIPTION_ID

    标识订阅的 UUID。

选项

Global flags

Examples

以下示例获取订阅：

databricks lakeview get-subscription abc123 sch456 sub789

databricks lakeview 列表

列出所有仪表板。

databricks lakeview list [flags]

选项

--page-size int

    每个页面要返回的仪表板数。

--page-token string

    从上一个 ListDashboard 调用接收的页面令牌。

--show-trashed

    要包含垃圾箱中的仪表板的标志。

--view DashboardView

     DASHBOARD_VIEW_BASIC 仅包括仪表板中的摘要元数据。 支持的值： DASHBOARD_VIEW_BASIC

Global flags

Examples

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

databricks lakeview list

以下示例列出了具有特定页面大小的仪表板：

databricks lakeview list --page-size 10

以下示例列出了仪表板，包括已回收的仪表板：

databricks lakeview list --show-trashed

以下示例列出了具有基本视图的仪表板：

databricks lakeview list --view DASHBOARD_VIEW_BASIC

databricks lakeview list-schedules

列出仪表板的所有计划。

databricks lakeview list-schedules DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识计划所属仪表板的 UUID。

选项

--page-size int

    每页要返回的计划数。

--page-token string

    从上一个 ListSchedules 调用接收的页面令牌。

Global flags

Examples

以下示例列出了仪表板的计划：

databricks lakeview list-schedules abc123

databricks lakeview list-subscriptions

列出仪表板计划的所有订阅。

databricks lakeview list-subscriptions DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    标识订阅所属仪表板的 UUID。

SCHEDULE_ID

    标识订阅所属的计划的 UUID。

选项

--page-size int

    每个页面要返回的订阅数。

--page-token string

    从以前的 ListSubscriptions 调用接收的页面令牌。

Global flags

Examples

以下示例列出计划的订阅：

databricks lakeview list-subscriptions abc123 sch456

databricks lakeview migrate

将经典 SQL 仪表板迁移到 Lakeview。

databricks lakeview migrate SOURCE_DASHBOARD_ID [flags]

Arguments

SOURCE_DASHBOARD_ID

    要迁移的仪表板的 UUID。

选项

--display-name string

    新 Lakeview 仪表板的显示名称。

--json JSON

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

--parent-path string

    要包含已迁移的 Lakeview 仪表板的文件夹的工作区路径。

--update-parameter-syntax

    用于指示在仪表板中转换数据集时，是否应自动更新为命名语法（:param）的标记{{ param }}。

Global flags

Examples

以下示例将经典 SQL 仪表板迁移到 Lakeview：

databricks lakeview migrate old123 --display-name "Migrated Sales Dashboard"

以下示例将仪表板迁移到特定文件夹：

databricks lakeview migrate old123 --display-name "Migrated Report" --parent-path "/Workspace/Reports"

以下示例迁移具有参数语法更新的仪表板：

databricks lakeview migrate old123 --display-name "Migrated Dashboard" --update-parameter-syntax

databricks lakeview 发布

发布当前草稿仪表板。

databricks lakeview publish DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识要发布的仪表板的 UUID。

选项

--embed-credentials

    用于指示发布者的凭据是否应嵌入已发布仪表板的标志。

--json JSON

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

--warehouse-id string

    可用于替代草稿中设置的仓库的仓库 ID。

Global flags

Examples

以下示例发布仪表板：

databricks lakeview publish abc123

以下示例使用嵌入凭据发布仪表板：

databricks lakeview publish abc123 --embed-credentials

以下示例发布具有特定仓库的仪表板：

databricks lakeview publish abc123 --warehouse-id "wh456"

databricks lakeview 回收站

回收仪表板。

databricks lakeview trash DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识仪表板的 UUID。

选项

Global flags

Examples

以下示例会回收仪表板：

databricks lakeview trash abc123

databricks lakeview unpublish

取消发布仪表板。

databricks lakeview unpublish DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识已发布仪表板的 UUID。

选项

Global flags

Examples

以下示例取消发布仪表板：

databricks lakeview unpublish abc123

databricks lakeview 更新

更新草稿仪表板。

databricks lakeview update DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    标识仪表板的 UUID。

选项

--display-name string

    仪表板的显示名称。

--json JSON

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

--serialized-dashboard string

    以序列化字符串形式表示的仪表板的内容。

--warehouse-id string

    用于运行仪表板的仓库 ID。

Global flags

Examples

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

databricks lakeview update abc123 --display-name "Updated Sales Dashboard"

以下示例更新仪表板的仓库：

databricks lakeview update abc123 --warehouse-id "wh456"

databricks lakeview update-schedule

更新仪表板的计划。

databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    标识计划所属仪表板的 UUID。

SCHEDULE_ID

    标识计划的 UUID。

选项

--display-name string

    计划的显示名称。

--json JSON

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

--pause-status SchedulePauseStatus

    状态指示此计划是否已暂停。 支持的值： PAUSED、 UNPAUSED

--warehouse-id string

    用于运行计划仪表板的仓库 ID。

Global flags

Examples

以下示例更新计划的显示名称：

databricks lakeview update-schedule abc123 sch456 --display-name "Updated Daily Report"

以下示例暂停计划：

databricks lakeview update-schedule abc123 sch456 --pause-status PAUSED

以下示例使用其他仓库更新计划：

databricks lakeview update-schedule abc123 sch456 --warehouse-id "wh789"

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 字符串

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