Npgsql.DependencyInjection 8.0.2

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

// Install Npgsql.DependencyInjection as a Cake Tool
#tool nuget:?package=Npgsql.DependencyInjection&version=8.0.2

Npgsql is the open source .NET data provider for PostgreSQL. It allows you to connect and interact with PostgreSQL server using .NET.

This package helps set up Npgsql in applications using dependency injection, notably ASP.NET applications. It allows easy configuration of your Npgsql connections and registers the appropriate services in your DI container.

For example, if using the ASP.NET minimal web API, simply use the following to register Npgsql:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddNpgsqlDataSource("Host=pg_server;Username=test;Password=test;Database=test");

This registers a transient NpgsqlConnection which can get injected into your controllers:

app.MapGet("/", async (NpgsqlConnection connection) =>
{
    await connection.OpenAsync();
    await using var command = new NpgsqlCommand("SELECT number FROM data LIMIT 1", connection);
    return "Hello World: " + await command.ExecuteScalarAsync();
});

But wait! If all you want is to execute some simple SQL, just use the singleton NpgsqlDataSource to execute a command directly:

app.MapGet("/", async (NpgsqlDataSource dataSource) =>
{
    await using var command = dataSource.CreateCommand("SELECT number FROM data LIMIT 1");
    return "Hello World: " + await command.ExecuteScalarAsync();
});

NpgsqlDataSource can also come in handy when you need more than one connection:

app.MapGet("/", async (NpgsqlDataSource dataSource) =>
{
    await using var connection1 = await dataSource.OpenConnectionAsync();
    await using var connection2 = await dataSource.OpenConnectionAsync();
    // Use the two connections...
});

The AddNpgsqlDataSource method also accepts a lambda parameter allowing you to configure aspects of Npgsql beyond the connection string, e.g. to configure UseLoggerFactory and UseNetTopologySuite:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddNpgsqlDataSource(
    "Host=pg_server;Username=test;Password=test;Database=test",
    builder => builder
        .UseLoggerFactory(loggerFactory)
        .UseNetTopologySuite());

Finally, starting with Npgsql and .NET 8.0, you can now register multiple data sources (and connections), using a service key to distinguish between them:

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddNpgsqlDataSource("Host=localhost;Database=CustomersDB;Username=test;Password=test", serviceKey: DatabaseType.CustomerDb)
    .AddNpgsqlDataSource("Host=localhost;Database=OrdersDB;Username=test;Password=test", serviceKey: DatabaseType.OrdersDb);

var app = builder.Build();

app.MapGet("/", async ([FromKeyedServices(DatabaseType.OrdersDb)] NpgsqlConnection connection)
    => connection.ConnectionString);

app.Run();

enum DatabaseType
{
    CustomerDb,
    OrdersDb
}

For more information, see the Npgsql documentation.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Npgsql.DependencyInjection:

Package Downloads
Aspire.Npgsql.EntityFrameworkCore.PostgreSQL The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

A PostgreSQL® provider for Entity Framework Core that integrates with Aspire, including connection pooling, health checks, logging, and telemetry.

Aspire.Npgsql The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

A PostgreSQL® client that integrates with Aspire, including health checks, metrics, logging, and telemetry.

Eventuous.Postgresql

Production-grade Event Sourcing library

GitHub repositories (5)

Showing the top 5 popular GitHub repositories that depend on Npgsql.DependencyInjection:

Repository Stars
Xabaril/AspNetCore.Diagnostics.HealthChecks
Enterprise HealthChecks for ASP.NET Core Diagnostics Package
JasperFx/marten
.NET Transactional Document DB and Event Store on PostgreSQL
dotnet/aspire
An opinionated, cloud ready stack for building observable, production ready, distributed applications in .NET
npgsql/efcore.pg
Entity Framework Core provider for PostgreSQL
Eventuous/eventuous
Event Sourcing library for .NET
Version Downloads Last updated
8.0.2 6,479 2/10/2024
8.0.1 47,882 12/4/2023
8.0.0 37,540 11/21/2023
8.0.0-rtm 81 11/20/2023
8.0.0-rc.2 11,740 10/11/2023
8.0.0-preview.4 3,678 5/17/2023
8.0.0-preview.3 299 4/24/2023
8.0.0-preview.2 275 3/20/2023
8.0.0-preview.1 429 3/3/2023
7.0.6 86,162 9/14/2023
7.0.4 263,201 4/24/2023
7.0.2 190,577 2/15/2023
7.0.1 134,489 12/17/2022
7.0.0 9,150 11/9/2022
7.0.0-rc.2 1,014 10/11/2022
7.0.0-rc.1 842 9/16/2022
7.0.0-preview.7 463 8/9/2022
7.0.0-preview.6 144 7/13/2022