Databricks CLI チュートリアル

  • [アーティクル]

Note

この情報は、パブリック プレビュー段階である Databricks CLI バージョン 0.205 以降に当てはまる内容です。 お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

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

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

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

次の手順を完了します。

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

    Linux、MacOS

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

    brew tap databricks/tap
brew install databricks

    Windows

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

    Note

    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

    Note

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

Databricks CLI をインストールした後、次の手順を完了します。

Note

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

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

    アカウント レベルの操作の場合は、次のコマンドで次のプレースホルダーを置き換えてください。

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

    ワークスペース レベルの操作の場合は、次のコマンドで、<workspace-url> を Azure Databricks のワークスペースごとの URL (https://adb-1234567890123456.7.azuredatabricks.net など) に置き換えてください。

    databricks auth login --host <workspace-url>

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

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

  3. Web ブラウザー内で、画面の指示に従って Azure 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 の設定後: