通过

Databricks CLI 基本用法

  • 项目

注意

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

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

本文假定你已安装 Databricks CLI 并设置 CLI 身份验证。 请参阅安装或更新 Databricks CLI 和 Databricks CLI 的身份验证。

列出 CLI 命令组

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

databricks -h

列出 CLI 命令

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

databricks clusters -h

显示 CLI 命令帮助

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

databricks clusters list -h

运行命令

可以在命令行帮助中找到各个命令的完整用法信息和语法，但 Databricks CLI 命令通常符合以下语法：

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

并非每个命令都额外具有子命令。 全局标志可用，某些命令具有额外的标志。 例如，以下命令使用特定于命令的标志输出可用群集：

databricks clusters list --can-use-client JOBS

提示

可以使用 Web 终端从 Databricks 工作区中运行 Databricks CLI 命令。 Web 终端可由许多用户在同一计算资源上使用，不需要设置密钥。 请参阅在 Azure Databricks Web 终端中运行 Shell 命令。

使用 jq 筛选 JSON 输出

某些 Databricks CLI 命令会输出 JSON，这意味着可以使用 jq 来筛选输出。 例如，若要仅列出具有指定群集 ID 的 Azure Databricks 群集的显示名称，请使用以下命令：

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 环境变量。

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