共用方式為

Databricks CLI 的基本用法

Note

此資訊適用於 Databricks CLI 0.205 版和更新版本。 Databricks CLI 處於 公開預覽狀態。

Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。

本頁會展示如何列出 Databricks CLI 指令群組與指令、顯示 Databricks CLI 說明，以及操作 Databricks CLI 輸出。 請參閱什麼是 Databricks CLI？。

要安裝並設定 Databricks CLI 的認證，請參閱 Databricks CLI 教學。

列出可用的 CLI 指令

若要列出可用的 CLI 指令群組，請使用 --help or -h 選項，例如：

databricks -h

要列出任何指令群組的指令，請使用 --help or -h 選項。 例如，若要列出 clusters 命令：

databricks clusters -h

顯示 CLI 命令說明

若要顯示指令的使用資訊，請使用 --help 該指令中的 or -h 選項。 例如，若要顯示命令的說明 clusters list ：

databricks clusters list -h

指令參考資料也可以取得。 請參閱 Databricks CLI 命令。

執行命令

完整的使用資訊與語法可在命令列說明與 參考中找到，但 Databricks CLI 指令 通常遵循以下語法：

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

並非每個命令都有額外的子命令。 全域旗標可供使用，有些命令有額外的旗標。 例如，下列命令會使用命令特定旗標輸出可用的叢集：

databricks clusters list --can-use-client JOBS

Tip

您可以使用 Web 終端機，從 Databricks 工作區內執行 Databricks CLI 命令。 Workspace 網頁終端機可讓多個使用者在單一運算系統上使用，且不需要你設定認證。 請參閱在 Azure Databricks 網路終端機中執行殼層命令。

JSON 輸入與輸出

部分 Databricks CLI 指令有 --json 旗標或其他選項，可以接受 JSON 字串輸入。 此外，有些指令會輸出 JSON 字串。

字串格式

JSON 字串的格式取決於你的作業系統：

Linux 或 macOS

將 JSON 字串參數包在雙引號中，整個 JSON 有效載荷則用單引號包圍。 例如：

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

'["20230323", "Amsterdam"]'

Windows

將 JSON 字串參數和整個 JSON payload 以雙引號包圍，並在 JSON payload 內的雙引號字元前加上反斜線（\）。 例如：

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

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

在 JSON 字串中設定欄位

許多指令的 --json 旗標讓你能設定可能無法作為 CLI 指令或選項提供的物件欄位。 例如，以下指令會將 ID 為 9ddddddd-1eee-4eee-a666-8fff7c111111 的使用者加入 ID 為 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa 的群組：

Linux 或 macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

過濾 JSON 輸出 jq

對於輸出 JSON 的 Databricks CLI 指令，你可以使用 jq 命令列處理器 來過濾輸出。 例如，只要列出具有指定叢集標識符的 Azure Databricks 叢集顯示名稱：

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

My-11.3-LTS-Cluster

您可以使用 jq Homebrew 搭配 brew install jq 在 macOS 上安裝 ，或使用 Chocolatey 搭配 choco install jq在 Windows 上安裝 。 如需有關 jq 的詳細資訊，請參閱 jq 手冊。

Proxy 伺服器組態

若要透過 Proxy 伺服器路由傳送 Databricks CLI 要求和回應，請在 Databricks CLI 安裝至 Proxy 伺服器 URL 的電腦上設定 HTTPS_PROXY 環境變數。

若要設定環境變數，請參閱作業系統的文件。

  • Last updated on