Aspire.Hosting.PostgreSQL 13.2.2
Aspire.Hosting.PostgreSQL library
Provides extension methods and resource definitions for an Aspire AppHost to configure a PostgreSQL resource.
Getting started
Install the package
In your AppHost project, install the Aspire PostgreSQL Hosting library with NuGet:
dotnet add package Aspire.Hosting.PostgreSQL
Usage example
Then, in the AppHost.cs file of AppHost, add a PostgreSQL resource and consume the connection using the following methods:
var db = builder.AddPostgres("pgsql").AddDatabase("mydb");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(db);
Connection Properties
When you reference a PostgreSQL resource using WithReference, the following connection properties are made available to the consuming project:
PostgreSQL server
The PostgreSQL server resource exposes the following connection properties:
| Property Name | Description |
|---|---|
Host |
The hostname or IP address of the PostgreSQL server |
Port |
The port number the PostgreSQL server is listening on |
Username |
The username for authentication |
Password |
The password for authentication |
Uri |
The connection URI in postgresql:// format, with the format postgresql://{Username}:{Password}@{Host}:{Port} |
JdbcConnectionString |
JDBC-format connection string, with the format jdbc:postgresql://{Host}:{Port}. User and password credentials are provided as separate Username and Password properties. |
PostgreSQL database
The PostgreSQL database resource inherits all properties from its parent PostgresServerResource and adds:
| Property Name | Description |
|---|---|
Uri |
The connection URI with the database name, with the format postgresql://{Username}:{Password}@{Host}:{Port}/{DatabaseName} |
JdbcConnectionString |
JDBC connection string with database name, with the format jdbc:postgresql://{Host}:{Port}/{DatabaseName}. User and password credentials are provided as separate Username and Password properties. |
DatabaseName |
The name of the database |
Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.
MCP (Model Context Protocol) Support
The PostgreSQL hosting integration provides support for adding an MCP sidecar container that enables AI agents to interact with PostgreSQL databases. This is enabled by calling WithPostgresMcp() on a PostgreSQL database resource.
var db = builder.AddPostgres("pg")
.AddDatabase("mydb")
.WithPostgresMcp();
The PostgreSQL MCP server is currently powered by Postgres MCP Pro) and provides tools for database exploration, query execution, index tuning, and health checks.
Additional documentation
https://aspire.dev/integrations/databases/postgres/postgres-get-started/ https://aspire.dev/integrations/databases/efcore/postgresql/
Feedback & contributing
https://github.com/microsoft/aspire
*Postgres, PostgreSQL and the Slonik Logo are trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and used with their permission.
No packages depend on Aspire.Hosting.PostgreSQL.
.NET 8.0
- Aspire.Hosting (>= 13.2.2)
- AspNetCore.HealthChecks.NpgSql (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Google.Protobuf (>= 3.33.5)
- Grpc.AspNetCore (>= 2.76.0)
- Grpc.Net.ClientFactory (>= 2.76.0)
- Grpc.Tools (>= 2.78.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.13)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.25)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.5)
- Microsoft.Extensions.Hosting (>= 10.0.5)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Http (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.0.5)
- Microsoft.Extensions.Primitives (>= 10.0.5)
- ModelContextProtocol (>= 1.0.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.5)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 10.0.3)
- System.Text.Json (>= 10.0.5)
| Version | Downloads | Last updated |
|---|---|---|
| 13.2.2 | 5 | 04/09/2026 |
| 13.2.1 | 6 | 04/02/2026 |
| 13.2.0 | 7 | 03/24/2026 |
| 13.1.3 | 8 | 03/22/2026 |
| 13.1.2 | 8 | 02/27/2026 |
| 13.1.1 | 13 | 02/12/2026 |
| 13.1.0 | 21 | 12/18/2025 |
| 13.0.2 | 24 | 12/11/2025 |
| 13.0.1 | 15 | 12/11/2025 |
| 13.0.0 | 15 | 12/19/2025 |
| 9.5.2 | 18 | 12/14/2025 |
| 9.5.1 | 22 | 12/11/2025 |
| 9.5.0 | 15 | 12/12/2025 |
| 9.4.2 | 15 | 12/11/2025 |
| 9.4.1 | 14 | 12/12/2025 |
| 9.4.0 | 11 | 12/12/2025 |
| 9.3.1 | 15 | 12/12/2025 |
| 9.3.0 | 12 | 12/11/2025 |
| 9.2.1 | 17 | 12/10/2025 |
| 9.2.0 | 13 | 12/11/2025 |
| 9.1.0 | 14 | 12/12/2025 |
| 9.0.0 | 13 | 12/11/2025 |
| 9.0.0-rc.1.24511.1 | 14 | 12/12/2025 |
| 8.2.2 | 14 | 12/19/2025 |
| 8.2.1 | 12 | 12/11/2025 |
| 8.2.0 | 16 | 12/10/2025 |
| 8.1.0 | 16 | 12/10/2025 |
| 8.0.2 | 13 | 12/18/2025 |
| 8.0.1 | 17 | 12/12/2025 |
| 8.0.0 | 10 | 12/16/2025 |
| 8.0.0-preview.7.24251.11 | 11 | 12/13/2025 |
| 8.0.0-preview.6.24214.1 | 15 | 12/10/2025 |
| 8.0.0-preview.5.24201.12 | 16 | 12/11/2025 |