Aspire.Npgsql.EntityFrameworkCore.PostgreSQL 9.0.0-preview.3.24210.17

The ID prefix of this package has been reserved for one of the owners of this package by Prefix Reserved
This is a prerelease version of Aspire.Npgsql.EntityFrameworkCore.PostgreSQL.
dotnet add package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL --version 9.0.0-preview.3.24210.17
NuGet\Install-Package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL -Version 9.0.0-preview.3.24210.17
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.Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.0-preview.3.24210.17" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Aspire.Npgsql.EntityFrameworkCore.PostgreSQL --version 9.0.0-preview.3.24210.17
#r "nuget: Aspire.Npgsql.EntityFrameworkCore.PostgreSQL, 9.0.0-preview.3.24210.17"
#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.
// Install Aspire.Npgsql.EntityFrameworkCore.PostgreSQL as a Cake Addin
#addin nuget:?package=Aspire.Npgsql.EntityFrameworkCore.PostgreSQL&version=9.0.0-preview.3.24210.17&prerelease

// Install Aspire.Npgsql.EntityFrameworkCore.PostgreSQL as a Cake Tool
#tool nuget:?package=Aspire.Npgsql.EntityFrameworkCore.PostgreSQL&version=9.0.0-preview.3.24210.17&prerelease

Aspire.Npgsql.EntityFrameworkCore.PostgreSQL library

Registers EntityFrameworkCore DbContext in the DI container for connecting PostgreSQL®* database. Enables connection pooling, retries, health check, logging and telemetry.

Getting started


  • PostgreSQL database and connection string for accessing the database.

Install the package

Install the .NET Aspire PostgreSQL EntityFrameworkCore Npgsql library with NuGet:

dotnet add package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL

Usage example

In the Program.cs file of your project, call the AddNpgsqlDbContext extension method to register a DbContext for use via the dependency injection container. The method takes a connection name parameter.


You can then retrieve the MyDbContext instance using dependency injection. For example, to retrieve the context from a Web API controller:

private readonly MyDbContext _context;

public ProductsController(MyDbContext context)
    _context = context;

You might also need to configure specific option of Npgsql, or register a DbContext in other ways. In this case call the EnrichNpgsqlDbContext extension method, for example:

var connectionString = builder.Configuration.GetConnectionString("postgresdb");
builder.Services.AddDbContextPool<MyDbContext>(dbContextOptionsBuilder => dbContextOptionsBuilder.UseNpgsql(connectionString));


The .NET Aspire PostgreSQL EntityFrameworkCore Npgsql component provides multiple options to configure the database connection based on the requirements and conventions of your project.

Use a connection string

When using a connection string from the ConnectionStrings configuration section, you can provide the name of the connection string when calling builder.AddNpgsqlDbContext():


And then the connection string will be retrieved from the ConnectionStrings configuration section:

  "ConnectionStrings": {
    "myConnection": "Host=myserver;Database=test"

The EnrichNpgsqlDbContext won't make use of the ConnectionStrings configuration section since it expects a DbContext to be registered at the point it is called.

See the ConnectionString documentation for more information on how to format this connection string.

Use configuration providers

The .NET Aspire PostgreSQL EntityFrameworkCore Npgsql component supports Microsoft.Extensions.Configuration. It loads the NpgsqlEntityFrameworkCorePostgreSQLSettings from configuration by using the Aspire:Npgsql:EntityFrameworkCore:PostgreSQL key. Example appsettings.json that configures some of the options:

  "Aspire": {
    "Npgsql": {
      "EntityFrameworkCore": {
        "PostgreSQL": {
          "HealthChecks": false,
          "Tracing": false

Use inline delegates

Also you can pass the Action<NpgsqlEntityFrameworkCorePostgreSQLSettings> configureSettings delegate to set up some or all the options inline, for example to disable health checks from code:

    builder.AddNpgsqlDbContext<MyDbContext>("postgresdb", settings => settings.HealthChecks = false);


    builder.EnrichNpgsqlDbContext<MyDbContext>(settings => settings.HealthChecks = false);

AppHost extensions

In your AppHost project, install the Aspire.Hosting.PostgreSQL library with NuGet:

dotnet add package Aspire.Hosting.PostgreSQL

Then, in the Program.cs file of AppHost, register a Postgres database and consume the connection using the following methods:

var postgresdb = builder.AddPostgres("pg").AddDatabase("postgresdb");

var myService = builder.AddProject<Projects.MyService>()

The WithReference method configures a connection in the MyService project named postgresdb. In the Program.cs file of MyService, the database connection can be consumed using:


Additional documentation

Feedback & contributing

*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 net9.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Aspire.Npgsql.EntityFrameworkCore.PostgreSQL:

Repository Stars
A reference .NET application implementing an eCommerce site
Version Downloads Last updated
9.0.0-preview.3.24210.17 106 4/11/2024
9.0.0-preview.2.24162.2 434 3/12/2024
9.0.0-preview.1.24113.3 323 2/13/2024
8.0.0-preview.5.24201.12 1,318 4/9/2024
8.0.0-preview.4.24156.9 7,108 3/12/2024
8.0.0-preview.3.24105.21 9,729 2/13/2024
8.0.0-preview.2.23619.3 13,437 12/20/2023
8.0.0-preview.1.23557.2 8,040 11/14/2023