Skip to content

Latest commit

 

History

History
168 lines (113 loc) · 6.16 KB

mysql-entity-framework-integration.md

File metadata and controls

168 lines (113 loc) · 6.16 KB
title description ms.date
MySQL Entity Framework Component
MySQL Entity Framework Component
08/12/2024

.NET Aspire Pomelo MySQL Entity Framework Component

In this article, you learn how to use the The .NET Aspire Pomelo MySQL Entity Framework Core integration. The Aspire.Pomelo.EntityFrameworkCore.MySql library is used to register a xref:System.Data.Entity.DbContext?displayProperty=fullName as a singleton in the DI container for connecting to MySQL databases. It also enables connection pooling, retries, health checks, logging and telemetry.

Get started

You need a MySQL database and connection string for accessing the database. To get started with the The .NET Aspire Pomelo MySQL Entity Framework Core integration, install the Aspire.Pomelo.EntityFrameworkCore.MySql NuGet package in the consuming client project.

.NET CLI

dotnet add package Aspire.Pomelo.EntityFrameworkCore.MySql

PackageReference

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

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Example usage

In the :::no-loc text="Program.cs"::: file of your client-consuming project, call the xref:Microsoft.Extensions.Hosting.AspireEFMySqlExtensions.AddMySqlDbContext%2A extension to register a xref:System.Data.Entity.DbContext?displayProperty=fullName for use via the dependency injection container.

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

You can then retrieve the xref:Microsoft.EntityFrameworkCore.DbContext instance using dependency injection. For example, to retrieve the client from a service:

public class ExampleService(MyDbContext context)
{
    // Use context...
}

You might also need to configure specific options of your MySQL connection, 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>();

App host usage

[!INCLUDE mysql-app-host]

var builder = DistributedApplication.CreateBuilder(args);

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

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

Configuration

The .NET Aspire Pomelo MySQL Entity Framework Core integration 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.AddMySqlDatabaseDbContext<TContext>():

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

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

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

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

For more information, see the MySqlConnector documentation.

Use configuration providers

The .NET Aspire Pomelo MySQL Entity Framework Core integration supports xref:Microsoft.Extensions.Configuration?displayProperty=fullName. It loads the PomeloEntityFrameworkCoreMySqlSettings from configuration by using the Aspire:Pomelo:EntityFrameworkCore:MySql key.

The following example shows an :::no-loc text="appsettings.json"::: that configures some of the available options:

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

Use inline delegates

You can also 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>(
    "mysqldb1",
    static settings => settings.DisableHealthChecks  = true);

or

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

[!INCLUDE integration-health-checks]

The The .NET Aspire Pomelo MySQL Entity Framework Core integration registers a basic health check that checks the database connection given a TContext. The health check is enabled by default and can be disabled using the DisableHealthChecks property in the configuration.

[!INCLUDE integration-observability-and-telemetry]

Logging

The The .NET Aspire Pomelo MySQL Entity Framework Core integration uses the following log categories:

  • Microsoft.EntityFrameworkCore.Database.Command.CommandCreated
  • Microsoft.EntityFrameworkCore.Database.Command.CommandExecuting
  • Microsoft.EntityFrameworkCore.Database.Command.CommandExecuted
  • Microsoft.EntityFrameworkCore.Database.Command.CommandError

Tracing

The The .NET Aspire Pomelo MySQL Entity Framework Core integration will emit the following tracing activities using OpenTelemetry:

  • OpenTelemetry.Instrumentation.EntityFrameworkCore

Metrics

The The .NET Aspire Pomelo MySQL Entity Framework Core integration currently supports the following metrics:

  • Microsoft.EntityFrameworkCore

See also