Databricks CLI 的基本用法

  • 發行項

注意

此資訊適用於處於公開預覽狀態 的 Databricks CLI 0.205 版和更新版本。 若要尋找 Databricks CLI 版本請執行 databricks -v。

本文說明如何列出 Databricks CLI 命令群組和命令、顯示 Databricks CLI 說明，以及使用 Databricks CLI 輸出。 請參閱 什麼是 Databricks CLI？。

本文假設您已經安裝 Databricks CLI，並設定 CLI 以進行驗證。 請參閱：

列出 CLI 命令群組

您可以使用 或 -h 選項來列出命令群組--help。 例如：

databricks -h

列出 CLI 命令

您可以使用 或 -h 選項列出任何命令群組的--help命令。 例如，若要列出 clusters 命令：

databricks clusters -h

顯示 CLI 命令說明

您可以使用 或 -h 選項來顯示命令--help的說明。 例如，若要顯示命令的說明 clusters list ：

databricks clusters list -h

用來 jq 剖析 CLI JSON 輸出

某些 Databricks CLI 命令輸出回應會格式化為 JSON。 在許多情況下，Databricks CLI 會格式化 JSON 輸出，以便更容易閱讀。 不過，有時候剖析 JSON 部分，而不是列出整個回應會很有用。 例如，若要只列出具有指定叢集標識符的 Azure Databricks 叢集顯示名稱，您可以使用 公用程式 jq：

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

輸出：

My-11.3-LTS-Cluster

例如，您可以使用 jq Homebrew 搭配 或搭配使用 Chocolatey 搭配 brew install jqchoco install jq在 Windows 上安裝 ，例如在 macOS 上安裝 。 如需 的詳細資訊 jq，請參閱 jq Manual。

JSON 字串參數

字串參數的格式會根據作業系統以 JSON 不同方式處理：

Linux 或 macos

您必須以雙引弧括住 JSON 字串參數，而且您必須以單引弧括住整個 JSON 承載。 一些範例：

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

'["20230323", "Amsterdam"]'

Windows

您必須以雙引弧括住 JSON 字串參數和整個 JSON 承載，而且 JSON 承載內的雙引號字元前面必須加上 \。 一些範例：

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

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

Proxy 伺服器組態

若要透過 Proxy 伺服器路由傳送 Databricks CLI 要求和回應，請在 Databricks CLI 安裝至 Proxy 伺服器 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 則會使用具名配置檔。 您可以按 Tab 或 --profile-p 來顯示現有可用組態配置檔的清單，以從中選擇，而不是手動輸入組態配置檔名稱。
--progress-format 要顯示進度記錄的格式（default 預設值）或 appendinplacejson。