メインコンテンツまでスキップ

Databricks CLI の基本的な使用方法

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。

Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。

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

この記事では、Databricks CLI を既にインストールし、認証用に CLI を設定していることを前提としています。 「Databricks CLI のインストールまたは更新」および「Databricks CLI の認証」を参照してください。

CLI コマンド グループの一覧​

コマンド グループを一覧表示するには、 --help または -h オプションを使用します。 例えば：

Bash
databricks -h

CLI コマンドの一覧表示​

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

Bash
databricks clusters -h

CLI コマンド・ヘルプの表示​

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

Bash
databricks clusters list -h

コマンドを実行する​

個々のコマンドの詳細な使用法に関する情報と構文は、コマンドラインのヘルプにありますが、 Databricks CLI コマンドは通常、 次の構文に準拠しています。

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

すべてのコマンドに追加のサブコマンドがあるわけではありません。 グローバル フラグ が使用可能であり、一部のコマンドには追加のフラグがあります。 たとえば、次のコマンドは、コマンド固有のフラグを使用して、使用可能なクラスターを出力します。

Bash
databricks clusters list --can-use-client JOBS
ヒント

ワークスペース内から DatabricksCLIコマンドを実行するには、Webターミナルを使用します。DatabricksWebターミナルは、1つのコンピュートで多くのユーザーが使用でき、キーの設定は必要ありません。 「Databricks Webターミナルの実行 シェル コマンド」を参照してください。

jqを使用してJSON出力をフィルタリングする​

一部の Databricks CLI コマンドは JSON を出力するため、 jq を使用して出力をフィルター処理できます。 たとえば、指定したクラスター ID を持つ Databricks クラスターの表示名だけを一覧表示するには、次のようにします。

Bash
databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name
Output
My-11.3-LTS-Cluster

jqは、Homebrew with brew install jqを使用してmacOSにインストールするか、WindowsでChocolateyとchoco install jqを使用してインストールできます。jqの詳細については、jqのマニュアルを参照してください。

JSON 文字列パラメーター​

文字列 パラメーターの形式は、オペレーティング システムによって JSON で異なる方法で処理されます。

You must enclose JSON string parameters in double quotes, and you must enclose the entire JSON payload in single quotes. Some examples:

'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'

プロキシサーバーの構成​

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

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

に最終更新