Aspire.Npgsql.EntityFrameworkCore.PostgreSQL
9.0.0-rc.1.24511.1
Prefix Reserved
See the version list below for details.
dotnet add package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL --version 9.0.0-rc.1.24511.1
NuGet\Install-Package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL -Version 9.0.0-rc.1.24511.1
<PackageReference Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.0-rc.1.24511.1" />
paket add Aspire.Npgsql.EntityFrameworkCore.PostgreSQL --version 9.0.0-rc.1.24511.1
#r "nuget: Aspire.Npgsql.EntityFrameworkCore.PostgreSQL, 9.0.0-rc.1.24511.1"
// Install Aspire.Npgsql.EntityFrameworkCore.PostgreSQL as a Cake Addin #addin nuget:?package=Aspire.Npgsql.EntityFrameworkCore.PostgreSQL&version=9.0.0-rc.1.24511.1&prerelease // Install Aspire.Npgsql.EntityFrameworkCore.PostgreSQL as a Cake Tool #tool nuget:?package=Aspire.Npgsql.EntityFrameworkCore.PostgreSQL&version=9.0.0-rc.1.24511.1&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
Prerequisites
- 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.
builder.AddNpgsqlDbContext<MyDbContext>("postgresdb");
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));
builder.EnrichNpgsqlDbContext<MyDbContext>();
Configuration
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()
:
builder.AddNpgsqlDbContext<MyDbContext>("myConnection");
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": {
"DisableHealthChecks": true,
"DisableTracing": true
}
}
}
}
}
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.DisableHealthChecks = true);
or
builder.EnrichNpgsqlDbContext<MyDbContext>(settings => settings.DisableHealthChecks = true);
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>()
.WithReference(postgresdb);
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:
builder.AddNpgsqlDbContext<MyDbContext>("postgresdb");
Additional documentation
- https://learn.microsoft.com/ef/core/
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
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 | Versions 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 is compatible. |
-
net8.0
- 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.10)
- Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore (>= 8.0.10)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Npgsql.DependencyInjection (>= 8.0.4)
- Npgsql.EntityFrameworkCore.PostgreSQL (>= 8.0.8)
- Npgsql.OpenTelemetry (>= 8.0.4)
- OpenTelemetry.Extensions.Hosting (>= 1.9.0)
-
net9.0
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-rc.2.24473.5)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-rc.2.24473.5)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.10)
- Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore (>= 8.0.10)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0-rc.2.24473.5)
- Microsoft.Extensions.Options (>= 9.0.0-rc.2.24473.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-rc.2.24473.5)
- Npgsql.DependencyInjection (>= 8.0.4)
- Npgsql.EntityFrameworkCore.PostgreSQL (>= 9.0.0-rc.1)
- Npgsql.OpenTelemetry (>= 8.0.4)
- OpenTelemetry.Extensions.Hosting (>= 1.9.0)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Aspire.Npgsql.EntityFrameworkCore.PostgreSQL:
Package | Downloads |
---|---|
FlickFind.Common
Package Description |
|
Core.Cqrs.CommandAndQueryHandler
Package Description |
|
CustomDateTimeOffset
Package Description |
GitHub repositories (11)
Showing the top 5 popular GitHub repositories that depend on Aspire.Npgsql.EntityFrameworkCore.PostgreSQL:
Repository | Stars |
---|---|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
|
microsoft/kernel-memory
RAG architecture: index and query any data using LLM and natural language, track sources, show citations, asynchronous memory patterns.
|
|
abpframework/abp-samples
Sample solutions built with the ABP Framework
|
|
dotnet/aspire-samples
|
|
tonybaloney/CSnakes
|
Version | Downloads | Last updated |
---|---|---|
9.0.0 | 2,069 | 11/22/2024 |
9.0.0-rc.2.24551.3 | 4,271 | 11/12/2024 |
9.0.0-rc.1.24511.1 | 5,637 | 10/15/2024 |
8.2.2 | 15,637 | 10/24/2024 |
8.2.1 | 24,979 | 9/26/2024 |
8.2.0 | 48,048 | 8/29/2024 |
8.1.0 | 38,232 | 7/23/2024 |
8.0.2 | 26,801 | 6/28/2024 |
8.0.1 | 51,704 | 5/21/2024 |
8.0.0 | 9,843 | 5/21/2024 |
8.0.0-preview.7.24251.11 | 10,453 | 5/7/2024 |
8.0.0-preview.6.24214.1 | 8,149 | 4/23/2024 |
8.0.0-preview.5.24201.12 | 10,765 | 4/9/2024 |
8.0.0-preview.4.24156.9 | 13,186 | 3/12/2024 |
8.0.0-preview.3.24105.21 | 16,378 | 2/13/2024 |
8.0.0-preview.2.23619.3 | 16,422 | 12/20/2023 |
8.0.0-preview.1.23557.2 | 8,560 | 11/14/2023 |