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 AppHost.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 for more information on how to format this connection string.