Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

EF Code First: is good to call DetectChanges just before SaveChanges?

I have read few articles (article1, article2) about Entity Framework that it calls DetectChanges many times, which makes it very slow when working with large amounts of data.

Can i, for example, disable the autoDetectChanges when i initialize the context, and just call DetectChanges() before calling .SaveChanges()?

Will the context recognize the inserted/changed/deleted entities?

var _dbContext = new ProjectContext();
_dbContext.Configuration.AutoDetectChangesEnabled = false;

// add/edit/delete entities

_dbContext.ChangeTracker.DetectChanges();
_dbContext.SaveChanges();

Should this approach work? or it may create hidden bugs?

like image 873
Catalin Avatar asked Mar 11 '13 15:03

Catalin


1 Answers

Arthur Vickers defines a rule when DetectChanges doesn't need to be called (even not before SaveChanges) in this blog post:

No call to EF code will leave the context in a state where DetectChanges needs to be called if it didn’t need to be called before.

Regarding Add and Delete these are "EF code" methods because you either call Add or Delete or you set the state of context.Entry(entity).State to Added or Deleted. So, if you would just loop through a bunch of entites and add or delete them then you don't need to call DetectChanges at all.

Regarding Edit it is, I believe, a bit more subtle. When you update entities by using either...

context.Entry(entity).CurrentValues.SetValues(someObject);

...or by using the property API of DbContext...

context.Entry(entity).Property(e => e.SomeProperty).CurrentValue = someValue;

...then you don't need DetectChanges (even not before SaveChanges) either because these are again calls into "EF code".

If you just change property values of an entity like...

entity.SomeProperty = someValue;

...then the second rule in the same blog post linked above applies:

Any time that non-EF code changes any property value of an entity or complex object then DetectChanges may need to be called.

And I think you need in fact only one single call to DetectChanges before SaveChanges if you just loop through some entities, load them into or attach them to the context and change some (scalar and complex) property values.

If you do more complex stuff (maybe relationship changes? or something else?) your approach might not be safe anymore because

  1. AutoDetectChanges would not be implemented in the way it is and called in many EF methods if it would be only necessary once right before SaveChanges

  2. it is mentioned in the same blog post again that

    If the code makes change changes to the properties of the entities instead of just calling Add or Attach, then, by Rule 2, DetectChanges will need to be called, at least as part of SaveChanges and possibly also before then.

    (Highlighting from me)

Unfortunately I don't know an example of code that would show when calling DetectChanges at earlier stages than right before SaveChanges is necessary. But because of point 1 above I am sure such examples exist.

like image 125
Slauma Avatar answered Oct 04 '22 21:10

Slauma