AspireEFPostgreSqlExtensions Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Npgsql.EntityFrameworkCore.PostgreSQL
5. /AspireEFPostgreSqlExtensions
6. /Methods

ClassMethods2 members

Provides extension methods for registering a PostgreSQL database context in an Aspire application.

AddNpgsqlDbContext(IHostApplicationBuilder, string, Action<NpgsqlEntityFrameworkCorePostgreSQLSettings>, Action<DbContextOptionsBuilder>)extension

Registers the given EntityFrameworkCore.DbContext as a service in the services provided by the builder. Enables db context pooling, retries, corresponding health check, logging and telemetry.

public static class AspireEFPostgreSqlExtensions
{
    public static void AddNpgsqlDbContext<TContext>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<NpgsqlEntityFrameworkCorePostgreSQLSettings>? configureSettings = null,
        Action<DbContextOptionsBuilder>? configureDbContextOptions = null)
    {
        // ...
    }
}

AspireEFPostgreSqlExtensions.cs#L51-L100

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.

connectionNamestringA name used to retrieve the connection string from the ConnectionStrings configuration section.

configureSettingsAction<NpgsqlEntityFrameworkCorePostgreSQLSettings>optionalAn optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration.

configureDbContextOptionsAction<DbContextOptionsBuilder>optionalAn optional delegate to configure the EntityFrameworkCore.DbContextOptions for the context.

Exceptions

ArgumentNullExceptionThrown if mandatory builder is null.

InvalidOperationExceptionThrown when mandatory NpgsqlEntityFrameworkCorePostgreSQLSettings.ConnectionString is not provided.

Remarks

Reads the configuration from "Aspire:Npgsql:EntityFrameworkCore:PostgreSQL:{typeof(TContext).Name}" config section, or "Aspire:Npgsql:EntityFrameworkCore:PostgreSQL" if former does not exist.

The DbContext.OnConfiguring method can then be overridden to configure EntityFrameworkCore.DbContext options.

EnrichNpgsqlDbContext(IHostApplicationBuilder, Action<NpgsqlEntityFrameworkCorePostgreSQLSettings>)extension

Configures retries, health check, logging and telemetry for the EntityFrameworkCore.DbContext.

public static class AspireEFPostgreSqlExtensions
{
    public static void EnrichNpgsqlDbContext<TContext>(
        this IHostApplicationBuilder builder,
        Action<NpgsqlEntityFrameworkCorePostgreSQLSettings>? configureSettings = null)
    {
        // ...
    }
}

AspireEFPostgreSqlExtensions.cs#L112-L190

Parameters

builderIHostApplicationBuilder

configureSettingsAction<NpgsqlEntityFrameworkCorePostgreSQLSettings>optional

Exceptions

ArgumentNullExceptionThrown if mandatory builder is null.

InvalidOperationExceptionThrown when mandatory EntityFrameworkCore.DbContext is not registered in DI.