Aspire.Pomelo.EntityFrameworkCore.MySql 8.2.0

Aspire.Pomelo.EntityFrameworkCore.MySql library

Registers EntityFrameworkCore DbContext in the DI container for connecting MySql database. Enables connection pooling, retries, health check, logging and telemetry.

Getting started

Prerequisites

• MySQL database and connection string for accessing the database.

Install the package

Install the .NET Aspire Pomelo EntityFrameworkCore MySQL library with NuGet:

dotnet add package Aspire.Pomelo.EntityFrameworkCore.MySql

Usage example

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

builder.AddMySqlDbContext<MyDbContext>("mysqldb");

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

private readonly MyDbContext _context;

public ProductsController(MyDbContext context)
{
    _context = context;
}

You might also need to configure specific option of MySql, or register a DbContext in other ways. In this case call the EnrichMySqlDbContext extension method, for example:

var connectionString = builder.Configuration.GetConnectionString("mysqldb");
builder.Services.AddDbContextPool<MyDbContext>(dbContextOptionsBuilder => dbContextOptionsBuilder.UseMySql(connectionString, serverVersion));
builder.EnrichMySqlDbContext<MyDbContext>();

Configuration

The .NET Aspire Pomelo EntityFrameworkCore MySQL 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.AddMySqlDbContext():

builder.AddMySqlDbContext<MyDbContext>("myConnection");

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

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

The EnrichMySqlDbContext won't make use of the ConnectionStrings or ServerVersion configuration sections since it expects a DbContext to be registered at the point it is called.

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

Use configuration providers

The .NET Aspire Pomelo EntityFrameworkCore MySQL component supports Microsoft.Extensions.Configuration. It loads the PomeloEntityFrameworkCoreMySqlSettings from configuration by using the Aspire:Pomelo:EntityFrameworkCore:MySql key. Example appsettings.json that configures some of the options:

{
  "Aspire": {
    "Pomelo": {
      "EntityFrameworkCore": {
        "MySql": {
          "DisableHealthChecks": true,
          "DisableTracing": true
        }
      }
    }
  }
}

Use inline delegates

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

    builder.AddMySqlDbContext<MyDbContext>("mysqldb", settings => settings.DisableHealthChecks = true);

or

    builder.EnrichMySqlDbContext<MyDbContext>(settings => settings.DisableHealthChecks = true);

AppHost extensions

In your AppHost project, install the Aspire.Hosting.MySql library with NuGet:

dotnet add package Aspire.Hosting.MySql

Then, in the Program.cs file of AppHost, register a MySQL container and consume the connection using the following methods:

var mysqldb = builder.AddMySql("mysql").AddDatabase("mysqldb");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(mysqldb);

The WithReference method configures a connection in the MyService project named mysqldb. In the Program.cs file of MyService, the database connection can be consumed using:

builder.AddMySqlDbContext<MyDbContext>("mysqldb");

Additional documentation

• https://learn.microsoft.com/ef/core/
• https://github.com/dotnet/aspire/tree/main/src/Components/README.md

Feedback & contributing

https://github.com/dotnet/aspire