Edit

Share via

.NET Aspire Community Toolkit PostgreSQL hosting extensions

  • Article

Includes: Hosting integration not Client integration

Note

This integration is part of the .NET Aspire Community Toolkit and isn't officially supported by the .NET Aspire team.

In this article, you learn about the .NET Aspire Community Toolkit PostgreSQL hosting extensions package which provides extra functionality to the .NET Aspire PostgreSQL hosting package.

This package provides the following features:

Hosting integration

To get started with the .NET Aspire Community Toolkit PostgreSQL hosting extensions, install the 📦 CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions NuGet package in the AppHost project.

dotnet add package CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Example usage

To add the DbGate management UI to your PostgreSQL resource, call the WithDbGate method on the PostgresServerResource instance.

var postgresServer = builder.AddPostgreSQL("PostgreSQL")
    .WithDbGate();

This will add a new resource to the app host which will be available from the .NET Aspire dashboard.