共用方式為

Databricks CLI 的基本用法

  • 發行項

注意

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

Databricks CLI 使用受限於 Databricks 授權 和 Databricks 隱私權注意事項，包括任何使用量數據布建。

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

本文假設您已經安裝 Databricks CLI，並設定 CLI 以進行驗證。 請參閱安裝或更新 Databricks CLI 和 Databricks CLI 的驗證。

列出 CLI 命令群組

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

databricks -h

列出 CLI 命令

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

databricks clusters -h

顯示 CLI 命令說明

您可以使用 或 -h 選項來顯示命令--help的說明。 例如，若要顯示命令的說明 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 網路終端機中執行殼層命令。

用來 jq 篩選 JSON 輸出

某些 Databricks CLI 命令會輸出 JSON，這表示您可以使用 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 手冊。

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 環境變數。

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