EF 4.1 loading filtered child collections not working for many-to-many

by

I could reproduce exactly the behaviour you describe. What I got working is this:

context.Entry(student)
       .Collection(s => s.Courses)
       .Query()
       .Include(c => c.Students)
       .Where(c => c.Id == 1)
       .Load();

I don’t know why we should be forced also to load the other side of the many-to-many relationship (Include(...)) when we only want to load one collection. For me it feels indeed like a bug unless I missed some hidden reason for this requirement which is documented somewhere or not.

Edit

Another result: Your original query (without Include) …

context.Entry(student)
       .Collection(s => s.Courses)
       .Query()
       .Where(c => c.Id == 1)
       .Load();

… actually loads the courses into the DbContext as …

var localCollection = context.Courses.Local;

… shows. The course with Id 1 is indeed in this collection which means: loaded into the context. But it’s not in the child collection of the student object.

Edit 2

Perhaps it is not a bug.

First of all: We are using here two different versions of Load:

DbCollectionEntry<TEntity, TElement>.Load()

Intellisense says:

Loads the collection of entities from
the database. Note that entities that
already exist in the context are not
overwritten with values from the
database.

For the other version (extension method of IQueryable) …

DbExtensions.Load(this IQueryable source);

… Intellisense says:

Enumerates the query such that for
server queries such as those of
System.Data.Entity.DbSet,
System.Data.Objects.ObjectSet,
System.Data.Objects.ObjectQuery,
and others the results of the query
will be loaded into the associated
System.Data.Entity.DbContext,
System.Data.Objects.ObjectContext or
other cache on the client. This is
equivalent to calling ToList and then
throwing away the list without the
overhead of actually creating the
list.

So, in this version it is not guaranteed that the child collection is populated, only that the objects are loaded into the context.

The question remains: Why gets the Presentations collection populated but not the Courses collection. And I think the answer is: Because of Relationship Span.

Relationship Span is a feature in EF which fixes automatically relationships between objects which are in the context or which are just loaded into the context. But this doesn’t happen for all types of relationships. It happens only if the multiplicity is 0 or 1 on one end.

In our example it means: When we load the Presentations into the context (by our filtered explicit query), EF also loads the foreign key of the Presentation entites to the Student entity – “transparently”, which means, no matter if the FK is exposed as property in the model of not. This loaded FK allows EF to recognize that the loaded Presentations belong to the Student entity which is already in the context.

But this is not the case for the Courses collection. A course does not have a foreign key to the Student entity. There is the many-to-many join-table in between. So, when we load the Courses EF does not recognize that those courses belong to the Student which is in the context, and therefore doesn’t fix the navigation collection in the Student entity.

EF does this automatic fixup only for references (not collections) for performance reasons:

To fix relationship, EF transparently
rewrites the query to bring
relationship info for all relations
which has multiplicity of 0..1 or1 on
the other end; in other words
navigation properties that are entity
reference. If an entity has
relationship with multiplicity of
greater then 1, EF will not bring back
the relationship info because it could
be performance hit and as compared to
bringing a single foreign along with
rest of the record. Bringing
relationship info means retrieving all
the foreign keys the records has.

Quote from page 128 of Zeeshan Hirani’s in depth guide to EF.

It is based on EF 4 and ObjectContext but I think this is still valid in EF 4.1 as DbContext is mainly a wrapper around ObjectContext.

Unfortunately rather complex stuff to keep in mind when using Load.

And another Edit

So, what can we do when we want to explicitely load one filtered side of a many-to-many relationship? Perhaps only this:

student.Courses = context.Entry(student)
       .Collection(s => s.Courses)
       .Query()
       .Where(c => c.Id == 1)
       .ToList();

More Related Contents:

  1. Code-first vs Model/Database-first [closed]
  2. The relationship could not be changed because one or more of the foreign-key properties is non-nullable
  3. Should I enable or disable dynamic proxies with entity framework 4.1 and MVC3?
  4. How do I detach objects in Entity Framework Code First?
  5. ADO.NET DbContext Generator vs. ADO.NET Poco Entity Generator (ObjectContext)
  6. How to include a child object’s child object in Entity Framework 5
  7. Order navigation properties when using Include and/or Select methods with EF 4.1 Code-First?
  8. Entity framework code-first null foreign key
  9. How do you ensure Cascade Delete is enabled on a table relationship in EF Code first?
  10. Ramifications of DbSet.Create versus new Entity()
  11. Entity Framework 4.1 default eager loading
  12. How to pass parameters to the DbContext.Database.ExecuteSqlCommand method?
  13. EF Code First DBContext and Transactions
  14. How to update not every fields of an object using Entity Framework and EntityState.Modified
  15. Entity Framework Code First : Setting up One-To-One foreign key association using Annotations
  16. Entity Framework Validation confusion – maximum string length of ‘128’
  17. Using the Entry().CurrentValues.SetValues() is not updating collections
  18. Entity Framework Code First Many to Many Setup For Existing Tables
  19. Disable lazy loading by default in Entity Framework 4
  20. Best way to check if object exists in Entity Framework? [closed]
  21. How to select top N rows for each group in a Entity Framework GroupBy with EF 3.1
  22. EF5 Code First Enums and Lookup Tables
  23. Entity Framework One-To-One Mapping Issues
  24. How can I delete 1,000 rows with EF6?
  25. Entity Framework 4 selective lazy loading properties
  26. When should I call SaveChanges() when creating 1000’s of Entity Framework objects? (like during an import)
  27. Adding Validation Attributes With an Entity Framework Data Model
  28. Entity Framework : How do you refresh the model when the db changes?
  29. Using EF Core ThenInclude() on Junction tables
  30. Model First with DbContext, Fails to initialize new DataBase

Leave a Comment