メインコンテンツまでスキップ
に最終更新

Databricks CLI の基本的な使用方法

注記

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

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

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

Databricks CLI の認証をインストールして構成するには、 「Databricks CLI チュートリアル」を参照してください。

利用可能なCLIコマンドを一覧表示​

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

Bash
databricks -h

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

Bash
databricks clusters -h

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

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

Bash
databricks clusters list -h

コマンドリファレンスも利用可能です。Databricks CLI コマンドを参照してください。

コマンドを実行する​

個々のコマンドの完全な使用法情報と構文は、コマンドラインのヘルプとリファレンスに記載されていますが、 Databricks CLIコマンドは通常、次の構文に準拠しています。

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

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

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

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

JSON入力と出力​

一部の Databricks CLI コマンドには、JSON 文字列入力を受け入れる--jsonフラグまたはその他のオプションがあります。さらに、一部のコマンドは JSON 文字列を出力します。

文字列のフォーマット​

JSON 文字列の形式はオペレーティング システムによって異なります。

JSON文字列問題を二重引用符で囲み、 JSONペイロード全体を一重引用符で囲みます。 例えば：

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

JSON文字列にフィールドを設定する​

多くのコマンドの--jsonフラグを使用すると、CLI コマンドまたはオプションとして使用できないオブジェクト フィールドを設定できます。たとえば、次の呼び出しは、ID 9ddddddd-1eee-4eee-a666-8fff7c111111を持つユーザーを ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaaを持つグループに追加します。

Bash
databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

JSON出力をフィルタリングする jq​

JSONを出力するDatabricks CLIコマンドの場合、 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のマニュアルを参照してください。

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

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

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