AnointedAutomation.Repository.MySql 1.0.6

AnointedAutomation.Repository.MySql

Jesus is King ✝️

A generic repository and helper for MySQL on Entity Framework Core (Pomelo provider). GenericRepository<T> wraps any DbContext with async CRUD, paging, ordering and projection, and MySqlHelper adds connection testing, raw SQL, transactions and a log buffer, following the same style as AnointedAutomation.Repository.Mongo.

Installation

dotnet add package AnointedAutomation.Repository.MySql

• Target framework: net10.0
• Dependencies:
  • AnointedAutomation.Logging
  • Microsoft.EntityFrameworkCore 10.0.12
  • Pomelo.EntityFrameworkCore.MySql 9.0.0

Quick start

Use GenericRepository<T> over your own DbContext, which defines the entity model:

using System.Collections.Generic;
using System.Threading.Tasks;
using AnointedAutomation.Repository.MySql;
using Microsoft.EntityFrameworkCore;

public class Customer
{
    public int Id { get; set; }
    public string Email { get; set; }
    public bool IsActive { get; set; }
}

public class ShopDbContext : DbContext
{
    public ShopDbContext(DbContextOptions<ShopDbContext> options) : base(options) { }
    public DbSet<Customer> Customers { get; set; }
}

public static class Example
{
    public static async Task RunAsync(string connectionString)
    {
        DbContextOptions<ShopDbContext> options = new DbContextOptionsBuilder<ShopDbContext>()
            .UseMySql(connectionString, ServerVersion.AutoDetect(connectionString))
            .Options;

        using ShopDbContext context = new ShopDbContext(options);
        IGenericRepository<Customer> customers = new GenericRepository<Customer>(context);

        Customer added = await customers.AddAsync(new Customer { Email = "john@example.com", IsActive = true });
        Customer byId = await customers.GetByIdAsync(added.Id);
        IEnumerable<Customer> active = await customers.FindAsync(c => c.IsActive);
        IEnumerable<Customer> firstPage = await customers.GetPagedAsync(c => c.IsActive, c => c.Email, descending: false, skip: 0, take: 20);
        int count = await customers.CountAsync();
        await customers.DeleteAsync(added.Id);
    }
}

API overview

All types are in the AnointedAutomation.Repository.MySql namespace.

IGenericRepository<T> / GenericRepository<T>

Constructor: GenericRepository<T>(DbContext context). Every write calls SaveChangesAsync immediately.

IMySqlHelper / MySqlHelper

Other types

Using MySqlHelper with your own model

DynamicDbContext has no entity types configured, so the helper's generic CRUD methods only work once Database is a context that maps your entities. Assign your own context:

using AnointedAutomation.Repository.MySql;
using Microsoft.EntityFrameworkCore;

public static class HelperSetup
{
    public static IMySqlHelper Create(DbContext appContext, string connectionString)
    {
        IMySqlHelper helper = new MySqlHelper
        {
            Database = appContext,
            ConnectionString = connectionString
        };
        return helper;
    }
}

With your context in place, TestConnection, GetTableNames, ExecuteRawSqlAsync, ExecuteInTransactionAsync and the generic CRUD methods all run against it.

Dependency injection

GenericRepository<T> takes a DbContext, so expose your context under that base type:

using AnointedAutomation.Repository.MySql;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;

public static class MySqlSetup
{
    public static IServiceCollection AddShopData(this IServiceCollection services, string connectionString)
    {
        services.AddDbContext<ShopDbContext>(o =>
            o.UseMySql(connectionString, ServerVersion.AutoDetect(connectionString)));
        services.AddScoped<DbContext>(sp => sp.GetRequiredService<ShopDbContext>());
        services.AddScoped(typeof(IGenericRepository<>), typeof(GenericRepository<>));
        return services;
    }
}

AddDbContext comes from Microsoft.EntityFrameworkCore; the IServiceCollection extension style assumes an ASP.NET Core or Generic Host app.

Related packages

• AnointedAutomation.Logging: the LogMessage type used for the log buffer.
• AnointedAutomation.Repository.Mongo: the MongoDB counterpart.
• AnointedAutomation.Objects: plain models you can map with EF Core.

License

MIT. See LICENSE.

Support This Project

This library is free and open source. The best way to support the work is to shop with us:

• Christian items: https://store.anointed.company
• Pets: https://www.animaldander.com
• Everything else: https://www.mart.club

Found a bug or have a request? Open an issue at https://github.com/AnointedAutomation/AnointedAutomation/issues.