AspireMongoDBEntityFrameworkCoreExtensions Methods
Class Methods 2 members
Extension methods for configuring EntityFrameworkCore DbContext to a MongoDB database
AddMongoDbContext(IHostApplicationBuilder, string, string?, Action<MongoDBEntityFrameworkCoreSettings>, Action<DbContextOptionsBuilder>) Section titled AddMongoDbContext(IHostApplicationBuilder, string, string?, Action<MongoDBEntityFrameworkCoreSettings>, Action<DbContextOptionsBuilder>) extension Registers the given
EntityFrameworkCore.DbContext as a service in the services provided by the builder. Enables db context pooling, retries, health check, logging and telemetry for the EntityFrameworkCore.DbContext. public static class AspireMongoDBEntityFrameworkCoreExtensions{ public static void AddMongoDbContext<TContext>( this IHostApplicationBuilder builder, string connectionName, string? databaseName = null, Action<MongoDBEntityFrameworkCoreSettings>? configureSettings = null, Action<DbContextOptionsBuilder>? configureDbContextOptions = null) { // ... }}Parameters
builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to. connectionName string A name used to retrieve the connection string from the ConnectionStrings configuration section. databaseName string? optional The name of the database. If not provided, it will be extracted from the connection string or settings. configureSettings Action<MongoDBEntityFrameworkCoreSettings> optional An optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration. configureDbContextOptions Action<DbContextOptionsBuilder> optional An optional delegate to configure the EntityFrameworkCore.DbContextOptions for the context. Exceptions
ArgumentNullException Thrown if mandatory builder is null. InvalidOperationException Thrown when mandatory MongoDBEntityFrameworkCoreSettings.ConnectionString is not provided. Remarks
Reads the configuration from "Aspire:MongoDB:EntityFrameworkCore:{typeof(TContext).Name}" config section, or "Aspire:MongoDB:EntityFrameworkCore" if former does not exist.
EnrichMongoDbContext(IHostApplicationBuilder, Action<MongoDBEntityFrameworkCoreSettings>) Section titled EnrichMongoDbContext(IHostApplicationBuilder, Action<MongoDBEntityFrameworkCoreSettings>) extension Configures logging and telemetry for the
EntityFrameworkCore.DbContext. public static class AspireMongoDBEntityFrameworkCoreExtensions{ public static void EnrichMongoDbContext<TContext>( this IHostApplicationBuilder builder, Action<MongoDBEntityFrameworkCoreSettings>? configureSettings = null) { // ... }}Parameters
builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to. configureSettings Action<MongoDBEntityFrameworkCoreSettings> optional An optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration. Exceptions
ArgumentNullException Thrown if mandatory builder is null. InvalidOperationException Thrown when mandatory EntityFrameworkCore.DbContext is not registered in DI. Remarks
Reads the configuration from "Aspire:MongoDB:EntityFrameworkCore:{typeof(TContext).Name}" config section, or "Aspire:MongoDB:EntityFrameworkCore" if former does not exist.