Encamina.Enmarcha.Data.EntityFramework 8.1.5-preview-07

Data - Entity Framework

Entity Framework Data project primarily contains Entity Framework implementations based on the abstractions provided by Encamina.Enmarcha.Data.Abstractions, as well as some other utilities related to Entity Framework.

Setup

Nuget package

First, install NuGet. Then, install Encamina.Enmarcha.Data.EntityFramework from the package manager console:

PM> Install-Package Encamina.Enmarcha.Data.EntityFramework

.NET CLI:

First, install .NET CLI. Then, install Encamina.Enmarcha.Data.EntityFramework from the .NET CLI:

dotnet add package Encamina.Enmarcha.Data.EntityFramework

How to use

In the following example, we will demonstrate how to configure and add an Entity Framework implementation of the IFullUnitOfWork interface to the ServiceCollection, based on the FullUnitOfWork, using the following DbContext.

public class Foo
{
    public int Id { get; set; }
    public string Text { get; set; }
}

public class Bar
{
    public int Id { get; set; }
    public string Text { get; set; }
}

public class MyDBContext : DbContext
{
    public DbSet<Foo> Foos { get; set; }
    public DbSet<Bar> Bars { get; set; }

}

The next step is to inherit from FullUnitOfWork and create a custom class that receives an instance of MyDBContext in its constructor.

public class MyFullUnitOfWork: FullUnitOfWork, IFullUnitOfWork
{
    public MyFullUnitOfWork(MyDBContext dbContext) 
        : base(dbContext)
    {
    }
}

In the Program.cs or a similar entry point file in your project, add the following code:

// Entry point
var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
   // ...
});

// ...

services.AddDbContext<DatabaseContext>(opt =>
{
    opt.UseSqlServer(configuration.GetConnectionString("DefaultConnection")); // Configures your provider
}, ServiceLifetime.Scoped);

// ...

builder.Services.AddScoped<IFullUnitOfWork, MyFullUnitOfWork>();

And now, we can resolve the IFullUnitOfWork interface with construction injection:

public class MyClass
{
    private readonly IFullUnitOfWork uow;

    public MyClass(IFullUnitOfWork uow)
    {
        this.uow = uow;
    }

    public async Task TestAddFooAndBarAndSaveAsync(CancellationToken cts)
    {
        var fooRepository = uow.GetAsyncRepository<Foo>();
        var barRepository = uow.GetAsyncRepository<Bar>();

        await fooRepository.AddAsync(new Foo() { Text = "Foo1" }, cts);
        await fooRepository.AddAsync(new Foo() { Text = "Foo2" }, cts);
        await barRepository.AddAsync(new Bar() { Text = "Bar1" }, cts);

        await uow.SaveAsync(cts);
    }
}

Within the NuGet package, there are more interfaces along with their corresponding base implementations.

• AsyncReadRepositoryBase<TEntity>: Base class for asynchronous read repositories. It implements IAsyncReadRepository<TEntity>.
• AsyncRepositoryBase<TEntity>: Base class for asynchronous repositories. It implements IAsyncRepository<TEntity>.
• AsyncUnitOfWorkBase: Base class for an asynchronous unit of work. It implements IAsyncUnitOfWork.
• AsyncWriteRepositoryBase<TEntity>: Base class for asynchronous write repositories. It implements IAsyncWriteRepository<TEntity>.
• FullRepositoryBase<TEntity>: Base class for a repository with both synchronous and asynchronous operations to read and write entities. It implements IFullRepository<TEntity>.
• FullUnitOfWork: Base class for a unit of work that can manage both synchronous and asynchronous operations. It implements IFullUnitOfWork.
• ReadRepositoryBase<TEntity>: Base class for a read repositories. It implements IReadRepository<TEntity>.
• RepositoryBase<TEntity>: Base class for a repositories. It implements IRepository<TEntity>.
• UnitOfWorkBase: Base class for an unit of work. It implements IUnitOfWork.
• WriteRepositoryBase<TEntity>: Base class for write repositories. It implements IWriteRepository<TEntity>.

Other functionalities

Inside the NuGet package, you will find some extension methods related to Entity Framework.

// ...

var queryableFoo = dbContext.AsQueryable<Foo>(withNoTracking: true, withIdentityResolution: true);

// More methods available in DbContextExtensions...