Collection updating support for EntityFramework with AutoMapper. Extends DBSet<T> with Persist<TDto>().InsertUpdate(dto) and Persist<TDto>().Delete(dto). Will find the matching object and will Insert/Update/Delete.
Get Started
| Product | Versions |
|---|---|
| .NET Standard | |
| Other |
README
AutoMapper.Collection
Adds ability to map collections to existing collections without re-creating the collection object.
Will Add/Update/Delete items from a preexisting collection object based on user defined equivalency between the collection's generic item type from the source collection and the destination collection.
How to add to AutoMapper?
Call AddCollectionMappers when configuring
Mapper.Initialize(cfg =>
{
cfg.AddCollectionMappers();
// Configuration code
});
Will add new IObjectMapper objects into the master mapping list.
Adding equivalency between two classes
Adding equivalence to objects is done with EqualityComparison extended from the IMappingExpression class.
cfg.CreateMap<OrderItemDTO, OrderItem>().EqualityComparison((odto, o) => odto.ID == o.ID);
Mapping OrderDTO back to Order will compare Order items list based on if their ID's match
Mapper.Map<List<OrderDTO>,List<Order>>(orderDtos, orders);
If ID's match, then AutoMapper will map OrderDTO to Order
If OrderDTO exists and Order doesn't, then AutoMapper will add a new Order mapped from OrderDTO to the collection
If Order exists and OrderDTO doesn't, then AutoMapper will remove Order from collection
Why update collection? Just recreate it
ORMs don't like setting the collection, so you need to add and remove from preexisting one.
This automates the process by just specifying what is equal to each other.
Can it just figure out the ID equivalency for me in Entity Framework?
Automapper.Collection.EntityFramework or Automapper.Collection.EntityFrameworkCore can do that for you.
Mapper.Initialize(cfg =>
{
cfg.AddCollectionMappers();
// entity framework
cfg.SetGeneratePropertyMaps<GenerateEntityFrameworkPrimaryKeyPropertyMaps<DB>>();
// entity framework core
cfg.SetGeneratePropertyMaps<GenerateEntityFrameworkCorePrimaryKeyPropertyMaps<DB>>();
// Configuration code
});
User defined equality expressions will overwrite primary key expressions.
What about comparing to a single existing Entity for updating?
Automapper.Collection.EntityFramework does that as well through extension method from of DbSet.
Translate equality between dto and EF object to an expression of just the EF using the dto's values as constants.
dbContext.Orders.Persist().InsertOrUpdate<OrderDTO>(newOrderDto);
dbContext.Orders.Persist().InsertOrUpdate<OrderDTO>(existingOrderDto);
dbContext.Orders.Persist().Remove<OrderDTO>(deletedOrderDto);
dbContext.SubmitChanges();
Note: This is done by converting the OrderDTO to Expression<Func<Order,bool>> and using that to find matching type in the database. You can also map objects to expressions as well.
Persist doesn't call submit changes automatically
Where can I get it?
First, install NuGet. Then, install AutoMapperMIT.Collection from the package manager console:
PM> Install-Package AutoMapperMIT.Collection
Additional packages
AutoMapper Collection for Entity Framework
PM> Install-Package AutoMapperMIT.Collection.EntityFramework
AutoMapper Collection for Entity Framework Core
PM> Install-Package AutoMapperMIT.Collection.EntityFrameworkCore
AutoMapper Collection for LinqToSQL
PM> Install-Package AutoMapperMIT.Collection.LinqToSQL
Downloads by Version
Depended On By
Find packages that declare this package as a dependency. NuGet does not provide a reverse-dependency endpoint, so candidates are checked on demand.
Adoption Assessment
Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.
Related Guides & Workflows
Learn how to evaluate, integrate, or audit this package in your .NET project.