Note
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。
lakeview
Databricks CLI 中的命令组包含用于 Lakeview 仪表板的特定管理操作的命令。 请参阅 仪表板。
databricks Lakeview 创建
创建草稿仪表板。
databricks lakeview create [flags]
选项
--display-name string
仪表板的显示名称。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--serialized-dashboard string
以序列化字符串形式表示的仪表板的内容。
--warehouse-id string
用于运行仪表板的仓库 ID。
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 创建计划
为仪表板创建时间表。
databricks lakeview create-schedule DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
标识计划所属仪表板的 UUID。
选项
--display-name string
计划的显示名称。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--pause-status SchedulePauseStatus
状态指示此计划是否已暂停。 支持的值：PAUSED、UNPAUSED
--warehouse-id string
计划运行仪表板所用的仓库 ID。
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 创建订阅
为仪表板计划创建订阅。
databricks lakeview create-subscription DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
标识订阅所属仪表板的 UUID。
SCHEDULE_ID
标识订阅所属时间表的 UUID。
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
Examples
以下示例为计划表创建订阅：
databricks lakeview create-subscription abc123 sch456 --json '{"email": "someone@example.com"}'
Databricks Lakeview 删除计划
删除仪表板的计划。
databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
标识计划所属仪表板的 UUID。
SCHEDULE_ID
用于标识计划的 UUID。
选项
--etag string
计划的 etag。
Examples
以下示例删除仪表板计划：
databricks lakeview delete-schedule abc123 sch456
以下示例删除了具有 etag 的计划：
databricks lakeview delete-schedule abc123 sch456 --etag "v1.0"
databricks lakeview 删除订阅
删除仪表板计划的订阅。
databricks lakeview delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]
Arguments
DASHBOARD_ID
标识订阅所属仪表板的 UUID。
SCHEDULE_ID
标识订阅所属计划的 UUID。
SUBSCRIPTION_ID
标识订阅的 UUID。
选项
--etag string
订阅的 etag。
Examples
以下示例删除订阅：
databricks lakeview delete-subscription abc123 sch456 sub789
以下示例删除带有 etag 的订阅：
databricks lakeview delete-subscription abc123 sch456 sub789 --etag "v1.0"
Databricks 湖景获取
获取草稿仪表板。
databricks lakeview get DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
标识仪表板的 UUID。
选项
Examples
以下示例展示如何获取仪表板：
databricks lakeview get abc123
databricks lakeview 发布获取
获取当前已发布的仪表板。
databricks lakeview get-published DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
标识已发布仪表板的 UUID。
选项
Examples
以下示例获取已发布的仪表板：
databricks lakeview get-published abc123
databricks lakeview 获取计划
获取仪表板的计划。
databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
标识计划所属仪表板的 UUID。
SCHEDULE_ID
用于标识计划的 UUID。
选项
Examples
以下示例获取仪表板计划：
databricks lakeview get-schedule abc123 sch456
databricks lakeview 获取订阅
获取仪表板计划的订阅。
databricks lakeview get-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]
Arguments
DASHBOARD_ID
标识订阅所属仪表板的 UUID。
SCHEDULE_ID
标识订阅所属计划的 UUID。
SUBSCRIPTION_ID
标识订阅的 UUID。
选项
Examples
以下示例获取订阅：
databricks lakeview get-subscription abc123 sch456 sub789
databricks lakeview 列表
列出所有仪表板。
databricks lakeview list [flags]
选项
--page-size int
每页返回的仪表板数量。
--page-token string
从之前的 ListDashboards 调用接收的页令牌。
--show-trashed
包括位于回收站中的仪表板的标志。
--view DashboardView
DASHBOARD_VIEW_BASIC 仅包含仪表板的摘要元数据。 支持的值：DASHBOARD_VIEW_BASIC
Examples
以下示例列出所有仪表板：
databricks lakeview list
以下示例列出了具有特定页面大小的仪表板：
databricks lakeview list --page-size 10
以下示例列出包括已放入回收站的仪表板：
databricks lakeview list --show-trashed
以下示例列出了具有基本视图的仪表板：
databricks lakeview list --view DASHBOARD_VIEW_BASIC
databricks lakeview 列出计划表
列出仪表板的所有计划。
databricks lakeview list-schedules DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
标识计划所属仪表板的 UUID。
选项
--page-size int
每页返回的计划数量。
--page-token string
从之前的 ListSchedules 调用接收的页令牌。
Examples
以下示例列出了仪表板的时间表：
databricks lakeview list-schedules abc123
databricks LakeView 列出订阅列表
列出仪表板计划的所有订阅。
databricks lakeview list-subscriptions DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
标识订阅所属仪表板的 UUID。
SCHEDULE_ID
标识订阅所属计划的 UUID。
选项
--page-size int
每页返回的订阅数量。
--page-token string
从之前的 ListSubscriptions 调用接收的页令牌。
Examples
以下示例列出某个计划的订阅：
databricks lakeview list-subscriptions abc123 sch456
databricks lakeview 迁移
将经典 SQL 仪表板迁移到 Lakeview。
databricks lakeview migrate SOURCE_DASHBOARD_ID [flags]
Arguments
SOURCE_DASHBOARD_ID
要迁移的仪表板的 UUID。
选项
--display-name string
新 Lakeview 仪表板的显示名称。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--parent-path string
用于存放已迁移 Lakeview 仪表板的文件夹的工作区路径。
--update-parameter-syntax
指示在转换仪表板中的数据集时，是否应将 mustache 参数语法 ({{ param }}) 自动更新为命名语法 (:param) 的标志。
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 文件。
--warehouse-id string
可用于覆盖草稿中设置的仓库的仓库 ID。
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。
选项
Examples
以下示例删除仪表板：
databricks lakeview trash abc123
databricks lakeview 取消发布
取消发布仪表板。
databricks lakeview unpublish DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
标识已发布仪表板的 UUID。
选项
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 文件。
--serialized-dashboard string
以序列化字符串形式表示的仪表板的内容。
--warehouse-id string
用于运行仪表板的仓库 ID。
Examples
以下示例更新仪表板的显示名称：
databricks lakeview update abc123 --display-name "Updated Sales Dashboard"
以下示例更新仪表板的数据仓库：
databricks lakeview update abc123 --warehouse-id "wh456"
databricks lakeview 更新计划
更新仪表板的计划。
databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
标识计划所属仪表板的 UUID。
SCHEDULE_ID
用于标识计划的 UUID。
选项
--display-name string
计划的显示名称。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--pause-status SchedulePauseStatus
状态指示此计划是否已暂停。 支持的值：PAUSED、UNPAUSED
--warehouse-id string
计划运行仪表板所用的仓库 ID。
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"
全局标志
--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 字符串
如适用，要使用的捆绑包目标