Aspire.Hosting.PostgreSQL 13.1.1

Prefix Reserved

dotnet add package Aspire.Hosting.PostgreSQL --version 13.1.1

NuGet\Install-Package Aspire.Hosting.PostgreSQL -Version 13.1.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Aspire.Hosting.PostgreSQL" Version="13.1.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Hosting.PostgreSQL" Version="13.1.1" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Hosting.PostgreSQL" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Aspire.Hosting.PostgreSQL --version 13.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Aspire.Hosting.PostgreSQL, 13.1.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Aspire.Hosting.PostgreSQL@13.1.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Aspire.Hosting.PostgreSQL&version=13.1.1
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.PostgreSQL&version=13.1.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Aspire.Hosting (>= 13.1.1)
- AspNetCore.HealthChecks.NpgSql (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Google.Protobuf (>= 3.33.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)

NuGet packages (13)

Showing the top 5 NuGet packages that depend on Aspire.Hosting.PostgreSQL:

Package	Downloads
Aspire.Hosting.Azure.PostgreSQL Azure PostgreSql Flexible Server resource types for Aspire.	267.1K
CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions An Aspire integration for extending postgres hosting.	57.8K
CommunityToolkit.Aspire.Hosting.Keycloak.Extensions Aspire hosting extensions for Keycloak (includes PostgreSQL integration).	6.5K
Nall.Aspire.Hosting.DependsOn.PostgreSQL Aspire Healthchecks for PostgreSQL	4.5K
Altemiq.Aspire.Hosting.PostgreSQL.Extensions PostgreSQL support for .NET Aspire.	3.9K

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Aspire.Hosting.PostgreSQL:

Repository	Stars
dotnet/eShop A reference .NET application implementing an eCommerce site	10.1K

Version	Downloads	Last Updated
13.1.1	31,369	2/11/2026
13.1.0	318,210	12/17/2025
13.0.2	84,250	12/4/2025
13.0.1	49,343	11/26/2025
13.0.0	110,317	11/11/2025
9.5.2	180,868	10/23/2025
9.5.1	125,681	10/3/2025
9.5.0	56,524	9/25/2025
9.4.2	110,803	9/2/2025
9.4.1	96,546	8/12/2025
9.4.0	91,322	7/29/2025
9.3.1	208,061	6/10/2025
9.3.0	119,726	5/19/2025
9.2.1	92,665	4/24/2025
9.2.0	91,662	4/10/2025
9.1.0	158,097	2/25/2025
9.0.0	263,406	11/12/2024
9.0.0-rc.1.24511.1	10,016	10/15/2024
8.2.2	68,533	10/24/2024
8.2.1	40,728	9/26/2024