Entity Framework Core and LINQ to Entities in Depth (6) Query Data Loading
[LINQ via C# series]
[Entity Framework Core (EF Core) series]
[Entity Framework (EF) series]
After translated to SQL, in LINQ to Entities, sequence queries returning IQueryable<T> implements deferred execution too.
Deferred execution
As previous part discussed, when defining a LINQ to Entities query represented by IQueryable<T>, an expression tree is built, there is no query execution. The execution is deferred until trying to pull the results from the query.
Iterator pattern
IQueryable<T> implements IEnumerable<T>, so values can be pulled from IQueryable<T> with the standard iterator pattern. When trying to pull the first value, EF Core translates LINQ to Entities query to SQL, and execute SQL in the database. The implementation can be demonstrated with the Iterator<T> type from the LINQ to Objects chapter:
public static IEnumerator<TEntity> GetEntityIterator<TEntity>(
this IQueryable<TEntity> query, DbContext dbContext) where TEntity : class
{
"| |_Compile LINQ expression tree to database expression tree.".WriteLine();
(SelectExpression DatabaseExpression, IReadOnlyDictionary<string, object> Parameters) compilation = dbContext.Compile(query.Expression);
IEnumerator<TEntity> entityIterator = null;
return new Iterator<TEntity>(
start: () =>
{
"| |_Generate SQL from database expression tree.".WriteLine();
IRelationalCommand sql = dbContext.Generate(compilation.DatabaseExpression);
IEnumerable<TEntity> sqlQuery = dbContext.Set<TEntity>().FromRawSql(
sql: sql.CommandText,
parameters: compilation.Parameters
.Select(parameter => new SqlParameter(parameter.Key, parameter.Value)).ToArray());
entityIterator = sqlQuery.GetEnumerator();
"| |_Execute generated SQL.".WriteLine();
},
moveNext: () => entityIterator.MoveNext(),
getCurrent: () =>
{
$"| |_Materialize data row to {typeof(TEntity).Name} entity.".WriteLine();
return entityIterator.Current;
},
dispose: () => entityIterator.Dispose(),
end: () => " |_End.".WriteLine()).Start();
}
The following example executes Where and Take query to load 3 products with more than 10 characters in name. It demonstrates how to pull the results from IQueryable<T> with the iterator pattern:
internal static void DeferredExecution(AdventureWorks adventureWorks)
{
IQueryable<Product> categories = adventureWorks.Products
.Where(product => product.Name.Length > 100)
.Take(3);
"Iterator - Create from LINQ to Entities query.".WriteLine();
using (IEnumerator<Product> iterator = categories.GetEntityIterator(adventureWorks)) // Compile query.
{
int index = 0;
while (new Func<bool>(() =>
{
bool moveNext = iterator.MoveNext();
$"|_Iterator - [{index++}] {nameof(IEnumerator<Product>.MoveNext)}: {moveNext}.".WriteLine();
return moveNext; // Generate SQL when first time called.
})())
{
Product product = iterator.Current;
$"| |_Iterator - [{index}] {nameof(IEnumerator<Product>.Current)}: {product.Name}.".WriteLine();
}
}
// Iterator - Create from LINQ to Entities query.
// | |_Compile LINQ expression tree to database expression tree.
// |_Iterator - [0] MoveNext: True.
// | |_Generate SQL from database expression tree.
// | |_Execute generated SQL.
// | |_Materialize data row to Product entity.
// | |_Iterator - [0] Current: ML Crankset.
// |_Iterator - [1] MoveNext: True.
// | |_Materialize data row to Product entity.
// | |_Iterator - [1] Current: HL Crankset.
// |_Iterator - [2] MoveNext: True.
// | |_Materialize data row to Product entity.
// | |_Iterator - [2] Current: Touring-2000 Blue, 60.
// |_Iterator - [3] MoveNext: False.
// |_End.
}
Here for demonstration purpose, the GetEntityIterator extension method of IQueryable<T> is called instead of GetEnumerator. In EF Core, when the iterator is created from IQueryable<T>, the LINQ query expression tree is compiled to database query expression tree. Later, when the iterator’s MoveNext method is called for the first time, the SQL query is generated and executed. In each iteration, an entity is materialized from the SQL execution result.
Lazy evaluation vs. eager evaluation
Deferred execution can be either lazy evaluation or eager evaluation. Internally, EF Core call ADP.NET APIs to execute query, including DbDataReader, etc. DbDataReader is abstract class. EF Core SQL database provider actually uses SqlDataReader in ADO.NET, which is derived from DbDataReader, to load the database query results. By default, when SqlDataReader starts to read data, it streams a number of rows to local buffer through TDS (tabular data stream) protocol. So by default, LINQ to Entities’ deferred execution is neither eager (load all rows when pulling the first result), nor totally lazy (load 1 result when pulling each result).
When retry logic is specified for connection resiliency, EF Core become eager evaluation. When trying to pull the first query result, EF Core call DbDataReader to load all results from database.
Explicit loading
After an entity is queried, its related entities can be loaded through the navigation property. DbContext.Entry method accepts an entity of type TEntity, and returns Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry<TEntity>, which represents that entity’s tracking and loading information. EntityEntry<TEntity> provides a Reference method to return Microsoft.EntityFrameworkCore.ChangeTracking.ReferenceEntry<TEntity, TProperty> instance, which represents the tracking and loading information of a single related entity from reference navigation property. EntityEntry<TEntity> also provides a Collection method to return Microsoft.EntityFrameworkCore.ChangeTracking.ReferenceEntry.CollectionEntry<TEntity, TProperty>, which represents the tracking and loading information of multiple related entities from collection navigation property. These related entities in the navigation properties can be manually loaded by calling ReferenceEntry<TEntity, TProperty>.Load and CollectionEntry<TEntity, TProperty>.Load:
internal static void ExplicitLoading(AdventureWorks adventureWorks)
{
ProductSubcategory subcategory = adventureWorks.ProductSubcategories.First(); // Execute query.
// SELECT TOP(1) [p].[ProductSubcategoryID], [p].[Name], [p].[ProductCategoryID]
// FROM [Production].[ProductSubcategory] AS [p]
subcategory.Name.WriteLine();
adventureWorks
.Entry(subcategory) // Return EntityEntry<ProductSubcategory>.
.Reference(entity => entity.ProductCategory) // Return ReferenceEntry<ProductSubcategory, ProductCategory>.
.Load(); // Execute query.
// exec sp_executesql N'SELECT [e].[ProductCategoryID], [e].[Name]
// FROM [Production].[ProductCategory] AS [e]
// WHERE [e].[ProductCategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
subcategory.ProductCategory.Name.WriteLine();
adventureWorks
.Entry(subcategory) // Return EntityEntry<ProductSubcategory>.
.Collection(entity => entity.Products) // Return CollectionEntry<ProductSubcategory, Product>.
.Load(); // Execute query.
// exec sp_executesql N'SELECT [e].[ProductID], [e].[ListPrice], [e].[Name], [e].[ProductSubcategoryID]
// FROM [Production].[Product] AS [e]
// WHERE [e].[ProductSubcategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
subcategory.Products.WriteLines(product => product.Name);
}
When the Load method is called, the related entities are queried, and become available through the navigation properties. Besides loading the full entities, explicit lazy loading also support custom query. The following example uses the reference navigation property and collection navigation property as LINQ to Entities data sources, by calling ReferenceEntry<TEntity, TProperty>.Query and CollectionEntry<TEntity, TProperty>.Query:
internal static void ExplicitLoadingWithQuery(AdventureWorks adventureWorks)
{
ProductSubcategory subcategory = adventureWorks.ProductSubcategories.First(); // Execute query.
// SELECT TOP(1) [p].[ProductSubcategoryID], [p].[Name], [p].[ProductCategoryID]
// FROM [Production].[ProductSubcategory] AS [p]
subcategory.Name.WriteLine();
string categoryName = adventureWorks
.Entry(subcategory).Reference(entity => entity.ProductCategory)
.Query() // Return IQueryable<ProductCategory>.
.Select(category => category.Name).Single(); // Execute query.
// exec sp_executesql N'SELECT TOP(2) [e].[Name]
// FROM [Production].[ProductCategory] AS [e]
// WHERE [e].[ProductCategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
categoryName.WriteLine();
IQueryable<string>products = adventureWorks
.Entry(subcategory).Collection(entity => entity.Products)
.Query() // Return IQueryable<Product>.
.Select(product => product.Name); // Execute query.
// exec sp_executesql N'SELECT [e].[Name]
// FROM [Production].[Product] AS [e]
// WHERE [e].[ProductSubcategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
products.WriteLines();
}
Eager loading
In explicit loading, after an entity is queried, its related entities are loaded separately. In eager loading, when an entity is queried, its related entities are loaded during the same query. To enable eager loading, call Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions’ Include method, which is an extension method for IQueryable<T>:
internal static void EagerLoadingWithInclude(AdventureWorks adventureWorks)
{
IQueryable<ProductSubcategory> subcategoriesWithCategory = adventureWorks.ProductSubcategories
.Include(subcategory => subcategory.ProductCategory);
subcategoriesWithCategory.WriteLines(subcategory =>
$"{subcategory.ProductCategory.Name}: {subcategory.Name}");
// SELECT [subcategory].[ProductSubcategoryID], [subcategory].[Name], [subcategory].[ProductCategoryID], [p].[ProductCategoryID], [p].[Name]
// FROM [Production].[ProductSubcategory] AS [subcategory]
// INNER JOIN [Production].[ProductCategory] AS [p] ON [subcategory].[ProductCategoryID] = [p].[ProductCategoryID]
IQueryable<ProductSubcategory> subcategoriesWithProducts = adventureWorks.ProductSubcategories
.Include(subcategory => subcategory.Products);
subcategoriesWithProducts.WriteLines(subcategory => $@"{subcategory.Name}: {string.Join(
", ", subcategory.Products.Select(product => product.Name))}");
// SELECT [subcategory].[ProductSubcategoryID], [subcategory].[Name], [subcategory].[ProductCategoryID]
// FROM [Production].[ProductSubcategory] AS [subcategory]
// ORDER BY [subcategory].[ProductSubcategoryID]
// SELECT [p].[ProductID], [p].[ListPrice], [p].[Name], [p].[ProductSubcategoryID], [p].[RowVersion]
// FROM [Production].[Product] AS [p]
// WHERE EXISTS (
// SELECT 1
// FROM [Production].[ProductSubcategory] AS [subcategory]
// WHERE [p].[ProductSubcategoryID] = [subcategory].[ProductSubcategoryID])
// ORDER BY [p].[ProductSubcategoryID]
}
Eager loading related entity through reference navigation property is translated to INNER JOIN. Eager loading through collection navigation property is translated to 2 SQL queries for 2 types of entities. More queries can be chained after calling Include.
In EF Core, ThenInclude can be called for eager loading of multiple levels of related entities:
internal static void EagerLoadingMultipleLevels(AdventureWorks adventureWorks)
{
IQueryable<Product>products = adventureWorks.Products
.Include(product => product.ProductProductPhotos)
.ThenInclude(productProductPhoto => productProductPhoto.ProductPhoto);
products.WriteLines(product => $@"{product.Name}: {string.Join(
", ",
product.ProductProductPhotos.Select(productProductPhoto =>
productProductPhoto.ProductPhoto.LargePhotoFileName))}");
// SELECT [product].[ProductID], [product].[ListPrice], [product].[Name], [product].[ProductSubcategoryID], [product].[RowVersion]
// FROM [Production].[Product] AS [product]
// ORDER BY [product].[ProductID]
// SELECT [p].[ProductID], [p].[ProductPhotoID], [p0].[ProductPhotoID], [p0].[LargePhotoFileName], [p0].[ModifiedDate]
// FROM [Production].[ProductProductPhoto] AS [p]
// INNER JOIN [Production].[ProductPhoto] AS [p0] ON [p].[ProductPhotoID] = [p0].[ProductPhotoID]
// WHERE EXISTS (
// SELECT 1
// FROM [Production].[Product] AS [product]
// WHERE [p].[ProductID] = [product].[ProductID])
// ORDER BY [p].[ProductID]
}
Lazy loading
EF Core also supports lazy loading.
public partial class AdventureWorks
{
public AdventureWorks(DbConnection connection = null, bool lazyLoading = true)
: base(GetDbContextOptions(connection, lazyLoading))
{
}
private static DbContextOptions GetDbContextOptions(
DbConnection connection = null, bool lazyLoading = true) =>
new DbContextOptionsBuilder<AdventureWorks>()
.UseLazyLoadingProxies(lazyLoading)
.UseSqlServer(
connection: connection ??
new SqlConnection(ConnectionStrings.AdventureWorks),
sqlServerOptionsAction: options => options.EnableRetryOnFailure(
maxRetryCount: 5, maxRetryDelay: TimeSpan.FromSeconds(30),
errorNumbersToAdd: null))
.Options;
}
When an entity’s navigation property is accessed, the related entities are queried and loaded automatically:
internal static void LazyLoading(AdventureWorks adventureWorks)
{
ProductSubcategory subcategory = adventureWorks.ProductSubcategories.First(); // Execute query.
// SELECT TOP(1) [p].[ProductSubcategoryID], [p].[Name], [p].[ProductCategoryID]
// FROM [Production].[ProductSubcategory] AS [p]
subcategory.Name.WriteLine();
ProductCategory category = subcategory.ProductCategory; // Execute query.
// exec sp_executesql N'SELECT [e].[ProductCategoryID], [e].[Name]
// FROM [Production].[ProductCategory] AS [e]
// WHERE [e].[ProductCategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
category.Name.WriteLine();
ICollection<Product> products = subcategory.Products; // Execute query.
// exec sp_executesql N'SELECT [e].[ProductID], [e].[ListPrice], [e].[Name], [e].[ProductSubcategoryID], [e].[RowVersion]
// FROM [Production].[Product] AS [e]
// WHERE [e].[ProductSubcategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
products.WriteLines(product => product.Name);
}
The N + 1 problem
internal static void MultipleLazyLoading(AdventureWorks adventureWorks)
{
ProductSubcategory[] subcategories = adventureWorks.ProductSubcategories.ToArray(); // Execute query.
// SELECT [p].[ProductSubcategoryID], [p].[Name], [p].[ProductCategoryID]
// FROM [Production].[ProductSubcategory] AS [p]
subcategories.WriteLines(subcategory =>
$"{subcategory.Name} ({subcategory.ProductCategory.Name})"); // Execute query.
// exec sp_executesql N'SELECT [e].[ProductCategoryID], [e].[Name]
// FROM [Production].[ProductCategory] AS [e]
// WHERE [e].[ProductCategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=1
// exec sp_executesql N'SELECT [e].[ProductCategoryID], [e].[Name]
// FROM [Production].[ProductCategory] AS [e]
// WHERE [e].[ProductCategoryID] = @__get_Item_0',N'@__get_Item_0 int',@__get_Item_0=2
// ...
}
When loading the subcategories, 1 database query is executed. When each subcategory’s related category is pulled through the navigation property, it is loaded instantly, if not loaded yet. So in total there are N queries for related categories + 1 query for subcategories executed. For better performance in this kind of scenario, eager loading or inner join should be used to load all entities and related entities with 1 single query.
Disable lazy loading
There are some scenarios where lazy loading needs to be disabled, like entity serialization. There are several ways to disable lazy loading for different scopes
· To globally disable lazy loading for specific navigation properties, just do not mark it as virtual, so that the derived proxy entity cannot override it with the lazy load implementation.
· To disable lazy loading for specific DbContext or specific query, call DbContext.Configuration to get a DbConfiguration instance, and set its LazyLoadingEnabled property to false.
internal static void DisableLazyLoading()
{
using (AdventureWorks adventureWorks = new AdventureWorks(lazyLoading: false))
{
ProductSubcategory subcategory = adventureWorks.ProductSubcategories.First(); // Execute query.
subcategory.Name.WriteLine();
ProductCategory category = subcategory.ProductCategory; // No query.
(category == null).WriteLine(); // True
ICollection<Product> products = subcategory.Products; // No query.
(products == null).WriteLine(); // True
}
}