Microting.EntityFrameworkCore.MySql

Microting.EntityFrameworkCore.MySql is the most popular Entity Framework Core provider for MySQL compatible databases. It supports EF Core up to its latest version and uses MySqlConnector for high-performance database server communication.

⚠️ Breaking Change: Fully Renamed from Pomelo to Microting

As of this release, the assembly name and C# namespaces have been changed from Pomelo.EntityFrameworkCore.MySql to Microting.EntityFrameworkCore.MySql.

What you need to do:

• Update any references to the provider assembly name from Pomelo.EntityFrameworkCore.MySql to Microting.EntityFrameworkCore.MySql.
• Update all using statements from Pomelo.EntityFrameworkCore.MySql to Microting.EntityFrameworkCore.MySql.
• If you use EF Core scaffolding, update your command:

  dotnet ef dbcontext scaffold "your-connection-string" "Microting.EntityFrameworkCore.MySql"
  

Compatibility

Dependencies

The following versions of MySqlConnector, EF Core, .NET (Core), .NET Standard and .NET Framework are compatible with published releases of Microting.EntityFrameworkCore.MySql:

EF Core 10 Preparation

This repository includes preparation work for EF Core 10 compatibility:

• Conditional Compilation: Automatic EF Core version detection with EFCORE10_OR_GREATER, EFCORE9_OR_GREATER, EFCORE8_OR_GREATER constants
• Compatibility Helpers: EFCoreCompatibilityHelper class for version-agnostic patterns
• Migration Guide: Comprehensive documentation for breaking changes (docs/EFCore10-Migration-Guide.md)
• Test Infrastructure: Example patterns for ExecuteUpdate API changes and migration lock interfaces

Key EF Core 10 Breaking Changes Addressed

1. ExecuteUpdate API: Changed from Expression-based to Action-based setters
2. Migration Database Locks: New interfaces for concurrency control during migrations
3. Query Expression Changes: Various method signature updates

The codebase is prepared for EF Core 10 upgrade when .NET 10 becomes available, with backward compatibility maintained for current versions.

Packages

• Microting.EntityFrameworkCore.MySql
• Microting.EntityFrameworkCore.MySql.Json.Microsoft
• Microting.EntityFrameworkCore.MySql.Json.Newtonsoft
• Microting.EntityFrameworkCore.MySql.NetTopologySuite

Supported Database Servers and Versions

Microting.EntityFrameworkCore.MySql is tested against all actively maintained versions of MySQL and MariaDB. Older versions (e.g. MySQL 5.7) and other server implementations (e.g. Amazon Aurora) are usually compatible to a high degree as well, but are not tested as part of our CI. You can find a list of the versions, a release was tested against, within its release notes.

Currently tested versions are:

• MySQL 8.4
• MySQL 8.0
• MariaDB 11.6
• MariaDB 11.5
• MariaDB 11.4 (LTS)
• MariaDB 11.3
• MariaDB 10.11 (LTS)
• MariaDB 10.6 (LTS)
• MariaDB 10.5 (LTS)

Schedule and Roadmap

Nightly Builds

To use nightly builds, add a NuGet.config file to your solution root with the following content and enable prereleases:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
    </packageSources>
</configuration>

Feeds

All builds are published to NuGet.org.

All .pdb files use Source Link.

Getting Started

1. Project Configuration

Ensure that your .csproj file contains the following reference:

<PackageReference Include="Microting.EntityFrameworkCore.MySql" Version="10.0.10" />

2. Services Configuration

Add Microting.EntityFrameworkCore.MySql to the services configuration in your Startup.cs file of your ASP.NET Core project:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Replace with your connection string.
        var connectionString = "server=localhost;user=root;password=1234;database=ef";

        // Replace with your server version and type.
        // Use 'MariaDbServerVersion' for MariaDB.
        // Alternatively, use 'ServerVersion.AutoDetect(connectionString)'.
        // For common usages, see pull request #1233.
        var serverVersion = new MySqlServerVersion(new Version(8, 4, 6));

        // Replace 'YourDbContext' with the name of your own DbContext derived class.
        services.AddDbContext<YourDbContext>(
            dbContextOptions => dbContextOptions
                .UseMySql(connectionString, serverVersion)
                // The following three options help with debugging, but should
                // be changed or removed for production.
                .LogTo(Console.WriteLine, LogLevel.Information)
                .EnableSensitiveDataLogging()
                .EnableDetailedErrors()
        );
    }
}

View our Configuration Options Wiki Page for a list of common options.

3. Sample Application

Check out our Integration Tests for an example repository that includes an ASP.NET Core MVC Application.

There are also many complete and concise console application samples posted in the issue section (some of them can be found by searching for Program.cs).

4. Read the EF Core Documentation

Refer to Microsoft's EF Core Documentation for detailed instructions and examples on using EF Core.

Scaffolding / Reverse Engineering

Use the EF Core tools to execute scaffolding commands:

dotnet ef dbcontext scaffold "Server=localhost;User=root;Password=1234;Database=ef" "Microting.EntityFrameworkCore.MySql"

Contribute

One of the easiest ways to contribute is to report issues, participate in discussions and update the wiki docs. You can also contribute by submitting pull requests with code changes and supporting tests.

We are always looking for additional core contributors. If you got a couple of hours a week and know your way around EF Core and MySQL, give us a nudge.

License

MIT