Soft-Delete in Entity Framework Core 2.0

In this demo we will examine how to override the SaveChanges method of the DbContext class in order to implement a soft-delete functionality in Entity Framework Core 2.0.

Soft-delete means that, instead of deleting database records, you’ll “mark them” as deleted. This can be accomplished by having some sort of “IsDeleted” column and setting it to true.

We want that anytime we try to delete any entity with the column “IsDeleted”, we instead update that column value to true.

Example

One way of doing this is by overriding the SaveChanges method, like this:


public override int SaveChanges()
 {
 // Soft-Delete
    foreach (var item in ChangeTracker.Entries()
     .Where(e => e.State == EntityState.Deleted &&
     e.Metadata.GetProperties().Any(x => x.Name == "IsDeleted")))
 {
       item.State = EntityState.Unchanged;
       item.CurrentValues["IsDeleted"] = true;
 }

    return base.SaveChanges();
 }

You have to put this code in the class in your project that inherits from DbContext.

So, now if you have an entity or model that have the IsDeleted property, then it will automatically have the soft-delete functionality. Example:


class Student
{
   public int Id { get; set; }
   public string Name{ get; set; }
   public int Age{ get; set; }
   public bool IsDeleted{ get; set; }
}

If you don’t want to use soft-delete, then just don’t add an IsDeleted column to your entity.

Summary

With soft-delete you don’t delete entities, but update a column indicating that the entity is deleted. So you update instead of delete. You can use this to avoid deleting data that you may want to use later. Override the SaveChanges method to accomplish this as showed in this post.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s