IIncludableQueryable<TEntity,TProperty> Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Query

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v1.0.6

Package:: Microsoft.EntityFrameworkCore v1.1.6

Package:: Microsoft.EntityFrameworkCore v2.0.3

Package:: Microsoft.EntityFrameworkCore v2.1.11

Package:: Microsoft.EntityFrameworkCore v2.2.6

Package:: Microsoft.EntityFrameworkCore v3.0.0

Package:: Microsoft.EntityFrameworkCore v3.1.0

Package:: Microsoft.EntityFrameworkCore v5.0.0

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore v8.0.0

Package:: Microsoft.EntityFrameworkCore v9.0.0

Source:: IIncludableQueryable.cs

Source:: IIncludableQueryable.cs

Source:: IIncludableQueryable.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Supports queryable Include/ThenInclude chaining operators.

public interface IIncludableQueryable<out TEntity,out TProperty> : System.Collections.Generic.IEnumerable<out TEntity>, System.Linq.IQueryable<out TEntity>

type IIncludableQueryable<'Entity, 'Property> = interface
    interface IQueryable<'Entity>
    interface seq<'Entity>
    interface IEnumerable
    interface IQueryable

Public Interface IIncludableQueryable(Of Out TEntity, Out TProperty)
Implements IEnumerable(Of Out TEntity), IQueryable(Of Out TEntity)

Type Parameters

TEntity

The entity type.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

TProperty

The property type.

Implements: IEnumerable<T> IEnumerable<TEntity> IEnumerable IQueryable IQueryable<TEntity>

Remarks

See Implementation of database providers and extensions and How EF Core queries work for more information and examples.

Extension Methods

ToPageAsync<TSource>(IQueryable<TSource>, Int32, String, Nullable<Int32>, CancellationToken)	Allows paginating through query results by repeatedly executing the same query, passing continuation tokens to retrieve successive pages of the result set, and specifying the maximum number of results per page.
WithPartitionKey<TEntity>(IQueryable<TEntity>, Object, Object, Object)	Specify the partition key for partition used for the query. Required when using a resource token that provides permission based on a partition key for authentication,
WithPartitionKey<TEntity>(IQueryable<TEntity>, Object, Object)	Specify the partition key for partition used for the query. Required when using a resource token that provides permission based on a partition key for authentication,
WithPartitionKey<TEntity>(IQueryable<TEntity>, Object)	Specify the partition key for partition used for the query. Required when using a resource token that provides permission based on a partition key for authentication,
WithPartitionKey<TEntity>(IQueryable<TEntity>, String)	Specify the partition key for partition used for the query. Required when using a resource token that provides permission based on a partition key for authentication,
AllAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously determines whether all the elements of a sequence satisfy a condition.
AnyAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously determines whether any element of a sequence satisfies a condition.
AnyAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously determines whether a sequence contains any elements.
AsAsyncEnumerable<TSource>(IQueryable<TSource>)	Returns an IAsyncEnumerable<T> which can be enumerated asynchronously.
AsNoTracking<TEntity>(IQueryable<TEntity>)	The change tracker will not track any of the entities that are returned from a LINQ query. If the entity instances are modified, this will not be detected by the change tracker and SaveChanges() will not persist those changes to the database.
AsNoTrackingWithIdentityResolution<TEntity>(IQueryable<TEntity>)	The change tracker will not track any of the entities that are returned from a LINQ query. If the entity instances are modified, this will not be detected by the change tracker and SaveChanges() will not persist those changes to the database.
AsTracking<TEntity>(IQueryable<TEntity>, QueryTrackingBehavior)	Returns a new query where the change tracker will either keep track of changes or not for all entities that are returned, depending on the value of the 'track' parameter. When tracking, Any modification to the entity instances will be detected and persisted to the database during SaveChanges(). When not tracking, if the entity instances are modified, this will not be detected by the change tracker and SaveChanges() will not persist those changes to the database.
AsTracking<TEntity>(IQueryable<TEntity>)	Returns a new query where the change tracker will keep track of changes for all entities that are returned. Any modification to the entity instances will be detected and persisted to the database during SaveChanges().
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Decimal>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Double>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Int32>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Int64>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Decimal>>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Double>>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Int32>>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Int64>>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Single>>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
AverageAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Single>>, CancellationToken)	Asynchronously computes the average of a sequence of values that is obtained by invoking a projection function on each element of the input sequence.
ContainsAsync<TSource>(IQueryable<TSource>, TSource, CancellationToken)	Asynchronously determines whether a sequence contains a specified element by using the default equality comparer.
CountAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the number of elements in a sequence that satisfy a condition.
CountAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the number of elements in a sequence.
ElementAtAsync<TSource>(IQueryable<TSource>, Int32, CancellationToken)	Asynchronously returns the element at a specified index in a sequence.
ElementAtOrDefaultAsync<TSource>(IQueryable<TSource>, Int32, CancellationToken)	Asynchronously returns the element at a specified index in a sequence, or a default value if the index is out of range.
ExecuteDelete<TSource>(IQueryable<TSource>)	Deletes all database rows for the entity instances which match the LINQ query from the database.
ExecuteDeleteAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously deletes database rows for the entity instances which match the LINQ query from the database.
ExecuteUpdate<TSource>(IQueryable<TSource>, Expression<Func<SetPropertyCalls<TSource>,SetPropertyCalls<TSource>>>)	Updates all database rows for the entity instances which match the LINQ query from the database.
ExecuteUpdateAsync<TSource>(IQueryable<TSource>, Expression<Func<SetPropertyCalls<TSource>,SetPropertyCalls<TSource>>>, CancellationToken)	Asynchronously updates database rows for the entity instances which match the LINQ query from the database.
FirstAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the first element of a sequence that satisfies a specified condition.
FirstAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the first element of a sequence.
FirstOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the first element of a sequence that satisfies a specified condition or a default value if no such element is found.
FirstOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the first element of a sequence, or a default value if the sequence contains no elements.
ForEachAsync<T>(IQueryable<T>, Action<T>, CancellationToken)	Asynchronously enumerates the query results and performs the specified action on each element.
IgnoreAutoIncludes<TEntity>(IQueryable<TEntity>)	Specifies that the current Entity Framework LINQ query should not have any model-level eager loaded navigations applied.
IgnoreQueryFilters<TEntity>(IQueryable<TEntity>)	Specifies that the current Entity Framework LINQ query should not have any model-level entity query filters applied.
Include<TEntity>(IQueryable<TEntity>, String)	Specifies related entities to include in the query results. The navigation property to be included is specified starting with the type of entity being queried (`TEntity`). Further navigation properties to be included can be appended, separated by the '.' character.
Include<TEntity,TProperty>(IQueryable<TEntity>, Expression<Func<TEntity,TProperty>>)	Specifies related entities to include in the query results. The navigation property to be included is specified starting with the type of entity being queried (`TEntity`). If you wish to include additional types based on the navigation properties of the type being included, then chain a call to ThenInclude<TEntity,TPreviousProperty,TProperty>(IIncludableQueryable<TEntity, IEnumerable<TPreviousProperty>>, Expression<Func<TPreviousProperty, TProperty>>) after this call.
LastAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the last element of a sequence that satisfies a specified condition.
LastAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the last element of a sequence.
LastOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the last element of a sequence that satisfies a specified condition or a default value if no such element is found.
LastOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the last element of a sequence, or a default value if the sequence contains no elements.
Load<TSource>(IQueryable<TSource>)	Enumerates the query. When using Entity Framework, this causes the results of the query to be loaded into the associated context. This is equivalent to calling ToList and then throwing away the list (without the overhead of actually creating the list).
LoadAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously enumerates the query. When using Entity Framework, this causes the results of the query to be loaded into the associated context. This is equivalent to calling ToList and then throwing away the list (without the overhead of actually creating the list).
LongCountAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns a Int64 that represents the number of elements in a sequence that satisfy a condition.
LongCountAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns a Int64 that represents the total number of elements in a sequence.
MaxAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the maximum value of a sequence.
MaxAsync<TSource,TResult>(IQueryable<TSource>, Expression<Func<TSource,TResult>>, CancellationToken)	Asynchronously invokes a projection function on each element of a sequence and returns the maximum resulting value.
MinAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the minimum value of a sequence.
MinAsync<TSource,TResult>(IQueryable<TSource>, Expression<Func<TSource,TResult>>, CancellationToken)	Asynchronously invokes a projection function on each element of a sequence and returns the minimum resulting value.
SingleAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists.
SingleAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the only element of a sequence, and throws an exception if there is not exactly one element in the sequence.
SingleOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, CancellationToken)	Asynchronously returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.
SingleOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Decimal>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Double>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Int32>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Int64>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Decimal>>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Double>>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Int32>>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Int64>>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Nullable<Single>>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
SumAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource,Single>>, CancellationToken)	Asynchronously computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence.
TagWith<T>(IQueryable<T>, String)	Adds a tag to the collection of tags associated with an EF LINQ query. Tags are query annotations that can provide contextual tracing information at different points in the query pipeline.
TagWithCallSite<T>(IQueryable<T>, String, Int32)	Adds a tag to the collection of tags associated with an EF LINQ query with source file name and line where method was called that can provide contextual tracing information at different points in the query pipeline.
ThenInclude<TEntity,TPreviousProperty,TProperty>(IIncludableQueryable<TEntity,TPreviousProperty>, Expression<Func<TPreviousProperty,TProperty>>)	Specifies additional related data to be further included based on a related type that was just included.
ToArrayAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously creates an array from an IQueryable<T> by enumerating it asynchronously.
ToDictionaryAsync<TSource,TKey>(IQueryable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>, CancellationToken)	Creates a Dictionary<TKey,TValue> from an IQueryable<T> by enumerating it asynchronously according to a specified key selector function and a comparer.
ToDictionaryAsync<TSource,TKey>(IQueryable<TSource>, Func<TSource,TKey>, CancellationToken)	Creates a Dictionary<TKey,TValue> from an IQueryable<T> by enumerating it asynchronously according to a specified key selector function.
ToDictionaryAsync<TSource,TKey,TElement>(IQueryable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>, CancellationToken)	Creates a Dictionary<TKey,TValue> from an IQueryable<T> by enumerating it asynchronously according to a specified key selector function, a comparer, and an element selector function.
ToDictionaryAsync<TSource,TKey,TElement>(IQueryable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, CancellationToken)	Creates a Dictionary<TKey,TValue> from an IQueryable<T> by enumerating it asynchronously according to a specified key selector and an element selector function.
ToHashSetAsync<TSource>(IQueryable<TSource>, IEqualityComparer<TSource>, CancellationToken)	Asynchronously creates a HashSet<T> from an IQueryable<T> by enumerating it asynchronously.
ToHashSetAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously creates a HashSet<T> from an IQueryable<T> by enumerating it asynchronously.
ToListAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously creates a List<T> from an IQueryable<T> by enumerating it asynchronously.
AsSingleQuery<TEntity>(IQueryable<TEntity>)	Returns a new query which is configured to load the collections in the query results in a single database query.
AsSplitQuery<TEntity>(IQueryable<TEntity>)	Returns a new query which is configured to load the collections in the query results through separate database queries.
ExecuteDelete<TSource>(IQueryable<TSource>)	Deletes all database rows for the entity instances which match the LINQ query from the database.
ExecuteDeleteAsync<TSource>(IQueryable<TSource>, CancellationToken)	Asynchronously deletes database rows for the entity instances which match the LINQ query from the database.
ExecuteUpdate<TSource>(IQueryable<TSource>, Expression<Func<SetPropertyCalls<TSource>,SetPropertyCalls<TSource>>>)	Updates all database rows for the entity instances which match the LINQ query from the database.
ExecuteUpdateAsync<TSource>(IQueryable<TSource>, Expression<Func<SetPropertyCalls<TSource>,SetPropertyCalls<TSource>>>, CancellationToken)	Asynchronously updates database rows for the entity instances which match the LINQ query from the database.
FromSql<TEntity>(IQueryable<TEntity>, RawSqlString, Object[])	Obsolete. Creates a LINQ query based on a raw SQL query. If the database provider supports composing on the supplied SQL, you can compose on top of the raw SQL query using LINQ operators - `context.Blogs.FromSql("SELECT * FROM dbo.Blogs").OrderBy(b => b.Name)`. As with any API that accepts SQL it is important to parameterize any user input to protect against a SQL injection attack. You can include parameter place holders in the SQL query string and then supply parameter values as additional arguments. Any parameter values you supply will automatically be converted to a DbParameter - `context.Blogs.FromSql("SELECT * FROM [dbo].[SearchBlogs]({0})", userSuppliedSearchTerm)`. This overload also accepts DbParameter instances as parameter values. This allows you to use named parameters in the SQL query string - `context.Blogs.FromSql("SELECT * FROM [dbo].[SearchBlogs]({@searchTerm})", new SqlParameter("@searchTerm", userSuppliedSearchTerm))`
FromSql<TEntity>(IQueryable<TEntity>, FormattableString)	Obsolete. Creates a LINQ query based on an interpolated string representing a SQL query. If the database provider supports composing on the supplied SQL, you can compose on top of the raw SQL query using LINQ operators - `context.Blogs.FromSql("SELECT * FROM dbo.Blogs").OrderBy(b => b.Name)`. As with any API that accepts SQL it is important to parameterize any user input to protect against a SQL injection attack. You can include interpolated parameter place holders in the SQL query string. Any interpolated parameter values you supply will automatically be converted to a DbParameter - `context.Blogs.FromSql($"SELECT * FROM [dbo].[SearchBlogs]({userSuppliedSearchTerm})")`.
FromSql<TEntity>(IQueryable<TEntity>, String, Object[])	Creates a LINQ query based on a raw SQL query. If the database provider supports composing on the supplied SQL, you can compose on top of the raw SQL query using LINQ operators - `context.Blogs.FromSql("SELECT * FROM dbo.Blogs").OrderBy(b => b.Name)`. As with any API that accepts SQL it is important to parameterize any user input to protect against a SQL injection attack. You can include parameter place holders in the SQL query string and then supply parameter values as additional arguments. Any parameter values you supply will automatically be converted to a DbParameter - `context.Blogs.FromSql("SELECT * FROM [dbo].[SearchBlogs]({0})", userSuppliedSearchTerm)`. You can also construct a DbParameter and supply it to as a parameter value. This allows you to use named parameters in the SQL query string - `context.Blogs.FromSql("SELECT * FROM [dbo].[SearchBlogs]({@searchTerm})", new SqlParameter("@searchTerm", userSuppliedSearchTerm))`

Applies to

Share via