FxMap.EntityFrameworkCore 4.1.1

<p align="center"> <img src="https://raw.githubusercontent.com/quyvu01/FxMap/main/FxMap.png" alt="FxMap" width="96" /> </p>

<h1 align="center">FxMap.EntityFrameworkCore</h1>

<p align="center"> Entity Framework Core data provider for FxMap — answers FxMap requests straight from your <code>DbContext</code>. </p>

<p align="center"> <a href="https://www.nuget.org/packages/FxMap.EntityFrameworkCore"><img alt="NuGet" src="https://img.shields.io/nuget/v/FxMap.EntityFrameworkCore.svg" /></a> <a href="https://www.nuget.org/packages/FxMap.EntityFrameworkCore"><img alt="Downloads" src="https://img.shields.io/nuget/dt/FxMap.EntityFrameworkCore.svg" /></a> <a href="https://github.com/quyvu01/FxMap/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" /></a> </p>

<p align="center"> <a href="https://github.com/quyvu01/FxMap"><b>FxMap</b></a> · <a href="https://fxmapper.net"><b>Documentation</b></a> · <a href="https://github.com/quyvu01/TestFxMap-Demo"><b>Demo project</b></a> </p>

The owning service of an entity registers it with EntityConfigureOf<T> and lists its DbContexts. FxMap then turns incoming requests (ids plus expressions) into one EF Core query per distributed key and returns only the requested values.

Installation

dotnet add package FxMap.EntityFrameworkCore

Usage

public sealed class UserDistributedKey : IDistributedKey;

// 1. Describe the entity: its id, default property and distributed key
public class UserConfig : EntityConfigureOf<User>
{
    protected override void Configure()
    {
        Id(x => x.Id);
        DefaultProperty(x => x.Name);
        UseDistributedKey<UserDistributedKey>();
    }
}

// 2. Register FxMap and the DbContext(s) that hold your entities
builder.Services.AddFxMap(cfg =>
    {
        cfg.AddEntitiesFromAssemblyContaining<SomeEntityAssemblyMarker>();
        cfg.AddProfilesFromAssemblyContaining<SomeProfileAssemblyMarker>();
    })
    .AddEntityFrameworkCore(options =>
        options.AddDbContexts(typeof(AppDbContext), typeof(ReportingDbContext)));

AddEntitiesFromAssemblyContaining (or AddEntityConfig<T>) must run before AddEntityFrameworkCore.

How requests are executed

• One query per request. All ids and all expressions of a request are answered by a single AsNoTracking query with a projection, using the expression language (navigation, filters, aggregations, projections, indexers).
• Several DbContexts are supported. FxMap routes each entity to the DbContext that exposes it as a DbSet.
• Each query runs in its own DI scope, with its own DbContext, so requests can run in parallel safely. It does not see uncommitted data held by the caller's DbContext or transaction.
• Ids are parsed to the entity's id type: string, Guid, int, long, short, byte, decimal, double, float and their unsigned / nullable forms, or any strongly typed id with an IStronglyTypeConverter<TId> registered. Ids that cannot be parsed are ignored.
• Ids are answered the way they were sent. "ABCD…", {…} or N-format Guids, "007" for 7 or " 7 " are found and matched back to the object that sent them (2.3.5+).
• Aggregates over empty collections: :count and :sum return 0; :min, :max and :avg return null (2.3.5+).
• ExposedName(x => x.Email, "UserEmail") renames a property in expressions; the original name no longer resolves.

Related packages