Databricks CLI の基本的な使用方法

この記事では、Databricks CLI コマンド グループおよびコマンドを一覧表示する、Databricks CLI ヘルプを表示する、Databricks CLI 出力を操作する方法について示します。 「Databricks CLI とは」をご参照ください。

この記事では、Databricks CLI をインストール済みで、CLI を認証用に設定済みであることを前提としています。 「Databricks CLI のインストールまたは更新」と「Databricks CLI の認証」をご覧ください。

CLI コマンド グループを一覧表示する

--help または -h オプションを使用すると、コマンド グループが一覧表示されます。 次に例を示します。

databricks -h

CLI コマンドを一覧表示する

--help または -h オプションを使用すると、任意のコマンド グループのコマンドが一覧表示されます。 たとえば、clusters コマンドを一覧表示するには、次のようにします。

databricks clusters -h

CLI コマンドのヘルプを表示する

コマンドのヘルプを表示する場合は、--help または -h オプションを使用します。 たとえば、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

jq を使用して JSON 出力をフィルター処理する

Databricks CLI コマンドの中には JSON を出力するものがあります。つまり、jq を使用して出力をフィルター処理できます。 たとえば、指定したクラスター ID を持つ Azure Databricks クラスターの表示名のみを一覧表示するには、以下を使用します。

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

My-11.3-LTS-Cluster

jq をインストールするには、macOS の場合は Homebrew を使用して brew install jq を指定します。Windows の場合は Chocolatey を使用して choco install jq を指定します。 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\"]"

プロキシ サーバーの構成

Databricks CLI の要求と応答をプロキシ サーバー経由でルーティングするには、Databricks CLI がインストールされているマシンで HTTPS_PROXY 環境変数をプロキシ サーバーの URL に設定します。

環境変数を設定するには、オペレーティング システムのドキュメントを参照してください。