Databricks CLI の基本的な使用方法

  • [アーティクル]

Note

この情報は、パブリック プレビュー段階である Databricks CLI バージョン 0.205 以降に当てはまる内容です。 お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

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

この記事では、Databricks CLI をインストール済みで、CLI を認証用に設定済みであることを前提としています。 参照トピック

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

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

databricks -h

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

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

databricks clusters -h

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

コマンドのヘルプを表示する場合は、--help または -h オプションを使用します。 たとえば、clusters list コマンドのヘルプを表示するには、次のようにします。

databricks clusters list -h

jq を使用して CLI の JSON 出力を解析する

一部の Databricks CLI コマンドの出力応答は JSON 形式です。 多くの場合、Databricks CLI は読みやすくするために JSON 出力を書式設定します。 ただし、場合によっては、応答全体を一覧表示するのではなく、JSON の一部を解析する方が便利な場合があります。 たとえば、指定したクラスター ID を持つ Azure Databricks クラスターの表示名のみを一覧表示するには、ユーティリティ jq を使用して次のようにします。

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 に設定します。

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

グローバル フラグ

次のフラグは、すべての 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 名前付きプロファイルが使用されます。 --profile または -p の後に Tab を押すと、構成プロファイル名を手動で入力する代わりに、既存の使用できる構成プロファイルの一覧を表示して、そこから選択することができます。
--progress-format 進行状況ログが表示される形式 (default (既定値) または appendまたは inplace または json)。