Entity Framework/SQL2008 - How to Automatically Update LastModified fields for Entities?

Question

If i have the following entity:

public class PocoWithDates
{
   public string PocoName { get; set; }
   public DateTime CreatedOn { get; set; }
   public DateTime LastModified { get; set; }
}

Which corresponds to a SQL Server 2008 table with the same name/attributes...

How can i automatically:

Set the CreatedOn/LastModified field for the record to now (when doing INSERT)
Set the LastModified field for the record to now (when doing UPDATE)

When i say automatically, i mean i want to be able to do this:

poco.Name = "Changing the name";
repository.Save();

Not this:

poco.Name = "Changing the name";
poco.LastModified = DateTime.Now;
repository.Save();

Behind the scenes, "something" should automatically update the datetime fields. What is that "something"?

I'm using Entity Framework 4.0 - is there a way that EF can do that automatically for me? (a special setting in the EDMX maybe?)

From the SQL Server side, i can use DefaultValue, but that will only work for INSERT's (not UPDATE's).

Similarly, i can set a default value using a constructor on the POCO's, but again this will only work when instantiating the object.

And of course i could use Triggers, but it's not ideal.

Because i'm using Entity Framework, i can hook into the SavingChanges event and update the date fields here, but the problem is i need to become "aware" of the POCO's (at the moment, my repository is implemented with generics). I would need to do some sort of OO trickery (like make my POCO's implement an interface, and call a method on that). I'm not adversed to that, but if i have to do that, i would rather manually set the fields.

I'm basically looking for a SQL Server 2008 or Entity Framework 4.0 solution. (or a smart .NET way)

Any ideas?

EDIT

Thanks to @marc_s for his answer, but i went with a solution which is better for my scenario.

I just asked this question again, but then for EF6, since I love this question and the offered solutions, but the supplied code examples don't work for EF6.0 as they are currently. — Bart
– Bart, Commented Feb 20, 2014 at 15:23

Nick · Accepted Answer · 2011-06-08 17:01:32Z

53

I know I'm a little late to the party, but I just solved this for a project I'm working on and thought I'd share my solution.

First, to make the solution more re-usable, I created a base class with the timestamp properties:

public class EntityBase
{
    public DateTime? CreatedDate { get; set; }
    public DateTime? LastModifiedDate { get; set; }
}

Then I overrode the SaveChanges method on my DbContext:

public class MyContext : DbContext
{
    public override int SaveChanges()
    {
        ObjectContext context = ((IObjectContextAdapter)this).ObjectContext;

        //Find all Entities that are Added/Modified that inherit from my EntityBase
        IEnumerable<ObjectStateEntry> objectStateEntries =
            from e in context.ObjectStateManager.GetObjectStateEntries(EntityState.Added | EntityState.Modified)
            where
                e.IsRelationship == false &&
                e.Entity != null &&
                typeof(EntityBase).IsAssignableFrom(e.Entity.GetType())
            select e;

        var currentTime = DateTime.Now;

        foreach (var entry in objectStateEntries)
        {
            var entityBase = entry.Entity as EntityBase;

            if (entry.State == EntityState.Added)
            {
                entityBase.CreatedDate = currentTime;
            }

            entityBase.LastModifiedDate = currentTime;
        }

        return base.SaveChanges();
    }
}

answered Jun 8, 2011 at 17:01

Nick

6937 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

RPM1984 Over a year ago

Yep, i thought of this, but then IMO the POCO's are no longer "POCOs" since they now inherit from a base class whose only purpose is to serve timestamp operations (eg a database concern).

Rowan Over a year ago

If you don't want to use a base class for your POCOs you can use entry.CurrentValues["CreatedDate"] to set the value.

Ken Smith Over a year ago

Very nice. I modified it slightly by moving the EntityBase stuff out into an interface, and because I'm using Database first, I added it to the T4 template that generates the custom DBContext. But very handy, thanks.

Shaun Luttin Over a year ago

Be sure to also override SaveChangesAsync. E.g. public override Task<int> SaveChangesAsync() { /* do something */ return base.SaveChangesAsync(); }

Echiban Over a year ago

Code above does not work in all cases. I wind up using a different logic to get entries: var entries = ChangeTracker.Entries();

|

RPM1984 · Accepted Answer · 2010-10-12 01:03:36Z

As i have a service layer mediating between my controllers (im using ASP.NET MVC), and my repository, i have decided to auto-set the fields here.

Also, my POCO's have no relationships/abstractions, they are completely independant. I would like to keep it this way, and not mark any virtual properties, or create base classes.

So i created an interface, IAutoGenerateDateFields:

public interface IAutoGenerateDateFields
{
   DateTime LastModified { get;set; }
   DateTime CreatedOn { get;set; }
}

For any POCO's i wish to auto-generate these fields, i implement this inteface.

Using the example in my question:

public class PocoWithDates : IAutoGenerateDateFields
{
   public string PocoName { get; set; }
   public DateTime CreatedOn { get; set; }
   public DateTime LastModified { get; set; }
}

In my service layer, i now check if the concrete object implements the interface:

public void Add(SomePoco poco)
{
   var autoDateFieldsPoco = poco as IAutoGenerateDateFields; // returns null if it's not.

   if (autoDateFieldsPoco != null) // if it implements interface
   {
      autoDateFieldsPoco.LastModified = DateTime.Now;
      autoDateFieldsPoco.CreatedOn = DateTime.Now;
   }

   // ..go on about other persistence work.
}

I will probably break that code in the Add out to a helper/extension method later on.

But i think this is a decent solution for my scenario, as i dont want to use virtuals on the Save (as i'm using Unit of Work, Repository, and Pure POCO's), and don't want to use triggers.

If you have any thoughts/suggestions, let me know.

famousgarkin · Accepted Answer · 2012-11-16 07:20:35Z

6

I would also like to put forward a late solution. This one is only applicable to the .NET Framework 4 but makes this sort of task trivial.

var vs = oceContext.ObjectStateManager.GetObjectStateEntries(EntityState.Modified);
foreach (var v in vs)
{
    dynamic dv = v.Entity;
    dv.DateLastEdit = DateTime.Now;
}

edited Nov 16, 2012 at 7:20

famousgarkin

14.2k5 gold badges60 silver badges74 bronze badges

answered Jul 25, 2011 at 9:50

chinupson

6,2971 gold badge18 silver badges8 bronze badges

2 Comments

RPM1984 Over a year ago

isn't this is basically the same as @Nick's answer?

chinupson Over a year ago

This method requires no base class, so the inheritance chain stays intact.

the_joric · Accepted Answer · 2017-04-03 14:33:07Z

6

here is edited version of previous response. Previous one didn't work for updates for me.

public override int SaveChanges()
    {
        var objectStateEntries = ChangeTracker.Entries()
            .Where(e => e.Entity is TrackedEntityBase && (e.State == EntityState.Modified || e.State == EntityState.Added)).ToList();
        var currentTime = DateTime.UtcNow;
        foreach (var entry in objectStateEntries)
        {
            var entityBase = entry.Entity as TrackedEntityBase;
            if (entityBase == null) continue;
            if (entry.State == EntityState.Added)
            {
                entityBase.CreatedDate = currentTime;
            }
            entityBase.LastModifiedDate = currentTime;
        }

        return base.SaveChanges();
    }

edited Apr 3, 2017 at 14:33

the_joric

12.3k6 gold badges40 silver badges58 bronze badges

answered Apr 1, 2015 at 23:02

serg.salo

5901 gold badge8 silver badges14 bronze badges

Comments

marc_s · Accepted Answer · 2010-10-07 08:34:56Z

1

You have two options:

have a base class for all your business entity classes that does the
```
poco.LastModified = DateTime.Now;
```
in a virtual .Save() method that all others would have to call
use a trigger in the database

I don't think there's any other reasonably safe and easy method to achieve this.

answered Oct 7, 2010 at 8:34

marc_s

760k186 gold badges1.4k silver badges1.5k bronze badges

1 Comment

RPM1984 Over a year ago

Can't do option 1. Save happens on the UnitOfWork (not the POCO's - i should have mentioned that, sorry). Hence me mentioning "SavingChanges" as a possibility. I dont really want to go down the trigger route (makes debugging a nightmare). Think i would rather manually set the fields in my service layer.

cagedwhale · Accepted Answer · 2017-05-26 13:29:26Z

had to add base entity extend it from my database first partial class (which is not ideal)

    public override int SaveChanges()
    {
        AddTimestamps();
        return base.SaveChanges();
    }

    public override async Task<int> SaveChangesAsync()
    {
        AddTimestamps();
        return await base.SaveChangesAsync();
    }

    private void AddTimestamps()
    {
        //var entities = ChangeTracker.Entries().Where(x => x.Entity is BaseEntity && (x.State == EntityState.Added || x.State == EntityState.Modified));

        //ObjectiveContext context = ((IObjectContextAdapter)this).ObjectContext;

        var entities = ChangeTracker.Entries().Where(e => e.Entity is BaseEntity && (e.State == EntityState.Modified || e.State == EntityState.Added)).ToList();

        var currentUsername = !string.IsNullOrEmpty(System.Web.HttpContext.Current?.User?.Identity?.Name)
            ? HttpContext.Current.User.Identity.Name
            : "Anonymous";

        foreach (var entity in entities)
        {
            if (entity.State == EntityState.Added)
            {
                ((BaseEntity)entity.Entity).CREATEDON = DateTime.UtcNow;
                ((BaseEntity)entity.Entity).CREATEDBY = currentUsername;
            }

            ((BaseEntity)entity.Entity).MODIFIEDON = DateTime.UtcNow;
            ((BaseEntity)entity.Entity).MODIFIEDBY = currentUsername;
        }
    }

Md. Nazrul Islam · Accepted Answer · 2014-09-18 08:45:46Z

We can use partial class and override SaveChanges method to achieve this.

using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Data.Entity.Core.Objects;
using System.Data.Entity.Infrastructure;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Web;


namespace TestDatamodel
{
    public partial class DiagnosisPrescriptionManagementEntities
    {
        public override int SaveChanges()
        {
            ObjectContext context = ((IObjectContextAdapter)this).ObjectContext;

            foreach (ObjectStateEntry entry in
                     (context.ObjectStateManager
                       .GetObjectStateEntries(EntityState.Added | EntityState.Modified)))
            {                    
                if (!entry.IsRelationship)
                {
                    CurrentValueRecord entryValues = entry.CurrentValues;
                    if (entryValues.GetOrdinal("ModifiedBy") > 0)
                    {
                        HttpContext currentContext = HttpContext.Current;
                        string userId = "nazrul";
                        DateTime now = DateTime.Now;

                        if (currContext.User.Identity.IsAuthenticated)
                        {
                            if (currentContext .Session["userId"] != null)
                            {
                                userId = (string)currentContext .Session["userId"];
                            }
                            else
                            {                                    
                                userId = UserAuthentication.GetUserId(currentContext .User.Identity.UserCode);
                            }
                        }

                        if (entry.State == EntityState.Modified)
                        {
                           entryValues.SetString(entryValues.GetOrdinal("ModifiedBy"), userId);
                           entryValues.SetDateTime(entryValues.GetOrdinal("ModifiedDate"), now);
                        }

                        if (entry.State == EntityState.Added)
                        {
                            entryValues.SetString(entryValues.GetOrdinal("CreatedBy"), userId);
                            entryValues.SetDateTime(entryValues.GetOrdinal("CreatedDate"), now);
                        }
                    }
                }
            }

            return base.SaveChanges();
        }
    }
}

Collectives™ on Stack Overflow

Entity Framework/SQL2008 - How to Automatically Update LastModified fields for Entities?

7 Answers 7

9 Comments

Comments

2 Comments

Comments

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

9 Comments

Comments

2 Comments

Comments

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related