Aspire.Npgsql 8.0.0-preview.3.24105.21

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

// Install Aspire.Npgsql as a Cake Tool
#tool nuget:?package=Aspire.Npgsql&version=8.0.0-preview.3.24105.21&prerelease

Aspire.Npgsql library

Registers NpgsqlDataSource in the DI container for connecting PostgreSQL®* database. Enables corresponding health check, metrics, logging and telemetry.

Getting started

Prerequisites

  • PostgreSQL database and connection string for accessing the database.

Install the package

Install the .NET Aspire PostgreSQL Npgsql library with NuGet:

dotnet add package Aspire.Npgsql

Usage example

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

builder.AddNpgsqlDataSource("postgresdb");

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

private readonly NpgsqlDataSource _dataSource;

public ProductsController(NpgsqlDataSource dataSource)
{
    _dataSource = dataSource;
}

Configuration

The .NET Aspire PostgreSQL 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.AddNpgsqlDataSource():

builder.AddNpgsqlDataSource("myConnection");

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

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

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

Use configuration providers

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

{
  "Aspire": {
    "Npgsql": {
      "HealthChecks": false,
      "Tracing": false
    }
  }
}

Use inline delegates

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

    builder.AddNpgsqlDataSource("postgresdb", settings => settings.HealthChecks = false);

AppHost extensions

In your AppHost project, 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.AddNpgsqlDataSource("postgresdb");

Additional documentation

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 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. 
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 (4)

Showing the top 4 popular GitHub repositories that depend on Aspire.Npgsql:

Repository Stars
dotnet/eShop
A reference .NET application implementing an eCommerce site
dotnet/aspire-samples
bradygaster/dotnet-cloud-native-build-2023
Azure-Samples/eShopOnAzure
A variant of https://github.com/dotnet/eShop that uses Azure services
Version Downloads Last updated
8.0.1 8,648 5/21/2024
8.0.0 2,532 5/21/2024
8.0.0-preview.7.24251.11 4,598 5/7/2024
8.0.0-preview.6.24214.1 3,226 4/23/2024
8.0.0-preview.5.24201.12 5,691 4/9/2024
8.0.0-preview.4.24156.9 6,558 3/12/2024
8.0.0-preview.3.24105.21 5,978 2/13/2024
8.0.0-preview.2.23619.3 8,070 12/20/2023
8.0.0-preview.1.23557.2 6,824 11/14/2023