PeerConcept.DataAccessExtensions 1.0.0

PeerConcept.DataAccessExtensions

This package contains some pre-built classes wrapped over EF Core's DbContext. Available in this package:

DbContextRepository

The base class DbContextRepository<TDbContext, TEntity> takes 2 type arguments:

• TDbContext should extend EF Core's base DbContext
• TEntity should implement the IEntity interface (empty interface)

It provides the following methods:

• Create(TEntity entity) attaches the entity to the underlying db context
• Update(TEntity entity) updates an entity which is tracked by the underlying db context
• Delete(TEntity entity) deletes an entity from the underlying db context

DbContextPkRepository

The DbContextPkRepository<TDbContext, TEntity, TPk> class extends the DbContextRepository class to offer support for primary keys. The primary key type is specified by the TPk type argument. The TEntity type should implement the IPkEntity<TPk> interface which requires a public Id property of type TPk.

It provides the following methods:

• Get(TPk pk) fetches an entity from the underlying db context, whose primary key matches the provided value
• Delete(TPk pk) removes an entity from the underlying db context, whose primary key matches the provided value

UnitOfWork

Implementation of the Unit of Work pattern on top of a TDbContext db context. It uses .NET's built-in IoC container to create an isolated scope in which all underlying dependencies (db context, repositories) are registered.

It provides the following methods:

• GetRepository<TRepository>() resolves the TRepository dependency from the isolated scope's service provider
• Commit() saves changes to the underlying db context and completes the ambient transaction
• Dispose() disposes underlying dependencies and self

Important The UnitOfWork is registered as a transient service. Resolving the IUnitOfWork dependency will result in an instance which is scoped to the service scope which resolves it. This will result in a singleton-like behavior within the same service scope, whereby multiple instances of UnitOfWork which are resolved in the same service scope will reference the same db context and repository instances.

UnitOfWorkFactory

This is the intended way of instantiating units of work. The factory is registered as a singleton to ensure a single entry point for generating units of work.

It provides the following methods:

• Create() resolves a new UnitOfWork scoped to an isolated service scope.

Example

// IServiceProvider services
var uowFactory = services.GetRequiredService<IUnitOfWorkFactory>();
using var unitOfWork = uowFactory.Create();

var repository = unitOfWork.GetRepository<ISomeRepository>();
repository.Create(someData);

unitOfWork.Commit();