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 で開発したローカル コードを、リモート ワークスペースのコードと同期します。 「ワークスペース フォルダーを Databricks と同期する」を参照してください
Note
Visual Studio Code 用の Databricks 拡張機能では、R、Scala、SQL の各ノートブックを自動ジョブとして実行することがサポートされていますが、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 プロジェクトを作成できます。
- Visual Studio Code を起動します。
- Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。
- [新しいプロジェクト 作成] をクリックします。
- [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 「Visual Studio Codeの Databricks 拡張機能の承認を設定する」を参照してください。
- [新しいプロジェクトの作成先となるフォルダーへのパスを入力] で、プロジェクトの作成先であるローカル開発用コンピューター上のフォルダーへのパスを入力するか、[フォルダーの選択ダイアログを開く] をクリックしてプロジェクト フォルダーへのパスを選択します。
- Databricks プロジェクトの初期化ビューの [使用するテンプレート] で、上下矢印を使用しプロジェクト テンプレートを選択した後、Enter キーを押します。 バンドル プロジェクト テンプレートの詳細については、「Databricks アセット バンドル プロジェクト テンプレート」を参照してください。
- このプロジェクトに固有な名前を入力するか、プロジェクトの既定の名前 (
my_project) をそのままにして、Enter キーを押します。 - プロジェクトに対し、スタブ (サンプル) ノートブック、スタブ (サンプル) Delta Live Tables パイプライン、またはスタブ (サンプル) Python パッケージのどれか 1 つを追加するか、これらのスタブ (サンプル) の任意の組み合わせを追加するかを選択します。
- 任意のキーを押して、Databricks プロジェクトの初期化 エディター タブを閉じます。
- [開くプロジェクトを選択] では、先ほど作成したプロジェクトを選択します。
既存の Databricks アセット バンドル プロジェクトを開く
Databricks アセット バンドル プロジェクトでは、プロジェクトのルート フォルダーに databricks.yml ファイルがあります。 「Databricks アセット バンドルの構成」をご覧ください。 既存の Databricks Asset Bundles プロジェクトで拡張機能を使用する場合:
Visual Studio Code を起動します。 メイン メニューで [ファイル]>[フォルダーを開く] の順にクリックし、バンドル プロジェクトを含むディレクトリに移動します。
Visual Studio Code サイドバーの Databricks アイコンをクリックして、拡張機能の機能を開いて使用を開始します。
Visual Studio Code の Databricks 拡張機能で現在のフォルダー内の複数の Databricks Asset Bundles プロジェクトが検出された場合は、プロジェクトを開くか、ルート フォルダーにプロジェクト構成ファイルを作成することを選択できます。
- プロジェクトを選択した場合は、コマンド パレットで、既存の Databricks アセット バンドル プロジェクトを選択します。
- ルート フォルダーに構成を作成すると、そのフォルダーがバンドル プロジェクトになります。
プロジェクトのホストと認証方法を選択します。 「Visual Studio Codeの Databricks 拡張機能の承認を設定する」を参照してください。
Note
Visual Studio Code v1 の Databricks 拡張機能を使用して作成されたプロジェクトを開く場合は、そのプロジェクトの既存の認証とワークスペース構成を使用して、移行が自動的に試行されます。 移行ボタンは、自動移行が失敗した場合にのみ有効になります。
Databricks プロジェクトを切り替える
Visual Studio Code 用の Databricks 拡張機能を使用すると、Visual Studio Code ワークスペース内に複数の Databricks プロジェクトを保持し、それらの間で簡単に切り替えが行えます。 Visual Studio Code ワークスペースでマルチバンドル プロジェクトを開いた状態で、次の手順を実行します。
Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。
ローカル フォルダー をクリックして、拡張機能で使用するプロジェクトを選択します。
Note
実行アクションは、アクティブなバンドル内のファイルでのみ使用できます。
プロジェクトを Databricks プロジェクトに変換する
Databricks プロジェクトに変換する既存のプロジェクトがある場合:
- Visual Studio Code を起動します。 メイン メニューで [ファイル]>[フォルダーを開く] の順にクリックし、プロジェクトに移動しそれを開きます。
- Visual Studio Code サイドバーで [Databricks] アイコンをクリックし、拡張機能を開きます。
- [構成の作成] をクリックします。
- [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 「Visual Studio Codeの Databricks 拡張機能の承認を設定する」を参照してください。