Add Neon integration

[Boburmirzo]

.NET Aspire issue link

dotnet/aspire#7118

Overview

The Aspire framework does not currently support Neon, a modern, open-source serverless PostgreSQL-compatible database. It has managed integration for Azure as well. While it is possible to use the existing client integrations for PostgreSQL or Npgsql, Neon offers additional features like database branching that are not supported out of the box. We want to enable these unique features through dedicated .NET packages for Aspire.

Usage example

Here is an example of usage

Hosting Integration for Neon

To integrate open source Neon as a hosted resource in a .NET Aspire application:

Install the Aspire.Hosting.Neon NuGet package:

dotnet add package Aspire.Hosting.Neon

Add the Neon server resource in the app host project:

var builder = DistributedApplication.CreateBuilder(args);

// Add Neon server resource with branching support
var neon = builder.AddNeonProject("neon");

// Add a Neon database
var neonDb = neon.AddDatabase("neondb");

// Reference the Neon database in a project
var exampleProject = builder.AddProject<Projects.ExampleProject>()
                            .WithReference(neonDb);

// Initialize and run the application
builder.Build().Run();

Client Integration for Neon

To enable client projects to connect to Neon:

Install the Aspire.Neon NuGet package:

dotnet add package Aspire.Neon

Add the Neon client to the Program.cs file in the client project:

builder.AddNeonDataSource("neondb").addBranch("dev");

Both integrations should align with Aspire's existing conventions and provide a similar experience to the PostgreSQL integration.

Additional context

We are looking for .NET Aspire experts from the community to help us in developing this integration. Let me know your feedback!

Help us help you

Yes, but only if others can assist

[timheuer]

@Boburmirzo For the client integration, the docs for Neon indicate to use the existing NpgSql libraries...have you had success following that documentation and would thus the only thing here to be first the host configuration (perhaps actually the direct/azure(managed)/local proxy)?

[github-actions]

We have noticed this issue has not been updated within 21 days. If there is no action on this issue in the next 14 days, we will automatically close it. You can use /stale-extend to extend the window.

[YandyZaldivar]

I just discovered Neon via Azure looking for a starting postgres solution. I think this is an awesome project and definitively my main use case is through .NET Aspire. Having such integration, specially now that Neon is available in Azure, would be a huge win for Neon and Aspire community.

A good starting point would be to replicate the functionality of the postgres integration first, and then progressively extend the provisioning with Neon features like branches.

[Boburmirzo]

@Boburmirzo For the client integration, the docs for Neon indicate to use the existing NpgSql libraries...have you had success following that documentation and would thus the only thing here to be first the host configuration (perhaps actually the direct/azure(managed)/local proxy)?

Hi @timheuer, thanks for the heads up! Yes, some people from .NET community tried to use it by following the docs. Here is an example:

https://antondevtips.com/blog/how-to-deploy-dotnet-application-to-azure-using-neon-postgres-and-dotnet-aspire

[github-actions]

We have noticed this issue has not been updated within 21 days. If there is no action on this issue in the next 14 days, we will automatically close it. You can use /stale-extend to extend the window.

[github-actions]

This issue has been stale for 5 weeks and has been automatically closed.