Visual Studio Code 用の Databricks 拡張機能とは

Visual Studio Code 用 Databricks 拡張機能を使用すると、ローカルの開発マシンで実行されている Visual Studio Code 統合開発環境 (IDE) からリモートの Azure Databricks ワークスペースに接続できます。 次に以下のことを行えます。

• Visual Studio Code UI を使用して、Databricks アセット バンドルを定義、デプロイ、実行し、Azure Databricks ジョブ、Delta Live Tables パイプライン、MLOps スタックに CI/CD パターンとベスト プラクティスを適用します。 「Databricks アセット バンドルとは?」および「Databricks アセット バンドル拡張機能」を参照してください。
• リモート ワークスペース内の Azure Databricks クラスターで Visual Studio Code からローカル Python コード ファイルを実行します。 「クラスターで Python ファイルを実行する」参照してください
• ローカルの Python コード ファイル (.py) と Python、R、Scala、および SQL の各ノートブック (.py、.ipynb、.r、.scala、.sql) を、Visual Studio Code から、リモート ワークスペースの Azure Databricks ジョブとして実行します。 「Python ファイルをジョブとして実行する」を参照してください。
• 選択ダイアログをトリガーする簡単なチェックリストを使用して、デバッグ環境と Databricks Connect を設定および構成します。 Visual Studio Code 用 Databricks 拡張機能の Databricks Connect を使用したコードのデバッグに関するページを参照してください。
• Databricks Connect を使用して、Visual Studio Code 内のノートブックをセルごとにデバッグします。 「Visual Studio Code用のDatabricks拡張機能を使用したDatabricks Connectによるノートブックセルの実行とデバッグ」を参照してください。
• Visual Studio Code で開発したローカル コードを、リモート ワークスペースのコードと同期します。

作業の開始

Visual Studio Code 用 Databricks 拡張機能の使用を開始するには。

• 拡張機能をインストールします。
• 新しい Databricks プロジェクトを作成するか、既存の Visual Studio Code プロジェクトを移行します。
• Databricks 拡張機能 UI を使用して、プロジェクトを簡単に構成できます。
• 拡張機能チュートリアルの一部として、いくつかの Python コードを実行します。
• Databricks Connect 統合を使用してコードをデバッグします。
• pytest を使用してコードをテストします。 「Visual Studio Code 用 Databricks 拡張機能を使用して、pytest でテストを実行する」を参照してください。

新しい Databricks プロジェクトを作成する

拡張機能がインストールされたら、Visual Studio Code 用の Databricks 拡張機能を使用して、新しい Databricks プロジェクトを作成できます。

1. Visual Studio Code を起動します。
2. Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。
3. [新しい Databricks プロジェクトの作成] をクリックします。
4. [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 「Visual Studio Code 用 Databricks 拡張機能の認証の設定」をご参照ください。
5. [新しいプロジェクトの作成先となるフォルダーへのパスを入力] で、プロジェクトの作成先であるローカル開発用コンピューター上のフォルダーへのパスを入力するか、[フォルダーの選択ダイアログを開く] をクリックしてプロジェクト フォルダーへのパスを選択します。
6. Databricks プロジェクトの初期化ビューの [使用するテンプレート] で、上下矢印を使用しプロジェクト テンプレートを選択した後、Enter キーを押します。 バンドル プロジェクト テンプレートの詳細については、「Databricks アセット バンドル プロジェクト テンプレート」を参照してください。
7. このプロジェクトに固有な名前を入力するか、プロジェクトの既定の名前 (my_project) をそのままにして、Enter キーを押します。
8. プロジェクトに対し、スタブ (サンプル) ノートブック、スタブ (サンプル) Delta Live Tables パイプライン、またはスタブ (サンプル) Python パッケージのどれか 1 つを追加するか、これらのスタブ (サンプル) の任意の組み合わせを追加するかを選択します。
9. 任意のキーを押して、Databricks プロジェクトの初期化 エディター タブを閉じます。
10. [開くプロジェクトを選択] では、先ほど作成したプロジェクトを選択します。

プロジェクトを Databricks プロジェクトに移行する

既存のプロジェクトがあり、それを Databricks プロジェクトに移行したい場合は、Visual Studio Code の Databricks 拡張機能を使用してそのプロジェクトを開き、移行を開始します。

1. Visual Studio Code を起動します。 メイン メニューで [ファイル]>[フォルダーを開く] の順にクリックし、プロジェクトに移動しそれを開きます。
2. Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。
3. [Databricks プロジェクトに移行] をクリックします。
4. [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 「Visual Studio Code 用 Databricks 拡張機能の認証設定」を参照してください。

既存の Databricks アセット バンドル プロジェクトを開く

Visual Studio Code 用 Databricks 拡張機能が、現在のフォルダー内に複数の Databricks アセット バンドル プロジェクトを検出した場合、Visual Studio Code 用 Databricks 拡張機能は、開くプロジェクトを選択できるようにします。

1. Visual Studio Code を起動します。 メイン メニューで [ファイル]>[フォルダーを開く] の順にクリックし、バンドル プロジェクトを含むディレクトリに移動します。

2. Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。

3. [既存の Databricks プロジェクトを開く] をクリックします。

   

4. [コマンド パレット]で、既存の Databricks アセット バンドル プロジェクトを選択します。

5. [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 「Visual Studio Code 用 Databricks 拡張機能の認証の設定」をご参照ください。

ワークスペースに別の Databricks プロジェクトを追加する

Visual Studio Code 用の Databricks 拡張機能を使用すると、Visual Studio Code ワークスペース内に複数の Databricks プロジェクトを保持し、それらの間で簡単に切り替えが行えます。 別のプロジェクトを追加するには。

1. Visual Studio Code を起動します。 メイン メニューで [ファイル]>[フォルダーをワークスペースに追加] の順にクリックし、他のバンドル プロジェクトを含むディレクトリに移動します。

2. Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。

3. [アクティブなワークスペース フォルダー] をクリックして、拡張機能で使用するプロジェクトを選択します。