A library for managing the lifetime of Entity Framework Core DbContext instances.
Note re package versioning: Please use the version of this library which matches your EF Core version.
For EF Core 6, the NuGet package can be found at Zejji.DbContextScope.EFCore6.
To avoid having a separate NuGet package for each EF Core version, for EF Core 7 onwards, the decision was taken to remove the EF Core version from the package name and instead have the Zejji.DbContextScope.EFCore package version number follow the EF Core version - the current NuGet package can be found at Zejji.DbContextScope.EFCore.
This package is based on the original DbContextScope repository by Mehdi El Gueddari with the following changes:
CallContext
with AsyncLocal
);RefreshEntitiesInParentScope
method so that it works correctly for entities with composite primary keys;DbContextCollection
's Commit
and CommitAsync
methods so that SaveChanges
can be called more than once if there is a DbUpdateConcurrencyException
(see this unmerged pull request in the original DbContextScope
repository);RegisteredDbContextFactory
class as a concrete implementation of the IDbContextFactory
interface, which allows users to easily register factory functions for one or more DbContext
type(s) during startup; andMehdi El Gueddari's original article describing the thinking behind the DbContextScope
library can be found here.
In summary, the library addresses the problem that injecting DbContext
instances as a scoped dependency (which ordinarily results in one instance per web request) offers insufficient control over the lifetime of DbContext
instances in more complex scenarios.
The DbContextScope
library allows users to create scopes which control the lifetime of ambient DbContext
instances, as well giving control over the exact time at which changes are saved.
For general usage instructions, see article referred to above and the original GitHub repository readme file (a copy of which is included in this repository here). Please note the Mehdime.Entity
namespace has been renamed to Zejji.Entity
.
The new RegisteredDbContextFactory
class can be used as follows:
In Startup.cs
, register a RegisteredDbContextFactory
instance as a singleton and register one or more DbContext
factory functions on that instance, e.g.:
using Zejji.Entity;
...
public void ConfigureServices(IServiceCollection services)
{
...
// Create an instance of the RegisteredDbContextFactory
var dbContextFactory = new RegisteredDbContextFactory();
// Register factory functions for each of the required DbContext types
dbContextFactory.RegisterDbContextType<DbContextOne>(() =>
new DbContextOne(Configuration.GetConnectionString("DatabaseOne")));
dbContextFactory.RegisterDbContextType<DbContextTwo>(() =>
new DbContextTwo(Configuration.GetConnectionString("DatabaseTwo")));
// Register the RegisteredDbContextFactory instance as a singleton
// with the dependency injection container.
services.AddSingleton<IDbContextFactory>(dbContextFactory);
...
}
See also the unit tests for RegisteredDbContextFactory
here.
dotnet add package Zejji.DbContextScope.EFCore
This project is licensed under the MIT License - see the LICENSE.txt file for details
Many thanks to Mehdi El Gueddari for creating the original DbContextScope
library.