Databricks IDE拡張機能は、ローカル開発マシンのVisual Studio CodeやカーソルからリモートのAzure Databricksワークスペースに接続できるようにします。 次に以下のことを行えます。
- 宣言型オートメーション バンドルを定義、デプロイ、実行して、Visual Studio Code UI を使用して、Lakeflow ジョブ、Lakeflow パイプライン、MLOps スタックに CI/CD パターンとベスト プラクティスを適用します。 「 宣言的自動化バンドルとは何か? 」および バンドルおよびエクスプローラーの機能をご覧ください。
- リモート ワークスペース内の Azure Databricks クラスターまたはサーバーレス コンピューティングで、Visual Studio Codeからローカル Python コード ファイルを実行します。 「クラスターでPython ファイルを実行する」を参照してください。
- Visual Studio Code から、ローカルの Python コード ファイル (
.py) および Python、R、Scala、SQL ノートブック (.py、.ipynb、.r、.scala、.sql) をリモート ワークスペースで Lakeflow ジョブとして実行します。 「ジョブとしてPython ファイルを実行するを参照してください。 - 選択ダイアログをトリガーする簡単なチェックリストを使用して、デバッグ環境と Databricks Connect を設定および構成します。 Databricks IDE拡張については「Databricks Connect を使用したデバッグコード」を参照してください。
- Databricks Connect を使用して、Visual Studio Code でノートブックをセルごとにデバッグします。 Databricks IDE拡張機能を使ったDatabricks Connectでノートブックセルを実行・デバッグする方法をご覧ください。
- Visual Studio Codeで開発したローカル コードをリモート ワークスペース内のコードと同期します。 「ワークスペース フォルダーを Databricks と同期する」を参照してください
注
Databricks IDE拡張機能は、R、Scala、SQLノートブックを自動化ジョブとして実行することをサポートしていますが、Visual Studio Code内でこれらの言語に対するより深いサポートは提供していません。
概要
Databricks IDE拡張機能の使い方を始めるには:
- 拡張機能をインストールします。
- 新しい Databricks プロジェクトを作成するか、既存のVisual Studio Codeプロジェクトを変換します。
- Databricks 拡張機能 UI を使用して、プロジェクトを簡単に構成できます。
- extension チュートリアルの一部として、いくつかのPython コードを実行します。
- Databricks Connect 統合を使用してコードをデバッグします。
-
pytestを使用してコードをテストします。 Databricks IDE拡張機能を使ってPythonテストを実行する方法をご覧ください。
新しい Databricks プロジェクトを作成する
拡張機能がインストールされると、Databricks IDE拡張機能を使って新しいDatabricksプロジェクトを作成できます:
- Visual Studio Codeを起動します。
- Visual Studio Codeサイドバーの Databricks アイコンをクリックして拡張機能を開きます。
- [新しいプロジェクト 作成] をクリックします。
- [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 Databricks IDE拡張の「認証設定」を参照してください。
- [新しいプロジェクトの作成先となるフォルダーへのパスを入力] で、プロジェクトの作成先であるローカル開発用コンピューター上のフォルダーへのパスを入力するか、[フォルダーの選択ダイアログを開く] をクリックしてプロジェクト フォルダーへのパスを選択します。
- Databricks プロジェクトの初期化ビューの [使用するテンプレート] で、上下矢印を使用しプロジェクト テンプレートを選択した後、Enter キーを押します。 バンドル プロジェクト テンプレートの詳細については、「 宣言型オートメーション バンドル プロジェクト テンプレート」を参照してください。
- このプロジェクトに固有な名前を入力するか、プロジェクトの既定の名前 (
my_project) をそのままにして、Enter キーを押します。 - スタブ (サンプル) ノートブック、スタブ (サンプル) Delta Live Tables パイプライン、またはスタブ (サンプル) Python パッケージをプロジェクトに追加するか、これらのスタブ (サンプル) の任意の組み合わせを追加するかを選択します。
- 任意のキーを押して、Databricks Project Init エディター タブを閉じます。
- [開くプロジェクトを選択] では、先ほど作成したプロジェクトを選択します。
既存の宣言型オートメーション バンドル プロジェクトを開く
宣言型オートメーション バンドル プロジェクトには、プロジェクトのルート フォルダーに databricks.yml ファイルがあります。
宣言型オートメーション バンドルの構成を参照してください。 既存の宣言型オートメーション バンドル プロジェクトで拡張機能を使用する場合:
Visual Studio Codeを起動します。 メイン メニューで [ファイル]>[フォルダーを開く] の順にクリックし、バンドル プロジェクトを含むディレクトリに移動します。
Visual Studio Codeサイドバーの Databricks アイコンをクリックして、拡張機能の機能を開いて使用を開始します。
Databricks IDE拡張子が現在のフォルダ内に複数の宣言的自動化バンドルプロジェクトを検出した場合、ルートフォルダ内でプロジェクトを開くか、プロジェクト設定ファイルを作成するかを選択できます。
- プロジェクトを選択した場合は、 コマンド パレットで既存の宣言型オートメーション バンドル プロジェクトを選択します。
- ルート フォルダーに構成を作成すると、そのフォルダーがバンドル プロジェクトになります。
プロジェクトのホストと認証方法を選択します。 Databricks IDE拡張の「認証設定」を参照してください。
注
Databricks IDE拡張機能v1で作成されたプロジェクトを開くと、プロジェクトの既存の認証およびワークスペース設定を使って自動的に移行が試みられます。 移行ボタンは、自動移行が失敗した場合にのみ有効になります。
Databricks プロジェクトを切り替える
Databricks IDE拡張機能は、Visual Studio Codeワークスペース内に複数のDatabricksプロジェクトを管理し、簡単に切り替えられるようにします。 Visual Studio Code ワークスペースでマルチバンドル プロジェクトを開いた状態で、次の手順を実行します。
Visual Studio Codeサイドバーの Databricks アイコンをクリックして拡張機能を開きます。
ローカル フォルダー をクリックして、拡張機能で使用するプロジェクトを選択します。
注
実行アクションは、アクティブなバンドル内のファイルでのみ使用できます。
プロジェクトを Databricks プロジェクトに変換する
Databricks プロジェクトに変換する既存のプロジェクトがある場合:
- Visual Studio Codeを起動します。 メイン メニューで [ファイル]>[フォルダーを開く] の順にクリックし、プロジェクトに移動しそれを開きます。
- Visual Studio Codeサイドバーの Databricks アイコンをクリックして拡張機能を開きます。
- [構成の作成] をクリックします。
- [コマンド パレット] で、プロジェクトのホストと認証方法を選択します。 Databricks IDE拡張の「認証設定」を参照してください。