【C#】Aspireで構築したDBにVsCodeから接続

.NET Aspire で PostgreSQL データベースを構築し、VsCode から接続する方法を紹介します。

前提条件

• .NET Aspire プロジェクトが作成済み
• DB コンテナを Aspire 経由で作成
• VsCode がインストール済み

Aspire での DB 設定（ポート固定）

通常、Aspire で起動するたびにポート番号が変わってしまうため、VsCode からの接続設定を安定させるためにポートを固定します。

var db = builder.AddPostgres("test-postgres", port: 5432)

デモとしてPostgreSQLを使用していますがほかの DB でも同じような方法で実装が可能です。

ポートを固定することで、毎回同じ接続設定でデータベースにアクセスできるようになります。

接続文字列の取得

1. Aspire プロジェクトを起動します
2. Aspire ダッシュボードを開きます
3. PostgreSQL リソースの詳細画面を開きます
4. 接続文字列をコピーします

典型的な接続文字列の例：

Host=localhost;Port=5432;Username=postgres;Password=your_password;Database=your_database

取得した接続文字列を使用して VsCode から接続を行うことができます。

通常ポート番号は起動のたびに代わってしまい実行のたびに接続文字列を取得する必要があるのですが、ポート固定をすでに行っているため Aspire アプリが実行中ならいつでも DB に接続することができます。

まとめ

以上のようにすると Aspire で作成した DB コンテナに VsCode から接続することが可能です。VsCode から DB を見たいことがそこそこあるため意外と実用的かと思います。

この記事が皆様のコーディングライフの助けになれば幸いです。

参考