Note
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
Note
Databricks SQL API 的新版本现已推出。 请参阅 最新 Databricks SQL API 版本的更新。 若要对新的 Databricks SQL 查询执行操作,请参阅 queries 命令组。
queries-legacy 中的命令组允许对旧查询定义执行获取、创建、更新和删除操作。
Databricks 查询-传统创建
创建新的查询定义。 使用此终结点创建的查询属于发出请求的经过身份验证的用户。
该 data_source_id 字段指定要对其运行此查询的 SQL 仓库的 ID。 可以使用 数据源命令 查看可用 SQL 仓库的完整列表。 或者,您可以从现有查询中复制data_source_id。
Note
在创建查询之前,无法添加可视化效果。
databricks queries-legacy create [flags]
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
Databricks 查询-旧版 删除
将查询移至回收站。 废旧查询会立即从搜索和列表视图中消失,它们不能用于警报。 回收站会在 30 天后删除。
databricks queries-legacy delete QUERY_ID [flags]
Arguments
QUERY_ID
要删除的查询的 ID
选项
databricks 查询-旧版 get
获取查询对象定义以及有关当前经过身份验证的用户的上下文权限信息。
databricks queries-legacy get QUERY_ID [flags]
Arguments
QUERY_ID
要获取的查询的 ID
选项
databricks 查询-遗留列表
获取查询列表。 (可选)可以通过搜索词筛选此列表。
Important
并发运行此命令 10 次或多次可能会导致限制、服务降级或临时禁止。
databricks queries-legacy list [flags]
选项
--order string
要排序依据的查询属性的名称。
--page int
要检索的页码。
--page-size int
每页要返回的查询数。
--q string
全文搜索词。
databricks 查询 - 旧版恢复
还原已移至回收站的查询。 还原的查询显示在列表视图和搜索中。 可以使用恢复的查询来设置警报。
databricks queries-legacy restore QUERY_ID [flags]
Arguments
QUERY_ID
要恢复的查询 ID
选项
databricks 查询-旧版更新
修改查询定义。
Note
无法撤消此操作。
databricks queries-legacy update QUERY_ID [flags]
Arguments
QUERY_ID
要更新的查询的 ID
选项
--data-source-id string
数据源 ID 映射到资源使用的数据源的 ID,不同于仓库 ID。
--description string
传达有关此查询的其他信息的常规说明,例如使用情况说明。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。
--name string
此查询的标题,显示在列表视图、小组件标题和查询页面上。
--query string
要运行的查询的文本。
--run-as-role RunAsRole
设置对象的“以...身份运行”角色。 支持的值:owner、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 字符串
如适用,要使用的捆绑包目标