MultiTenancy.EntityFrameworkCore 1.6.1

MultiTenancy.EntityFrameworkCore

Multi-tenant data isolation support for Entity Framework Core applications

Installation

dotnet add package MultiTenancy.EntityFrameworkCore

Description

Multi-tenant data isolation support for Entity Framework Core applications.

Provides the ambient tenant context (ICurrentTenantService) and, since 1.5.0, the EF Core half: a global tenant query filter and a write-side stamping guard.

Usage

Have your DbContext implement ITenantScopedDbContext, then call the two helpers:

using MultiTenancy.Abstractions;
using MultiTenancy.EntityFrameworkCore;

public class AppDbContext : DbContext, ITenantScopedDbContext
{
    private readonly ICurrentTenantService _currentTenantService;

    public ICurrentTenantService CurrentTenantService => _currentTenantService;

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        // ... entity configuration ...

        modelBuilder.ApplyTenantFilters(this, TenantFilterMode.FailOpen);
    }

    public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
    {
        ChangeTracker.StampTenancy(_currentTenantService);
        return await base.SaveChangesAsync(cancellationToken);
    }
}

ApplyTenantFilters(context, mode)

Adds a global query filter to every entity deriving from BaseTenantEntity.

mode is required and has no default — the two polarities differ by one character at the call site and by "every tenant's rows" at runtime:

⚠️ Pass this as context. The filter is deliberately rooted at the DbContext instance so EF Core substitutes the executing context on every query. ICurrentTenantService is registered Scoped, and EF caches the model once per process — so a helper that captured the service instance would pin every future request to whichever request happened to build the model. That is a permanent cross-tenant leak, and it is why this method takes a context rather than a service.

ChangeTracker.StampTenancy(currentTenantService)

Stamps TenantId/UserId onto newly added tenant-scoped rows that still hold Guid.Empty, from the ambient tenant. Purely additive: it never overwrites a value that is already set, never stamps non-Added rows, and is a no-op when there is no ambient tenant.

It exists because a row saved with TenantId = Guid.Empty raises no error and violates no constraint — it is simply invisible to the tenant that owns it, forever. Child rows created inside an aggregate are the usual way that happens.

Documentation

See the NuGet package page for full documentation.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Packages

• DomainCore
• Security.Claims

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

How to Publish

cd C:\desktopContents\projects\SaaS\NuGetPackages\MultiTenancy.EntityFrameworkCore
.\publish.ps1 -ApiKey XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Bump patch  # Bug fixes
.\publish.ps1 -ApiKey XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Bump minor  # New features
.\publish.ps1 -ApiKey XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Bump major  # Breaking changes