Aspire.Hosting.PostgreSQL 13.0.0
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.
Additional documentation
https://learn.microsoft.com/dotnet/aspire/database/postgresql-component https://learn.microsoft.com/dotnet/aspire/database/postgresql-entity-framework-component
Feedback & contributing
https://github.com/dotnet/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.0.0)
- System.IO.Hashing (>= 9.0.10)
- StreamJsonRpc (>= 2.22.23)
- Semver (>= 3.0.0)
- Polly.Core (>= 8.6.4)
- Newtonsoft.Json (>= 13.0.4)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- KubernetesClient (>= 18.0.5)
- JsonPatch.Net (>= 3.3.0)
- Humanizer.Core (>= 2.14.1)
- Grpc.Tools (>= 2.72.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.AspNetCore (>= 2.71.0)
- Google.Protobuf (>= 3.33.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- AspNetCore.HealthChecks.NpgSql (>= 9.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
| Version | Downloads | Last updated |
|---|---|---|
| 13.0.1 | 0 | 11/26/2025 |
| 13.0.0 | 1 | 11/29/2025 |
| 9.5.2 | 0 | 10/23/2025 |
| 9.5.1 | 0 | 10/03/2025 |
| 9.5.0 | 0 | 09/25/2025 |
| 9.4.2 | 0 | 09/02/2025 |
| 9.4.1 | 0 | 08/12/2025 |
| 9.4.0 | 0 | 07/29/2025 |
| 9.3.1 | 0 | 06/10/2025 |
| 9.3.0 | 0 | 05/19/2025 |
| 9.2.1 | 0 | 04/24/2025 |
| 9.2.0 | 0 | 04/10/2025 |
| 9.1.0 | 0 | 02/25/2025 |
| 9.0.0 | 0 | 11/12/2024 |
| 9.0.0-rc.1.24511.1 | 0 | 10/15/2024 |
| 8.2.2 | 0 | 10/24/2024 |
| 8.2.1 | 0 | 09/26/2024 |
| 8.2.0 | 0 | 08/29/2024 |
| 8.1.0 | 0 | 07/23/2024 |
| 8.0.2 | 0 | 06/28/2024 |
| 8.0.1 | 0 | 05/21/2024 |
| 8.0.0 | 0 | 05/21/2024 |
| 8.0.0-preview.7.24251.11 | 0 | 05/07/2024 |
| 8.0.0-preview.6.24214.1 | 0 | 04/23/2024 |
| 8.0.0-preview.5.24201.12 | 0 | 04/09/2024 |