クイック スタート: Visual Studio Code プレビュー用 PostgreSQL 拡張機能を使用してデータベースに接続してクエリを実行する

Visual Studio Code 用 PostgreSQL 拡張機能は、PostgreSQL データベースの開発と管理を効率化するために設計された強力なツールです。 このガイドでは、PostgreSQL データベースに接続し、Visual Studio Code 環境内でクエリを実行する手順について説明します。

[前提条件]

開始する前に、適切なツールとリソースがダウンロードおよびインストールされていることを確認します。

これらのツールとリソースは、この記事に従い、Visual Studio Code の PostgreSQL 拡張機能の GitHub Copilot 統合を最大限に活用するのに役立ちます。

• コンピューターにインストールされている Visual Studio Code。
• ローカルにインストールされているか 、クラウドでホストされている PostgreSQL データベース。
• Visual Studio Code にインストールされている PostgreSQL 拡張機能。
• GitHub Copilot 拡張機能
• GitHub Copilot Chat 拡張機能 がインストールされました。
• クラウドでホストされているデータベースに接続するための Azure アカウント (省略可能)。

PostgreSQL 拡張機能をインストールする

PostgreSQL 拡張機能をインストールするには:

1. Visual Studio Code を開き、アクティビティ バーの [拡張機能] アイコンを選択するか、[表示: 拡張機能] コマンドを使用して 拡張機能ビュー に移動します。
2. Extensions Marketplace で PostgreSQL を検索します。
3. Microsoft によって作成された PostgreSQL 拡張機能を選択し、[ インストール] を選択します。

インストールすると、象アイコンで表される PostgreSQL ページが Visual Studio Code サイドバーに表示されます。

PostgreSQL への接続を追加する

ローカルでもリモート サーバーでも、PostgreSQL データベースへの接続は、データの管理と操作の基本的な手順です。 このプロセスでは、クライアント アプリケーションとデータベースの間にセキュリティで保護されたリンクを確立するために必要な接続の詳細 (サーバー アドレス、ポート、認証資格情報など) を指定する必要があります。 Visual Studio Code 用 PostgreSQL 拡張機能を使用すると、データベースにシームレスに接続し、強力なツールを使用して、データのクエリ、管理、探索を効率的に行うことができます。

1. サイドバーの象アイコンを選択して PostgreSQL 拡張機能ページを開きます。

2. [ 接続の追加] ボタンを選択します。

3. 接続の詳細を手動で入力するか、接続文字列の形式を使用します。

     psql -h <server>.postgres.database.azure.com -p 5432 -U
   

4. Azure を使用している場合は、Azure アカウントにサインインし、データベース インスタンスを参照します。 サブスクリプション、リソース グループ、サーバー、およびデータベース名でフィルター処理します。

認証

拡張機能では、次の 2 つの認証方法がサポートされています。

• ユーザー名/パスワード: データベースの資格情報を接続フィールドに直接入力します。
• Microsoft Entra ID 認証: Azure でホストされるデータベースの Microsoft Entra ID アカウントを追加します。

接続をテストして保存する

1. [テスト接続] を選択して、接続の詳細を確認します。
2. テストが成功すると、テスト ボックスにチェックマークが表示されます。
3. [接続] を選択して接続を確立します。
4. 接続が自動的に保存され、[接続] ウィンドウに表示されます。

データベース オブジェクトを探索する

オブジェクト エクスプローラーには、データベース オブジェクトの階層ビューが用意されています。

• データベース項目を展開して、スキーマ、テーブル、ビュー、関数、およびストアド プロシージャを表示します。
• データベースを右クリックすると、次のオプションが表示されます。 - 新しいクエリを起動する - このデータベースとチャットする (pgsql チャット エクスペリエンスを開始する) - PSQL と接続して psql ターミナル接続を起動する
• テーブルを右クリックし、[上位 1000 件を選択] を選択してデータを表示します。 クエリ エディターでクエリが開き、[結果ビューアー] タブに結果が表示されます。

クエリの実行

クエリ エディターを使用して、SQL クエリの下書きと実行を行います。

• コンテキスト対応の IntelliSense を利用して、SQL キーワードとオブジェクト名をオートコンプリートします。
• 構文の強調表示とオートフォーマットにより、読みやすさと精度が向上します。
• [クエリ履歴] ペインを使用して、以前に実行したクエリにアクセスします。

クエリ結果を確認する

結果ビューアーには、クエリ結果を操作するための高度な機能が用意されています。

• 結果を CSV、JSON、または Excel 形式にエクスポートして、詳細な分析を行います。
• 検索、フィルター、並べ替えのオプションを使用して、データを絞り込みます。
• 永続的なデータ ビューは、タブ間を切り替えながらコンテキストを維持します。

GitHub Copilot を使用して高度な支援を受ける

GitHub Copilot 統合では、AI を利用したコード提案、クエリ最適化のヒント、対話型データベース 支援を提供することで、PostgreSQL 開発エクスペリエンスが強化されます。 この機能を使用すると、ワークフローを合理化し、開発時間を短縮し、データベース操作に関するより深い洞察を得ることができます。 このセクションでは、Visual Studio Code 用 PostgreSQL 拡張機能内で Copilot をアクティブ化して利用する手順について説明します。

GitHub Copilot と Copilot Chat 拡張機能がインストールされていることを確認します。

GitHub アカウントにサインインし、拡張機能の設定で @pgsql Copilot Chat エージェントを有効にします。

対話型データベース プロンプト

データベースを右クリックし、[ このデータベースとチャット ] を選択して Copilot と対話します。

詳細な分析情報と提案を受け取るために、次の例のようなプロンプトを書きます。

@pgsql tell me about the tables in the HR schema

詳細については、GitHub Copilot の構成に関するページを参照してください。

Azure portal から VS Code を使用して Azure Database for PostgreSQL フレキシブル サーバー インスタンスに接続する

Visual Studio Code を使用して Azure Database for PostgreSQL フレキシブル サーバー インスタンスに接続するには、次の手順に従います。

1. Azure portal にサインインし、Azure Database for PostgreSQL フレキシブル サーバー インスタンスを見つけます。
2. サーバー インスタンスの [概要] ページに移動します。

VS Code を使用して接続する

Azure portal の [Connect with Visual Studio Code]\(Visual Studio Code で接続する\) オプションを使用すると、Azure Database for PostgreSQL フレキシブル サーバーへの接続が簡略化されます。 この機能は、必要な前提条件を説明し、接続の詳細を自動的に構成することで、セットアップを効率化します。 この統合を使用すると、接続をすばやく確立し、Visual Studio Code 環境内で直接データベースを管理できます。

• [概要] ページで、目立つ [VS Code を使用して接続 ] ボタンを選択します。
• VS Code を使用して接続するための要件を示すサイド ウィンドウが表示されます。

要件を確認する

• サイド ウィンドウで、適切なチェック ボックスをオンにして、すべての前提条件 (VS Code と PostgreSQL 拡張機能) が満たされていることを確認します。

• 必要に応じて、サイド ウィンドウのリンクを使用して Visual Studio Code と拡張機能をダウンロードします。

• 必要に応じて、既定のデータベース名、認証方法、接続プールなどの接続パラメーターを入力します。

  

Visual Studio Code で開く

• サイド ウィンドウ で [Visual Studio Code で開く ] ボタンを選択します。
• Visual Studio Code と拡張機能が開くのに 40 秒以上かかっている場合は、サイド ウィンドウに [Visual Studio Code での開き直し] ボタンが表示されます。

Visual Studio Code を起動します

• VS Code がインストールされて実行されている場合、PostgreSQL 拡張機能の接続ダイアログ ボックスが自動的に起動します。
• VS Code がインストールされていても開かない場合は、約 40 秒以内に起動し、その後に接続ダイアログ ボックスが表示されます。

接続情報の自動入力

PostgreSQL 拡張機能の接続ダイアログ ボックスが開き、[サーバー名] フィールドにサーバー エンドポイントが自動的に設定されます。

AAD 認証の詳細を提供する

優先する認証方法を選択します。

• パスワード認証: ユーザー名とパスワードを手動で入力します。
• Entra 認証: Azure アカウントの資格情報を入力します。

プロファイル名、データベース名 (省略可能)、サーバー グループ、ポート番号など、その他の接続の詳細を指定します。

保存して接続する

[保存] & [接続] ボタンを選択して接続を確立します。 接続したら、オブジェクト エクスプローラー ツリーでサーバーを展開してデータベース、スキーマ、テーブルを表示するか、組み込みのクエリ ツールを使用してデータベース オブジェクトを管理します。

トラブルシューティング

接続プロセス中に問題が発生した場合:

• VS Code と PostgreSQL 拡張機能がインストールされ、有効になっていることを確認します。

• Azure Database for PostgreSQL のファイアウォール設定で IP アドレスが許可されていることを確認します。

• 前提条件が満たされていない場合、サイド ウィンドウには、接続の再試行など、問題を解決するためのフィードバックと手順が表示されます。

フィードバックとサポート

バグ、機能要求、および問題については、Visual Studio Code の組み込みのフィードバック ツールを使用します。 これを完了するには、VS Code の [ヘルプ] メニューまたは PGSQL コマンド パレットを使用します。

• ヘルプ メニュー

  • 問題の報告>ヘルプに移動する

• コマンド パレット

  • Ctrl + Shift + Pでコマンド パレットを開き、次のコマンドを実行します。PGSQL: Report Issue

関連コンテンツ

• Visual Studio Code プレビュー用 PostgreSQL 拡張機能とは
• クイック スタート: Visual Studio Code プレビューで GitHub Copilot for PostgreSQL 拡張機能を構成する
• Visual Studio Code 用 PostgreSQL 拡張機能