Databricks CLIチュートリアル

注：

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

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

Databricksコマンドラインインターフェイス（Databricks CLIとも呼ばれます）ユーティリティは、ターミナル、コマンドプロンプト、または自動化スクリプトからDatabricksプラットフォームを自動化する使いやすいインターフェイスを提供します。

この記事では、ローカル開発マシンを使用してDatabricks CLIをすぐに使い始める方法を紹介します。詳しくは、「Databricks CLIとは」を参照してください。

次のハンズオン・チュートリアルでは、以下の条件が前提となります。

以下のステップを実行します。

  1. まだインストールされていない場合は、以下のようにDatabricks CLIをインストールします。

    Homebrewを使用して、以下の2つのコマンドを実行してDatabricks CLIをインストールします。

    brew tap databricks/tap
brew install databricks

    winget、Chocolatey、またはWindows Subsystem for Linux (WSL) を使用して、Databricks CLIをインストールできます。winget、Chocolatey、またWSLを使用できない場合は、この手順をスキップし、代わりにコマンドプロンプトまたはPowerShellを使用してソースからDatabricks CLIをインストールしてください。

    注：

    Chocolateyを使用したDatabricks CLIのインストールは実験段階です。

    wingetを使用してDatabricks CLIをインストールするには、次の2つのコマンドを実行してから、コマンドプロンプトを再起動します。

    winget search databricks
winget install Databricks.DatabricksCLI

    Chocolateyを使用してDatabricks CLIをインストールするには、以下のコマンドを実行します：

    choco install databricks-cli

    WSLを使用してDatabricks CLIをインストールするには：

    1. WSL経由でcurlとzipインストールします。詳しくは、お使いのオペレーティングシステムのマニュアルをご覧ください。

    2. WSLを使用して、以下のコマンドを実行してDatabricks CLIをインストールします。

      curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh

  2. 次のコマンドを実行して、Databricks CLIがインストールされていることを確認します。これにより、Databricks CLIの現在のバージョンが表示されるので、そのバージョンが0.205.0以降であることを確認します。

    databricks -v

    注：

    databricksを実行したが、command not found: databricksのようなエラーが表示された場合、またはdatabricks -v を実行し、0.18以前のバージョン番号が表示された場合は、ご使用のマシンでDatabricks CLIの実行可能な正しいバージョンが見つからなかったことを示しています。この問題を解決するには、「CLIのインストールを確認する」を参照してください。

Databricks CLIをインストールしたら、次の手順をステップします。

注：

このチュートリアルでは、OAuth ユーザー対マシン (U2M) 認証を使用して、Databricksユーザーアカウントを使用してCLIを認証することを想定しています。他のDatabricks認証タイプを使用するようにCLIを設定するには、「Databricks CLIの認証」を参照してください。

  1. Databricks CLIを使用して、ターゲットアカウントまたはワークスペースごとに以下のコマンドを実行し、ローカルでOAuthトークン管理を開始します。

    アカウントレベルの操作については、以下のコマンドでプレースホルダーを置き換えてください：

    databricks auth login --host <account-console-url> --account-id <account-id>

    ワークスペースレベルの操作では、以下のコマンドで<workspace-url>をDatabricksワークスペースインスタンスのURL（例：https://1234567890123456.7.gcp.databricks.com）に置き換えてください。

    databricks auth login --host <workspace-url>

  2. Databricks CLIは、入力した情報をDatabricks構成プロファイルとして保存するよう促します。Enterを押して提案されたプロファイル名を受け入れるか、新規または既存のプロファイルの名前を入力してください。同じ名前の既存のプロファイルは、入力した情報で上書きされます。プロファイルを使用すると、複数のアカウントやワークスペース間で認証コンテキストをすばやく切り替えることができます。

    既存のプロファイルのリストを取得するには、別のターミナルまたはコマンドプロンプトでDatabricks CLIを使用してコマンドdatabricks auth profilesを実行します。特定のプロファイルの既存の設定を表示するには、コマンドdatabricks auth env --profile <profile-name>を実行します。

  3. ウェブブラウザで、画面の指示に従ってDatabricksアカウントまたはワークスペースにログインします。

  4. プロファイルの現在のOAuthトークンの値と、トークンの有効期限を表示するには、次のいずれかのコマンドを実行します：

    アカウントレベルの操作では、以下のコマンドを実行してください：

    • databricks auth token -p <profile-name>

    • databricks auth token --host <workspace-url> --account-id <account-id>

    • databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>

    --hostと--account-idの値が同じプロファイルが複数ある場合は、Databricks CLIが一致するOAuthトークン情報を正しく見つけられるように、--host、--account-id、-pオプションをまとめて指定する必要がある場合があります。

    ワークスペースレベルの操作では、以下のコマンドを実行してください：

    • databricks auth token -p <profile-name>

    • databricks auth token --host <workspace-url>

    • databricks auth token --host <workspace-url> -p <profile-name>

    同じ--host値を持つプロファイルが複数ある場合、Databricks CLIが正しいOAuthトークン情報を見つけられるように--hostと-pオプションを一緒に指定する必要がある場合があります。

次のステップ

Databricks CLIをセットアップしたら：