Databricks CLI 教程

  • 项目

注意

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

Databricks 命令行接口（也称为 Databricks CLI）实用工具提供了一个易用的接口，让用户通过终端、命令提示符或自动化脚本自动化 Azure Databricks 平台。

本文演示了如何使用本地开发计算机快速开始使用 Databricks CLI。 请参阅什么是 Databricks CLI？。

以下动手教程假定：

请完成下列步骤：

  1. 如果尚未安装，请安装 Databricks CLI，如下所示：

    Linux、macos

    运行以下两个命令，使用 Homebrew 安装 Databricks CLI：

    brew tap databricks/tap
brew install databricks

    Windows

    可以使用 winget、Chocolatey 或适用于 Linux 的 Windows 子系统 (WSL) 安装 Databricks CLI。 如果无法使用 winget、Chocolatey 或 WSL，则应跳过此过程，改为使用命令提示符或 PowerShell 从源安装 Databricks CLI。

    注意

    使用 Chocolatey 安装 Databricks CLI 是试验性的。

    若要使用 winget 安装 Databricks CLI，请运行以下两个命令，然后重启命令提示符：

    winget search databricks
winget install Databricks.DatabricksCLI

    若要使用 Chocolatey 安装 Databricks CLI，请运行以下命令：

    choco install databricks-cli

    若要使用 WSL 安装 Databricks CLI：

    1. 通过 WSL 安装 curl 和 zip。 有关详细信息，请参阅操作系统文档。

    2. 使用 WSL 通过运行以下命令来安装 Databricks CLI：

      curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh

  2. 通过运行以下命令确认安装了 Databricks CLI，该命令显示已安装的 Databricks CLI 的当前版本。 此版本应为 0.205.0 或更高版本：

    databricks -v

    注意

    如果运行 databricks 但收到错误（如 command not found: databricks），或者如果运行 databricks -v 而列出的版本号为 0.18 或更低，则表示计算机找不到正确版本的 Databricks CLI 可执行文件。 若要修复此问题，请参阅验证 CLI 安装。

安装 Databricks CLI 后，完成以下步骤：

注意

本教程假设你想要使用 OAuth 用户到计算机 (U2M) 身份验证通过 Azure Databricks 用户帐户对 CLI 进行身份验证。 要将 CLI 配置为使用其他 Databricks 身份验证类型，请参阅Databricks CLI 身份验证。

  1. 通过对每个目标帐户或工作区运行以下命令，使用 Databricks CLI 在本地启动 OAuth 令牌管理。

    对于帐户级操作，请在以下命令中替换以下占位符：

    databricks auth login --host <account-console-url> --account-id <account-id>

    对于工作区级操作，请在以下命令中，将 <workspace-url> 替换为 Azure Databricks 每工作区 URL，例如 https://adb-1234567890123456.7.databricks.azure.cn。

    databricks auth login --host <workspace-url>

  2. Databricks CLI 会提示将输入的信息保存为 Azure Databricks 配置文件。 按 Enter 接受建议的配置文件名称，或输入新的或现有的配置文件的名称。 任何具有相同名称的现有配置文件都会被输入的信息覆盖。 可以使用配置文件在多个帐户或工作区之间快速切换身份验证上下文。

    若要获取任何现有配置文件的列表，请在单独的终端或命令提示符中使用 Databricks CLI 来运行 databricks auth profiles 命令。 要查看特定配置文件的现有设置，请运行命令 databricks auth env --profile <profile-name>。

  3. 在 Web 浏览器中，按照屏幕上的说明登录到 Azure Databricks 帐户或工作区。

  4. 要查看配置文件的当前 OAuth 令牌值和令牌即将过期的时间戳，请运行以下命令之一：

    对于帐户级操作，请运行以下命令：

    • databricks auth token -p <profile-name>
    • databricks auth token --host <workspace-url> --account-id <account-id>
    • databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>

    如果你有多个配置文件具有相同的 --host 和 --account-id 值，你可能需要同时指定 --host、--account-id 和 -p 选项，以便 Databricks CLI 找到正确且匹配的 OAuth 令牌信息。

    对于工作区级操作，请运行以下命令：

    • databricks auth token -p <profile-name>
    • databricks auth token --host <workspace-url>
    • databricks auth token --host <workspace-url> -p <profile-name>

    如果你有多个配置文件具有相同的 --host 值，你可能需要同时指定 --host 和 -p 选项，以便 Databricks CLI 找到正确且匹配的 OAuth 令牌信息。

后续步骤

设置完 Databricks CLI 后：