Amazon
Web Services
Microsoft Azure
Google Cloud PlatformDatabricks 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 コマンドのリスト
コマンド グループのコマンドを一覧表示するには、[ --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
ヒント
Web ターミナルを使用して、 ワークスペース内から DatabricksCLIコマンドを実行できます。DatabricksWebターミナルは、1つのコンピュート上で複数のユーザーが使用することができ、キーの設定は必要ありません。 Databricks Web ターミナルで シェル コマンドの実行 を参照してください。
JSON出力をフィルタリングするにはjq使用します
一部の Databricks CLI コマンドは JSON を出力するため、 jqを使用して出力をフィルター処理できます。 たとえば、指定されたクラスター ID を持つ 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 で異なる方法で処理されます。
JSON 文字列パラメーターは二重引用符で囲み、JSON ペイロード全体を一重引用符で囲む必要があります。 いくつかの例:
'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'
JSON 文字列パラメーターと JSON ペイロード全体を二重引用符で囲む必要があり、JSON ペイロード内の二重引用符の前に \を付ける必要があります。 いくつかの例:
"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"