Aspire.Pomelo.EntityFrameworkCore.MySql 13.1.0

Prefix Reserved

dotnet add package Aspire.Pomelo.EntityFrameworkCore.MySql --version 13.1.0

NuGet\Install-Package Aspire.Pomelo.EntityFrameworkCore.MySql -Version 13.1.0

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.Pomelo.EntityFrameworkCore.MySql" Version="13.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Pomelo.EntityFrameworkCore.MySql" Version="13.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Pomelo.EntityFrameworkCore.MySql" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Aspire.Pomelo.EntityFrameworkCore.MySql --version 13.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Aspire.Pomelo.EntityFrameworkCore.MySql, 13.1.0"

#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.

#:package Aspire.Pomelo.EntityFrameworkCore.MySql@13.1.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Aspire.Pomelo.EntityFrameworkCore.MySql&version=13.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Pomelo.EntityFrameworkCore.MySql&version=13.1.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 Aspire Pomelo EntityFrameworkCore MySQL library with NuGet:

dotnet add package Aspire.Pomelo.EntityFrameworkCore.MySql

Usage example

In the AppHost.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 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 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);

    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 AppHost.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

Feedback & contributing

https://github.com/dotnet/aspire

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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Microsoft.Extensions.Caching.Memory (>= 8.0.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore (>= 8.0.22)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- MySqlConnector.Logging.Microsoft.Extensions.Logging (>= 2.1.0)
- OpenTelemetry.Extensions.Hosting (>= 1.14.0)
- Polly.Core (>= 8.6.4)
- Polly.Extensions (>= 8.6.4)
- Pomelo.EntityFrameworkCore.MySql (>= 8.0.3)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
13.1.0	1,539	12/17/2025
13.0.2	848	12/4/2025
13.0.1	1,823	11/26/2025
13.0.0	4,152	11/11/2025
9.5.2	10,033	10/23/2025
9.5.1	6,829	10/3/2025
9.5.0	5,285	9/25/2025
9.4.2	8,256	9/2/2025
9.4.1	11,905	8/12/2025
9.4.0	9,721	7/29/2025
9.3.1	13,542	6/10/2025
9.3.0	21,230	5/19/2025
9.2.1	12,928	4/24/2025
9.2.0	13,687	4/10/2025
9.1.0	16,222	2/25/2025
9.0.0	15,294	11/12/2024
9.0.0-rc.1.24511.1	310	10/15/2024
8.2.2	14,871	10/24/2024
8.2.1	12,007	9/26/2024
8.2.0	14,575	8/29/2024
8.1.0	10,872	7/23/2024
8.0.2	12,500	6/28/2024
8.0.1	11,359	5/21/2024
8.0.0	10,704	5/21/2024
8.0.0-preview.7.24251.11	322	5/7/2024
8.0.0-preview.6.24214.1	264	4/23/2024
8.0.0-preview.5.24201.12	310	4/9/2024
8.0.0-preview.4.24156.9	266	3/12/2024
8.0.0-preview.3.24105.21	248	2/13/2024