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

Databricks CLI チュートリアル

注記

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

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

Databricks コマンドラインインターフェイス (Databricks CLI とも呼ばれます) ユーティリティは、ターミナル、コマンドプロンプト、または自動化スクリプトから Databricks プラットフォームを自動化するための使いやすいインターフェイスを提供します。「Databricks CLI とは」を参照してください。

この記事では、Databricks CLI をすばやくインストールして構成する方法について説明します。

ローカルマシンの要件を確認する​

このチュートリアルでは、次のことを前提としています。

  • LinuxまたはmacOSの場合、Homebrewがインストールされています。
注記

Homebrew を使用できない場合、CLI をインストールする他の方法については、「 Databricks CLI のインストールまたは更新」を参照してください。

注記

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

winget、Chocolatey、または WSL を使用できない場合、CLI を他の方法でインストールするには、「Databricks CLI のインストールまたは更新」を参照してください。

Databricks CLI をインストールする​

まず、Databricks CLI をインストールします。

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

Use Homebrew to install the Databricks CLI by running the following two commands:

Bash
brew tap databricks/tap
brew install databricks

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

    Bash
    databricks -v
注記

databricksを実行しても command not found: databricksなどのエラーが表示される場合、または databricks -v を実行してバージョン番号 0.18 以下がリストされている場合は、マシンで Databricks CLI 実行可能ファイルの正しいバージョンが見つからないことを意味します。これを修正するには、 CLI インストールの確認を参照してください。

ワークスペースへのアクセスを構成する​

次に、Databricks ワークスペースへのアクセスを構成します。

注記

このチュートリアルでは、OAuth ユーザー間 (U2M) 認証を使用して、Databricks ユーザー アカウントを使用して CLI を認証します。他の Databricks 認証の種類を使用するように CLI を構成するには、「 Databricks CLI の認証」を参照してください。

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

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

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

    ワークスペース レベルの操作の場合は、次のコマンドで、<workspace-url> を Databricks ワークスペース インスタンスの URL に置き換えます (例: https://1234567890123456.7.gcp.databricks.com)。

    Bash
    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オプションを一緒に指定する必要がある場合があります。

次のステップ​

に最終更新