Databricks CLI の基本的な使用法

注

この情報は、パブリックプレビュー段階の 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 を持つ 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 コマンドで使用できます。一部のフラグは、一部のコマンドに適用されないことに注意してください。詳細については、コマンドのドキュメントを参照してください。

旗	説明
`-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`)。