Databricks CLI の基本的な使用法
注
この情報は、 パブリック プレビュー段階の Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI のバージョンを見つけるには、 databricks -v
を実行します。
この記事では、Databricks CLI コマンド グループとコマンドを一覧表示する方法、Databricks CLI ヘルプを表示する方法、および Databricks CLI 出力を操作する方法について説明します。 「Databricks CLI とは」を参照してください。
この記事では、Databricks CLI が既にインストールされ、認証用に CLI が設定されていることを前提としています。 見る:
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 を持つ Databricks クラスターの表示名のみを一覧表示するには、ユーティリティ jq
を使用できます。
databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name
アウトプット:
My-11.3-LTS-Cluster
たとえば、 jq
をインストールできます macOS では brew install jq
で自作を使用するか、Windows では choco install jq
で Chocolatey を使用します。 jq
の詳細については、jqマニュアルを参照してください。
JSON 文字列パラメーター
文字列パラメーターの形式は、オペレーティング システムに応じて JSON で異なる方法で処理されます。
JSON 文字列パラメーターは二重引用符で囲み、JSON ペイロード全体を一重引用符で囲む必要があります。 いくつかの例:
'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'
JSON 文字列パラメーターと JSON ペイロード全体を二重引用符で囲む必要があり、JSON ペイロード内の二重引用符の前に \
を付ける必要があります。 いくつかの例:
"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"
プロキシー・サーバーの構成
Databricks CLI のリクエストと応答をプロキシ サーバー経由でルーティングするには、Databricks CLI がインストールされているマシン上のHTTPS_PROXY
環境変数をプロキシ サーバーの URL に設定します。
環境変数を設定するには、ご利用になっているオペレーティングシステムのドキュメントを参照してください。
グローバル フラグ
次のフラグは、すべての Databricks CLI コマンドで使用できます。 一部のフラグは、一部のコマンドに適用されないことに注意してください。 詳細については、コマンドのドキュメントを参照してください。
旗 |
説明 |
---|---|
|
Databricks CLI または関連するコマンド グループまたは関連するコマンドのヘルプを表示します。 |
|
関連するコマンドに適用可能な場合に使用するバンドル環境を表す文字列。 |
|
出力ログの書き込み先を表す文字列。 このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。 |
|
|
|
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。 |
|
|
|
|
|
進行状況ログを表示する形式 ( |