Visual Studio Code用の Databricks 拡張機能に Databricks Connect を使用してコードをデバッグする

この記事では、Databricks 拡張機能で Databricks Connect 統合を使用して、Visual Studio Code で個々の Python (.py) ファイルを実行およびデバッグする方法について説明します。 拡張機能の詳細については、「Visual Studio Code 用 Databricks 拡張機能」を参照してください。

Databricks Connect 統合では、ノートブック セルを実行およびデバッグすることもできます。 Visual Studio Code の Databricks 拡張機能を使用した Databricks Connect でのノートブック セルの実行とデバッグについては、を参照してください。

要件

Databricks Connect を databricks 拡張機能内からVisual Studio Codeに使用するには、まず、Databricks Connect の要件を満たす必要があります。 これらの要件には、Unity カタログ対応ワークスペース、コンピューティング要件、Pythonのローカル インストールのバージョン要件などが含まれます。

Python仮想環境をアクティブ化する

Python プロジェクトの Python virtual 環境をアクティブにします。 Python仮想環境は、プロジェクトで互換性のあるバージョンの Python パッケージとPython パッケージ (この場合は Databricks Connect パッケージ) を使用していることを確認するのに役立ちます。

[構成] ウィンドウで、次の操作を実行します。

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

Databricks Connect をインストールする

Configuration ビューのPython Environment 内で以下:

  1. 赤い [databricks-connect のインストール] 再生ボタンをクリックします。
  2. クラスターを接続します。
    • 拡張機能で [クラスター] セクションがまだ構成されていない場合は、次のメッセージが表示されます: [Please attach a cluster to use Databricks Connect] (Databricks Connect を使用するクラスターをアタッチしてください)。 [Attach Cluster] (クラスターのアタッチ) をクリックし、Databricks Connect の要件を満たしているクラスターを選びます。
    • [クラスター]セクションは構成されているが、クラスターが Databricks Connect に適合していない場合は、赤い [Databricks Connect disabled] (Databricks Connect は無効) ボタンをクリックし、[Attach Cluster] (クラスターのアタッチ) をクリックして、適合するクラスターを選びます。
  3. Databricks Connect パッケージ (およびその依存関係) がまだインストールされていない場合、次のメッセージが表示されます: "対話型デバッグと自動補完には Databricks Connect が必要です。" 環境 <environment-name> にインストールしますか。 [インストール] をクリックします。
  4. Visual Studio Codeステータス バーに、赤い Databricks Connect が無効になっている場合 ボタンが表示されたら、それをクリックし、画面上の指示に従って有効にします。
  5. [Databricks Connect enabled] (Databricks Connect は有効) ボタンが表示されたら、Databricks Connect を使用する準備ができています。

メモ

Poetry を使用すると、次のコマンドを実行して、pyproject.toml および poetry.lock ファイルをインストールされている Databricks Connect パッケージ (およびその依存関係) と同期することができます。 16.4.1は、プロジェクトのVisual Studio Code用に Databricks 拡張機能によってインストールされたものと一致する Databricks Connect パッケージのバージョンに置き換えてください。

poetry add databricks-connect==16.4.1

Python コードを実行またはデバッグする

Databricks Connect を有効にした後、Python ファイル (.py) を実行またはデバッグします。

  1. プロジェクトで、実行またはデバッグするPython ファイルを開きます。

  2. Python ファイル内にデバッグ ブレークポイントを設定します。

  3. エディター タブの一覧の横にある [Databricks で実行] アイコンをクリックし、[Databricks Connect を使用して現在のファイルをデバッグ] をクリックします。

    アイコンから現在のファイルをデバッグする

    出力は [デバッグ コンソール] ペインに表示されます。

    .py ファイルを右クリックし、[Databricks で実行] をクリック>Databricks Connectを使用して現在のファイルをデバッグすることもできます。

    コンテキスト メニューから現在のファイルをデバッグする