Databricks CLI 基本用法

  • 项目

注意

此信息适用于 Databricks CLI 0.205 及更高版本，这些版本为公共预览版。 若要查找你的 Databricks CLI 的版本，请运行 databricks -v。

本文介绍如何列出 Databricks CLI 命令组和命令、显示 Databricks CLI 帮助以及处理 Databricks CLI 输出。 请参阅什么是 Databricks CLI？。

本文假定你已安装 Databricks CLI 并设置 CLI 身份验证。 请参阅：

列出 CLI 命令组

使用 --help 或 -h 选项列出命令组。 例如：

databricks -h

列出 CLI 命令

使用 --help 或 -h 选项列出任何命令组的命令。 例如，若要列出 clusters 命令，请运行：

databricks clusters -h

显示 CLI 命令帮助

使用 --help 或 -h 选项显示命令的帮助。 例如，若要显示 clusters list 命令的帮助，请运行：

databricks clusters list -h

使用 jq 分析 CLI JSON 输出

某些 Databricks CLI 命令输出响应采用 JSON 格式。 在许多情况下，Databricks CLI 会设置 JSON 输出格式以方便阅读。 但在某些情况下，分析出 JSON 的组成部分而不是列出整个响应可能很有用。 例如，若要仅列出具有指定群集 ID 的 Azure Databricks 群集的显示名称，可以使用实用工具 jq：

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

输出：

My-11.3-LTS-Cluster

例如，可以使用 Homebrew 和 brew install jq（在 macOS 上）或使用 Chocolatey 和 choco install jq（在 Windows 上）来安装 jq。 有关 jq 的详细信息，请参阅 jq。

JSON 字符串参数

根据所用的操作系统，在 JSON 中处理字符串参数格式的方式有所不同：

Linux 或 macOS

必须将 JSON 字符串参数括在双引号中，并且必须将整个 JSON 有效负载括在单引号中。 下面是一些示例：

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

必须将 JSON 字符串参数和整个 JSON 有效负载括在双引号中，并且 JSON 有效负载中的双引号字符前面必须带有 \。 以下是一些示例：

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

代理服务器配置

若要通过代理服务器路由 Databricks CLI 请求和响应，请在将 Databricks CLI 安装到代理服务器 URL 的计算机上设置 HTTPS_PROXY 环境变量。

若要设置环境变量，请参阅操作系统对应的文档。

全局标志

以下标志可用于所有 Databricks CLI 命令。 请注意，某些标志不适用于某些命令。 有关详细信息，请参阅命令的文档。

标志 描述
-h 或 --help 显示 Databricks CLI、相关命令组或相关命令的帮助。
-e 或 --environment string 一个字符串，表示要使用的捆绑环境（如果适用于相关命令）。
--log-file 一个字符串，表示要将输出日志写入到的位置。 如果未指定此标志，则默认会将输出日志写入到 stderr。
--log-format 如果设置为 text，则以文本格式写入输出日志；如果设置为 json，则以 JSON 格式写入输出日志。 如果未指定此标志，则以文本格式写入输出日志。
--log-level 一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。
-o 或 --output 如果设置为 text，则以文本格式写入输出；如果设置为 json，则以 JSON 格式写入输出。 如果未指定此标志，则以文本格式写入输出。
-p 或 --profile 一个字符串，表示要在 .databrickscfg 文件中使用的命名配置文件。 如果未指定此标志，则使用 DEFAULT 命名配置文件（如果存在）。 可以在 --profile 或 -p 之后按 Tab 以显示可供选择的现有可用配置文件的列表，而不是手动输入配置文件名称。
--progress-format 要显示的进度日志的格式（default（默认值）、append、inplace 或 json）。