DotEmilu.EntityFrameworkCore 10.0.0

DotEmilu.EntityFrameworkCore

Entity Framework Core utilities for DotEmilu — auditable entity interceptors, soft-delete interceptor, base entity configurations with TPC/TPH/TPT mapping strategies, pagination, and CQRS-ready patterns.

Install

dotnet add package DotEmilu.EntityFrameworkCore

This transitively installs DotEmilu.Abstractions.

What's included

Interceptors

Entity configurations

Mapping strategies

Extension methods

EntityTypeBuilder extensions:

PropertyBuilder extensions:

ModelBuilder extensions:

IQueryable extensions:

Contracts

DI registration

Auditable entities

// Define an auditable entity
public class Invoice : BaseAuditableEntity<int, Guid>
{
    public string Number { get; set; } = default!;
    public decimal Amount { get; set; }
    public DateOnly Date { get; set; }
}

// Implement IContextUser<Guid> for audit tracking
public class CurrentUser(IHttpContextAccessor accessor) : IContextUser<Guid>
{
    public Guid Id => Guid.Parse(accessor.HttpContext!.User.FindFirstValue(ClaimTypes.NameIdentifier)!);
}

// Register interceptors
services
    .AddSoftDeleteInterceptor()
    .AddAuditableEntityInterceptors(Assembly.GetExecutingAssembly());

DbContext configuration

public class InvoiceDbContext(DbContextOptions<InvoiceDbContext> options) : DbContext(options)
{
    public DbSet<Invoice> Invoices => Set<Invoice>();

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // Auto-configure audit columns for all IBaseAuditableEntity<Guid> entities
        modelBuilder.ApplyBaseAuditableEntityConfiguration<Guid>();

        // Auto-configure base entity columns from assembly
        modelBuilder.ApplyBaseEntityConfiguration(typeof(Invoice).Assembly);

        // Apply custom IEntityTypeConfiguration<T> from assembly
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(InvoiceDbContext).Assembly);
    }
}

Soft delete with IsDeleted column options

public class SongConfiguration : IEntityTypeConfiguration<Song>
{
    public void Configure(EntityTypeBuilder<Song> builder)
    {
        // Store IsDeleted as short (0/1) instead of bool, with index and query filter
        builder.UseIsDeleted(useShort: true, useIndex: true, useQueryFilter: true, order: 1);

        // Apply TPT mapping strategy
        builder.ApplyMappingStrategy(MappingStrategy.Tpt);
    }
}

Enum column comments

// Automatically generate SQL comments from enum values
builder.Property(s => s.SongType)
    .HasFormattedComment("{0} = {1}")     // "0 = Rock, 1 = Pop, 2 = Jazz"
    .IsRequired();

// Include [Description] attributes
builder.Property(s => s.Status)
    .HasFormattedComment("{0} = {2}", includeTitle: true);  // "Order Status: 0 = Pending Order, 1 = Completed"

Pagination

var result = await db.Invoices
    .OrderBy(i => i.Id)
    .AsPaginatedListAsync(pageNumber: 1, pageSize: 10, cancellationToken);

// result.Items           → IReadOnlyCollection<Invoice>
// result.TotalCount      → total records
// result.TotalPages      → computed from count / pageSize
// result.PageNumber       → current page
// result.HasPreviousPage → bool
// result.HasNextPage     → bool

CQRS pattern

Separate read and write concerns using interface segregation:

// Commands interface (tracked, read-write)
public interface IInvoiceCommands : IInvoiceEntities, IUnitOfWork;

// Queries interface (no-tracking, read-only)
public interface IInvoiceQueries : IInvoiceEntities;

// Shared entity sets
public interface IInvoiceEntities
{
    DbSet<Invoice> Invoices { get; }
}

Additional documentation

• Getting started
• Handler patterns
• Entity Framework Core patterns

Part of the DotEmilu ecosystem

Feedback

File bugs, feature requests, or questions on GitHub Issues.

Full documentation & source