Databricks CLI 教程

注意

Databricks CLI 使用受 Databricks 许可证Databricks 隐私声明的约束,包括任何使用情况数据预配。

Databricks 命令行接口(也称为 Databricks CLI)实用工具提供了一个易于使用的接口,可从终端、命令提示符或自动化脚本自动执行Azure Databricks平台。 请参阅 Databricks CLI

本文演示如何快速安装和配置 Databricks CLI。

确认本地计算机要求

本教程做出如下假设:

安装 Databricks CLI

  1. 安装 Databricks CLI

    Linux、macOS

    运行以下两个命令,使用 Homebrew 安装 Databricks CLI:

    brew tap databricks/tap
    brew install databricks
    

    Windows

    可以使用 wingetChocolatey适用于 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 安装 curlzip。 有关详细信息,请参阅操作系统文档。

    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 工作区的访问权限。

注意

本教程使用 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 级别操作,在以下命令中,将 <workspace-url> 替换为 Azure Databricks per-workspace URL,例如 https://adb-1234567890123456.7.azuredatabricks.net

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

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

  3. 在网络浏览器中,按照屏幕上的说明完成登录 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 令牌信息。

后续步骤