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