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

Databricks プロジェクトを構成する

Databricks IDE拡張機能は、拡張機能内に[ 構成 ]ビューを提供しており、Databricksプロジェクトの設定を簡単に構成および更新できます。これらの機能には、ローカルフォルダー設定、AIツールのインストール、ターゲットワークスペースデプロイメントセレクター、認証とコンピュートの簡単な構成、ワークスペースフォルダーの同期、およびデバッグに必要なPython仮想環境をアクティブ化するためのシンプルなステップが含まれます。

Databricks IDE 拡張機能内の Configuration ビューは、プロジェクトを作成するか、Databricks プロジェクトに移行すると利用可能になります。新しい Databricks プロジェクトを作成するを参照してください。

注記

Databricks IDE拡張機能の以前のバージョンでは、構成設定はプロジェクトのJSONファイルで定義され、環境変数はターミナルで設定されていました。リリースバージョンでは、プロジェクトおよび環境の構成は databricks.yml ファイルと databricks.env ファイルにあります。

プロジェクトが Databricks Asset Bundle の場合、Databricks拡張機能UIには、バンドルのリソースと変数を管理するための Bundle Resource ExplorerBundle Variables View も用意されています。バンドルおよびエクスプローラーの機能を参照してください。

ローカルフォルダーを設定する

Databricks プロジェクト用に別のローカルフォルダを選択するには、 設定 ビューの ローカルフォルダ エントリに関連付けられている歯車アイコンをクリックします。

AI ツールのインストールと使用

備考

ベータ版

この機能はベータ版です。

設定 ビューの AI ツール セクションでは、コーディングエージェントが Databricks で効果的に動作するように AI ツールをインストールできます。この拡張機能は、Databricks CLI を通じて実行したインストールを含め、AI ツールがグローバルスコープまたはプロジェクトスコープでインストールされているかどうかを確認し、表示されているステータスを更新します。AI ツールの詳細については、「AI コーディングアシスタント向けのエージェントスキル」および「aitools コマンドグループ」を参照してください。

AI ツールをインストールするには:

  1. 拡張機能の 構成 ビューで、 AIツールのインストール をクリックします。
  2. 画面の指示に従ってスコープとツールを選択し、インストールを完了してください。

AI ツールがインストールされると、 AI ツール の横に緑色のロボットアイコンが表示されます。AI ツールは自動的に最新バージョンにアップデートされます。

Databricks 拡張機能の AI ツール

AIツールをアンインストールするには、 AIツール を右クリックし、 AIツールのアンインストール を選択します。

ターゲット・デプロイメント・ワークスペースの変更

Databricks プロジェクトのデプロイ ターゲットを選択または切り替えるには (たとえば、 dev ターゲットから prod ターゲットに切り替えるには):

  1. Databricks 拡張機能の Configuration ビューで、 Target に関連付けられている歯車アイコン ( Select a Databricks Asset Bundle target ) をクリックします。

    バンドル対象を選択してください

  2. コマンド パレット で、目的のデプロイ ターゲットを選択します。

ターゲットが設定されると、 ホスト と展開 Mode が表示されます。 宣言型自動化バンドルのデプロイモードに関する情報については、 「宣言型自動化バンドルのデプロイモード」を参照してください。

ワークスペース ホストは、プロジェクトに関連付けられている databricks.yml 構成ファイルのターゲット workspace設定を変更することで変更できます。「ターゲット」を参照してください。

注記

以下の Databricks IDE 拡張機能は、ターゲットのデプロイ モードが開発の場合にのみ使用できます:

  • 添付の development クラスターをバンドルジョブに使用する
  • ワークスペースフォルダファイルを同期する
  • 対話型開発クラスターの選択

プロジェクトの Databricks プロファイルを構成する

Databricks プロジェクト を作成する とき、またはプロジェクトを Databricks プロジェクト に変換する ときは、Databricks への接続に使用される認証設定を含むプロファイルを構成します。 使用する認証プロファイルを変更する場合は、 設定 ビューで AuthType に関連付けられている歯車アイコンをクリックします。

Databricks IDE 拡張機能の認証の詳細については、Databricks IDE 拡張機能の承認を設定するを参照してください。

コードとジョブを実行するためのコンピュートを選択

Databricks IDE拡張機能を使用すると、Serverlessを選択したり、既存のDatabricksクラスターを選択したり、新しいDatabricksクラスターを作成したりして、コードとジョブを実行できます。コンピュートに接続すると、クラスターのID、Databricks Runtimeバージョン、作成者、状態、アクセスモードが表示されます。また、クラスターの起動と停止を行ったり、クラスターの詳細ページに直接移動したりすることもできます。

ヒント

ジョブ クラスターが起動するのを待たない場合は、クラスター選択のすぐ下にある [Override Jobs clustering] (バンドル内のジョブ クラスターをオーバーライド する) をオンにして、選択したクラスターを開発モードでバンドル ジョブを実行するために使用します。 サーバレス コンピュートを使用している場合は使用できません。

サーバレスを使用する

サーバレス コンピュートは Databricksによって管理されています。 サーバレス コンピュートでワークロードを実行すると、必要なコンピュート リソースが自動的に割り当てられ、管理 Databricks 。

  1. 「Configuration」 ビューで、 「Select コンピュート」 をクリックするか、歯車( 「Configure コンピュート」 )アイコンをクリックします。

    コンピュートを構成する

  2. コマンド パレット で、[ サーバレス ] を選択します。

    サーバレス コンピュート selection

既存のクラスターを使用する

使用する既存の Databricks クラスターがある場合:

  1. 「Configuration」 ビューで、 「Select コンピュート」 をクリックするか、歯車( 「Configure コンピュート」 )アイコンをクリックします。

  2. コマンド パレット で、使用するクラスターを選択します。

新しいクラスターを作成する

既存の Databricks クラスターがない場合、または新しいクラスターを作成する場合は、次のようにします。

  1. 「Configuration」 ビューで、 「Select コンピュート」 をクリックするか、歯車( 「Configure コンピュート」 )アイコンをクリックします。

  2. コマンド パレット で、[ 新しいクラスターの作成 ] をクリックします。

  3. 外部 Web サイト (Databricks ワークスペース) を開くように求められたら、[ 開く ] をクリックします。

  4. メッセージが表示されたら、Databricks ワークスペースにサインインします。

  5. 指示に従って クラスターを作成します

注記

Databricksパーソナル コンピュート クラスターを作成することをお勧めします。これにより、ワークロードの実行をすぐに開始でき、コンピュート管理のオーバーヘッドを最小限に抑えることができます。

  1. クラスターが作成されて実行されたら、Visual Studio Code に戻ります。

  2. 「構成」 ビューで、クラスターの横にある歯車( 「コンピュートの構成」 )アイコンをクリックします。

    クラスター アイコン 3 の構成

    コマンド パレット で、使用するクラスターをクリックします。

ワークスペース フォルダーを Databricks と同期する

Databricks 拡張機能の Configuration ビューで Remote Folder に関連付けられている同期アイコン( Start synchronization )をクリックすることで、Databricks プロジェクトに関連付けられたリモート Databricks ワークスペース フォルダーを同期できます。

注記

Databricks IDE 拡張機能は、作成したワークスペースディレクトリでのみ機能します。拡張機能によって作成されたものでない限り、プロジェクト内の既存のワークスペースディレクトリを使用することはできません。

Databricks のワークスペース ビューに移動するには、 リモート フォルダー に関連付けられている外部リンク アイコン ( 外部リンクを開く) アイコンをクリックします。

この拡張機能は、プロジェクトに関連付けられたバンドル構成のworkspaceマッピングのfile_path設定に基づいて、使用する Databricks ワークスペースフォルダを決定します。See ワークスペース.

注記

Databricks IDE拡張機能は、ローカルのVisual Studio CodeプロジェクトからリモートのDatabricksワークスペース内の関連ワークスペースフォルダーへの、一方向の自動ファイル同期のみを実行します。このリモート ワークスペース ディレクトリ内のファイルは、一時的なものとして意図されています。リモート ワークスペース内からこれらのファイルへの変更を開始しないでください。これらの変更はローカル プロジェクトに同期されません。

Databricks IDE 拡張機能の以前のバージョンにおけるワークスペースディレクトリ同期機能の使用方法の詳細については、Databricks IDE 拡張機能のワークスペースディレクトリを選択するを参照してください。

SSHトンネルを起動する

備考

ベータ版

この機能はベータ版です。

Databricks IDE 拡張機能から SSH トンネルを起動して、Databricks コンピュート上でリモート開発セッションを開くことができます。これにより、Visual Studio Code 内から直接ファイルを編集し、リモート コンピュートに対してコードをランできるようになります。

  1. SSH トンネルを開始するには、拡張機能の [SSH tunnel] ビューで [Start SSH Tunnel] ボタンをクリックします。

  2. 次に、接続先のクラシックコンピュートまたはServerlessコンピュートを選択します:

    • クラスター : クラスターピッカーには、専用(シングルユーザー)アクセスモードを使用するクラスターのみが表示されます。ローカルのVisual Studio Codeセッションでシングルユーザークラスターが既に選択されている場合、そのクラスターがSSH接続用に事前選択されます。
    • Serverless : クラスターを選択しない場合、トンネルはdefaultでサーバーレス コンピュートに接続します。

トンネルを起動すると、現在使用しているのと同じIDEで新しいVisual Studio Codeインスタンスが開きます。リモートセッションはdefaultでホームフォルダー(users/username@databricks.com)を開き、アクティブに編集していた特定のファイルを自動的に表示します。認証は事前構成されているため、リモートセッションに接続するために再度サインインする必要はありません。

Python 環境と Databricks Connect をセットアップする

[構成 ] ビューの [Python 環境 ] セクションでは、Python 仮想開発環境のセットアップと、コードとノートブックセルの実行とデバッグのための Databricks Connect のインストールを簡単に行うことができます。Python 仮想環境では、プロジェクトで互換性のあるバージョンの Python と Python パッケージ (この場合は Databricks Connect パッケージ) が使用されていることを確認します。

プロジェクトのPython 仮想環境 を構成するには、拡張機能の 構成 ビューで以下を行います:

  1. 「Python Environment 」の下にある赤い 「Activate Virtual Environment 」項目をクリックします。
  2. コマンド パレット で、[Venv] または [Conda] を選択します。
  3. インストールする依存関係を選択します (存在する場合)。

環境を変更するには、 アクティブ環境に関連付けられている歯車アイコン仮想環境を変更 )をクリックします。

Visual Studio Code 内でのコードやノートブックの実行とデバッグを可能にする Databricks Connect のインストールに関する情報については、Databricks IDE 拡張機能で Databricks Connect を使用したコードのデバッグを参照してください。