Databricks CLI チュートリアル

この情報は、 パブリック プレビュー段階の Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI のバージョンを見つけるには、 databricks -vを実行します。

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

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

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

次のステップを完了します。

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

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

    brew tap databricks/tap
    brew install databricks
    

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

    Databricks CLI と Chocolatey のインストールは 実験段階です。

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

    winget search databricks
    winget install Databricks.DatabricksCLI
    

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

    choco install databricks-cli
    

    WSL を使用して Databricks CLI をインストールするには、次のようにします。

    1. WSL を使用して curlzip をインストールします。 詳細については、オペレーティング システムのマニュアルを参照してください。

    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://dbc-a1b2345c-d6e7.cloud.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. Web ブラウザーで、画面上の指示に従って 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 をセットアップした後、次の手順を実行します。