Saturday 11 April 2020

What's the FASTEST way to insert in Entity Framework?

This question keeps getting asked a few times every week on Stack Overflow. Most common solutions usually involve:
  • Using AddRange over Add method
  • Calling SaveChanges every X entities
  • Creating a new context every X entities
  • Disabling Change Detection
  • Disabling Change Validation
  • Disabling Proxy
Some of these solutions are good, some lead to side impacts and none of them fix the main issue: One database round-trip is made for every entity you save!
So, if you have 5000 entities to insert, 5000 database round-trips will be executed which is INSANELY slow.
A very common mistake is believing the AddRange method perform a Bulk Insert. Using the AddRange method greatly improve the performance because it calls the DetectChanges method only once after all entities are added to the change tracker. However, the SaveChanges method will still make one database round-trip per entity.

Solution

To solve the performance problem, you need to reduce the number of database round-trips, and this is exactly what Entity Framework Extensions made by ZZZ Projects do by providing the BulkInsert method and all other bulk operations:
  • BulkSaveChanges
  • BulkInsert
  • BullUpdate
  • BulkDelete
  • BulkMerge

With this library, only a few database round-trips will now be required when saving 5000 entities which can lead to performance improvement by 50x times and more.
Getting started with this library could not be easier. You download it using NuGet, and all bulk methods are automatically available from your context instance since methods extend the DbContext class.
Without having to configure anything, all models and scenarios are supported such as Code First, Database First, Inheritances (TPC, TPH, and TPT), Relationship, and everything else!

EF BulkSaveChanges

BulkSaveChanges method works like SaveChanges but performs save operations (INSERT, UPDATE, and DELETE) way faster. There are multiple options available such as:
  • Disable Concurrency Check
  • Disable Entity Framework Propagation for better performance
  • Update Modified values only
This method is normally recommended over bulk methods such as Bulk Insert since it acts like SaveChanges by using the Change Tracker and propagating the value.
Example

ctx.BulkSaveChanges();

ctx.BulkSaveChanges(useEntityFrameworkPropagation: false);

ctx.BulkSaveChanges(options =>
{
    options.AllowConcurrency = false;
    options.ForceUpdateUnmodifiedValues = false;
});

EF BulkInsert

BulkInsert method performs an INSERT operation and outputs the identity value. There are multiple options available such as:
  • Custom Column
  • Disabled output value for better performance
  • Insert only entities that don't already exists
  • Keep Identity Value
Bulk Insert is faster than BulkSaveChanges. However, Bulk Insert doesn't use the Change Tracker so identity value propagation may differ. If you need to perform multiple bulk operations with some relation, it's recommended to use BulkSaveChanges instead.
Example

ctx.BulkInsert(customers);
               
ctx.BulkInsert(customers, options =>
{
    options.ColumnInputExpression = x => new {x.Code, x.Email};
    options.AutoMapOutputDirection = false;
    options.InsertIfNotExists = true;
    options.InsertKeepIdentity = true;
});

EF BulkUpdate

BulkUpdate method performs an UPDATE operation.
There are multiple options available such as:
  • Custom Column
  • Custom Key
  • Disable Concurrency Check

Example

ctx.BulkUpdate(customers, options =>
{
    options.ColumnInputExpression = x => new { x.Code, x.Email };
    options.ColumnPrimaryKeyExpression = x => new { x.Code };
    options.AllowConcurrency = false;
});

EF BulkDelete

BulkDelete method performs a DELETE operation.
There are multiple options available such as:
  • Custom Key
  • Disable Concurrency Check
Example

ctx.BulkDelete(list);

ctx.BulkDelete(list, options =>
{
    options.ColumnPrimaryKeyExpression = x => new { x.Code };
    options.AllowConcurrency = false;
});

EF BulkMerge

BulkMerge method performs an UPSERT operation and outputs the identity value. Existing entities matching the key are updated, and new entities are inserted.
There are multiple options available such as:
  • Custom Column
  • Custom Column (Insert Only)
  • Custom Column (Update Only)
  • Custom Key
  • Disabled output value for better performance
  • Keep Identity Value

Example



ctx.BulkMerge(list);
               
ctx.BulkMerge(list, options =>
{
    options.ColumnInputExpression = x => new { x.Code, x.CreatedDate, x.UpdatedDate };
    options.IgnoreOnMergeInsertExpression = x => new { x. UpdatedDate };
    options.IgnoreOnMergeUpdateExpression = x => new { x.ID, x.CreatedDate };
    options.ColumnPrimaryKeyExpression = x => new { x.Code };
    options.AutoMapOutputDirection = false;
    options.MergeKeepIdentity = true;
});

No comments:

Post a Comment