How to load hierarchical structure with recursive with Entity Framework 5

Everything has many way to do it, here is two ways to handle data structure that is recursive. The structure in which the solution that I will present you work is a structure that look like a tree. A main parent node with children in which can have entity or/and have itself a parent node to start a sub-tree. Also, children cannot contain parent that are already used somewhere in the tree, which could raise additional problems, like having infinite recursion.

hiearchicalStructure

In the graphic above, you can see that we have two types of container. One is green and the other one is having a white background. In fact, the green container is a node that can have either children of a specify entity which cannot contain any other structural entity or can contain an other green container which are those who contain a list of children.

So, since we do not know how the tree is structured, it’s not possible to use eager loading as we do normally by including property desired.

_context.Parent
		.Include(d => d.OtherProperty)
		.Include(d => d.Children)
		.Include(d => d.Children.Select(dd=>dd.OtherProperty)
		.Include(d => d.Children.Select(dd=>dd.Children)
		.Include(d => d.Children.Select(dd=>dd.OtherProperty........) //We cannot proceed this way because we do not know how many level
		.Include(d => d.Children.Select(dd=>dd.Children.......)//We cannot proceed this way because we do not know how many level
		.Single(p => p.ID == id);

This give us the option to load the Children, if this one has children then load it the way we just load the parent since every child become a parent. This require recursive method. The problem is that it work but every load will create a new parent. We need to map every values to the first parent to have at the end a single hierarchical tree.

Here is how we can do it with eager loading. We need to every property set back to the object that we have receive to, at the end, have a tree fully loaded.

private Parent RecursiveLoad(Guid id)
{
	var ParentFromDatabase = _context.Parent
		.Include(d => d.Children)
		.Include(d => d.Children.Select(dd => dd.OtherProperty))
		.Single(p => p.ID == id);
	
	foreach (var child in ParentFromDatabase.Children)
	{
		var childNotLoaded = child;
		var childFullyLoaded = _context.Child
			.Include(d => d.Parent)
			.Include(d => d.OtherProperty)
			.Single(d => d.ID == childNotLoaded.ID);

		child.OtherProperty = childFullyLoaded.OtherProperty;		//Require to set back the value because we want by reference to have everything in the tree
		child.Parent = RecursiveLoad(childFullyLoaded.Parent.ID);	//Require to set back the value because we want by reference to have everything in the tree
	}
	return ParentFromDatabase;
}

But, we can do better with explicit loading. One of the positive characteristic of explicit loading is that it load itself. No need to map the loaded object to the existing one, it’s already been loaded into it.

private Parent RecursiveLoad(Parent parent)
{
	var ParentFromDatabase = _context.Entry(parent).Collection(d=>d.Children);//Children are loaded, we can loop them now
	
	foreach (var child in parent.Children)
	{
		_context.Entry(child).Reference(d=>d.OtherProperty).Load();
		RecursiveLoad(child);
	}
	return ParentFromDatabase;
}

This has the advantage to remove every mapping since the object is loaded itself by entity framework. Still, this kind of loading come with a price. If we have 40 leafs in the tree, this mean that every of them will be loaded by the database which result to 40 SQL queries. One approach that can reduce the amount of request is to have the ID (int or Guid) inside the object, from there you can check if this one has a value. This will reduce the amount of call to the database at the amount of parent only (not final leaf which return 0 element). Still, the amount is huge and for large application, a custom solution with a view returning a bunch of data and parsed manually may be a good solution. Nevertheless, if you need to save the tree, you could end up with problem which you do not have when having the whole structure loaded by Entity Framework.

If you like my article, think to buy my annual book, professionally edited by a proofreader. directly from me or on Amazon. I also wrote a TypeScript book called Holistic TypeScript

3 thoughts on “How to load hierarchical structure with recursive with Entity Framework 5

  1. Salut Patrick,

    Laisse moi te proposer une variante générique…

    Merci :o)

    public T LoadRecursive(T item, Expression<Func<T, ICollection>> loadSelector)
    {
        Context.GetDataStore()
                .Entry(item)
                .Collection(loadSelector)
                .Load();
    
        foreach (var child in loadSelector.Compile().Invoke(item))
            LoadRecursive(child, loadSelector);
        return item;
    }
    

Leave a Reply to Patrick Desjardins Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.