Class XPQuery<T>

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

A query that allows the construction of LINQ queries for persistent objects.

public class XPQuery<T> : XPQueryBase, IPersistentValueExtractor, IOrderedQueryable<T>, IOrderedQueryable, IQueryable<T>, IEnumerable<T>, IQueryable, IEnumerable, IQueryProvider

Type Parameters

T

Inheritance

object

XPQueryBase

XPQuery<T>

Implements

IPersistentValueExtractor

IOrderedQueryable<T>

IOrderedQueryable

IQueryable<T>

IEnumerable<T>

IQueryable

IEnumerable

IQueryProvider

Inherited Members

XPQueryBase.SuppressNonPersistentPropertiesCheck

XPQueryBase.Serialize()

XPQueryBase.Call(MethodCallExpression, XPQueryBase)

XPQueryBase.Assign(XPQueryBase)

XPQueryBase.IsNull(object)

XPQueryBase.CanIntersect()

XPQueryBase.Execute(Expression)

XPQueryBase.ExecuteAsync(Expression, CancellationToken)

XPQueryBase.DivePropertyName(Stack<XPClassInfo>, ref string, ref XPClassInfo, bool)

XPQueryBase.Enumerate(Type)

XPQueryBase.Dictionary

XPQueryBase.Session

XPQueryBase.DataLayer

XPQueryBase.ObjectClassInfo

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

XPQueryExtensions.AllAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.AnyAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.AnyAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.AverageAsync<T>(IQueryable<T>, Expression<Func<T, decimal>>, CancellationToken)

XPQueryExtensions.AverageAsync<T>(IQueryable<T>, Expression<Func<T, double>>, CancellationToken)

XPQueryExtensions.AverageAsync<T>(IQueryable<T>, Expression<Func<T, int>>, CancellationToken)

XPQueryExtensions.AverageAsync<T>(IQueryable<T>, Expression<Func<T, long>>, CancellationToken)

XPQueryExtensions.AverageAsync<T>(IQueryable<T>, Expression<Func<T, float>>, CancellationToken)

XPQueryExtensions.CachedExpression<TSource, TResult>(IQueryable<TSource>, Func<IQueryable<TSource>, TResult>)

XPQueryExtensions.CachedExpression<TSource, TArg1, TResult>(IQueryable<TSource>, Func<IQueryable<TSource>, TArg1, TResult>, TArg1)

XPQueryExtensions.CachedExpression<TSource, TArg1, TArg2, TResult>(IQueryable<TSource>, Func<IQueryable<TSource>, TArg1, TArg2, TResult>, TArg1, TArg2)

XPQueryExtensions.CachedExpression<TSource, TArg1, TArg2, TArg3, TResult>(IQueryable<TSource>, Func<IQueryable<TSource>, TArg1, TArg2, TArg3, TResult>, TArg1, TArg2, TArg3)

XPQueryExtensions.CachedExpression<TSource, TArg1, TArg2, TArg3, TArg4, TResult>(IQueryable<TSource>, Func<IQueryable<TSource>, TArg1, TArg2, TArg3, TArg4, TResult>, TArg1, TArg2, TArg3, TArg4)

XPQueryExtensions.CachedExpression<TSource, TArg1, TArg2, TArg3, TArg4, TArg5, TResult>(IQueryable<TSource>, Func<IQueryable<TSource>, TArg1, TArg2, TArg3, TArg4, TArg5, TResult>, TArg1, TArg2, TArg3, TArg4, TArg5)

XPQueryExtensions.ContainsAsync<T>(IQueryable<T>, T, CancellationToken)

XPQueryExtensions.CountAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.CountAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.CustomAggregate<T>(IQueryable<T>, string, params Expression<Func<T, object>>[])

XPQueryExtensions.CustomAggregateAsync<T>(IQueryable<T>, string, Expression<Func<T, object>>, CancellationToken)

XPQueryExtensions.CustomAggregateAsync<T>(IQueryable<T>, string, Expression<Func<T, object>>[], CancellationToken)

XPQueryExtensions.CustomAggregateAsync<T>(IQueryable<T>, string, params Expression<Func<T, object>>[])

XPQueryExtensions.ElementAtAsync<T>(IQueryable<T>, int, CancellationToken)

XPQueryExtensions.ElementAtOrDefaultAsync<T>(IQueryable<T>, int, CancellationToken)

XPQueryExtensions.EnumerateAsync<T>(IQueryable<T>, XPQueryExtensions.AsyncEnumerateCallback)

XPQueryExtensions.EnumerateAsync<T>(IQueryable<T>, XPQueryExtensions.AsyncEnumerateCallback<T>)

XPQueryExtensions.EnumerateAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.FirstAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.FirstAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.FirstOrDefaultAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.FirstOrDefaultAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.LastAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.LastAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.LastOrDefaultAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.LastOrDefaultAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.LongCountAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.LongCountAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.MaxAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.MaxAsync<T, TResult>(IQueryable<T>, Expression<Func<T, TResult>>, CancellationToken)

XPQueryExtensions.MinAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.MinAsync<T, TResult>(IQueryable<T>, Expression<Func<T, TResult>>, CancellationToken)

XPQueryExtensions.SingleAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.SingleAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.SingleOrDefaultAsync<T>(IQueryable<T>, Expression<Func<T, bool>>, CancellationToken)

XPQueryExtensions.SingleOrDefaultAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, decimal>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, double>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, int>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, long>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, decimal?>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, double?>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, int?>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, long?>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, float?>>, CancellationToken)

XPQueryExtensions.SumAsync<T>(IQueryable<T>, Expression<Func<T, float>>, CancellationToken)

XPQueryExtensions.ToArrayAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.ToDictionaryAsync<T, TKey>(IQueryable<T>, Func<T, TKey>, IEqualityComparer<TKey>, CancellationToken)

XPQueryExtensions.ToDictionaryAsync<T, TKey>(IQueryable<T>, Func<T, TKey>, CancellationToken)

XPQueryExtensions.ToDictionaryAsync<T, TKey, TElement>(IQueryable<T>, Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>, CancellationToken)

XPQueryExtensions.ToDictionaryAsync<T, TKey, TElement>(IQueryable<T>, Func<T, TKey>, Func<T, TElement>, CancellationToken)

XPQueryExtensions.ToListAsync<T>(IQueryable<T>, CancellationToken)

XPQueryExtensions.ToLookupAsync<T, TKey>(IQueryable<T>, Func<T, TKey>, IEqualityComparer<TKey>, CancellationToken)

XPQueryExtensions.ToLookupAsync<T, TKey>(IQueryable<T>, Func<T, TKey>, CancellationToken)

XPQueryExtensions.ToLookupAsync<T, TKey, TElement>(IQueryable<T>, Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>, CancellationToken)

XPQueryExtensions.ToLookupAsync<T, TKey, TElement>(IQueryable<T>, Func<T, TKey>, Func<T, TElement>, CancellationToken)

Constructors

XPQuery(IDataLayer)

Initializes a new instance of the XPQuery<T> class with specified settings.

public XPQuery(IDataLayer dataLayer)

Parameters

dataLayer IDataLayer

XPQuery(XPDictionary)

Creates an instance of the XPQuery<T> class with the specified settings.

public XPQuery(XPDictionary dictionary)

Parameters

dictionary XPDictionary

The XPDictionary class descendant’s instance which provides metadata on persistent objects in a data store.

XPQuery(XPDictionary, bool)

Creates an instance of the XPQuery<T> class with specified settings.

public XPQuery(XPDictionary dictionary, bool inTransaction)

Parameters

dictionary XPDictionary

The XPDictionary class descendant’s instance, which provides metadata on persistent objects in a data store.

inTransaction bool

true to enable the InTransaction mode; otherwise, false.

XPQuery(Session)

Creates an instance of the XPQuery<T> class with the specified settings.

public XPQuery(Session session)

Parameters

session Session

The Session class instance which is used to retrieve persistent objects in LINQ queries.

XPQuery(Session, bool)

Creates an instance of the XPQuery<T> class with specified settings.

public XPQuery(Session session, bool inTransaction)

Parameters

session Session

A Session class instance which is used to retrieve persistent objects in LINQ queries.

inTransaction bool

true to enable the InTransaction mode; otherwise, false.

Methods

Clone()

Clones the current query.

public XPQuery<T> Clone()

Returns

XPQuery<T>

An XPQuery<T> object which represents a clone of the current query.

CloneCore()

protected override object CloneCore()

Returns

object

Deserialize(IDataLayer, string)

public static XPQuery<T> Deserialize(IDataLayer dataLayer, string data)

Parameters

dataLayer IDataLayer

data string

Returns

XPQuery<T>

Deserialize(XPDictionary, string)

Creates an instance of the XPQuery<T> class from its string representation.

public static XPQuery<T> Deserialize(XPDictionary dictionary, string data)

Parameters

dictionary XPDictionary

The XPDictionary class descendant’s instance which provides metadata on persistent objects in a data store.

data string

The string representation of the query, obtained via the XPQueryBase.Serialize method.

Returns

XPQuery<T>

An instance of the XPQuery<T> class.

Deserialize(Session, string)

Creates an instance of the XPQuery<T> class from its string representation.

public static XPQuery<T> Deserialize(Session session, string data)

Parameters

session Session

The Session class instance which is used to retrieve persistent objects in LINQ queries.

data string

The string representation of the query, obtained via the XPQueryBase.Serialize method.

Returns

XPQuery<T>

An instance of the XPQuery<T> class.

ExecuteAsync<S>(Expression, CancellationToken)

public Task<S> ExecuteAsync<S>(Expression expression, CancellationToken cancellationToken = default)

Parameters

expression Expression

cancellationToken CancellationToken

Returns

Task<S>

Type Parameters

S

InTransaction()

Creates an InTransaction instance of an XPQuery<T> based on the current XPQuery<T> instance.

public XPQuery<T> InTransaction()

Returns

XPQuery<T>

An InTransaction XPQuery<T> instance created from the current XPQuery<T>, using the corresponding constructor with true passed to the inTransaction parameter.

TransformExpression(XPDictionary, Expression<Func<T, bool>>, CustomCriteriaCollection)

public static CriteriaOperator TransformExpression(XPDictionary dictionary, Expression<Func<T, bool>> expression, CustomCriteriaCollection customCriteriaCollection)

Parameters

dictionary XPDictionary

expression Expression<Func<T, bool>>

customCriteriaCollection CustomCriteriaCollection

Returns

CriteriaOperator

TransformExpression(Session, Expression<Func<T, bool>>)

Converts a lambda expression into an instance of the DevExpress.Data.Filtering.CriteriaOperator class descendant.

public static CriteriaOperator TransformExpression(Session session, Expression<Func<T, bool>> expression)

Parameters

session Session

A Session class instance whose Session.Dictionary and Session.TypesManager are used in the construction of the criteria operator.

expression Expression<Func<T, bool>>

A lambda expression.

Returns

CriteriaOperator

An instance of the CriteriaOperator class descendant that represents the lambda expression.

TransformExpression(Session, Expression<Func<T, bool>>, CustomCriteriaCollection)

Intended for internal use.

public static CriteriaOperator TransformExpression(Session session, Expression<Func<T, bool>> expression, CustomCriteriaCollection customCriteriaCollection)

Parameters

session Session

expression Expression<Func<T, bool>>

customCriteriaCollection CustomCriteriaCollection

Returns

CriteriaOperator

TransformExpression(Expression<Func<T, bool>>)

Converts a lambda expression into an instance of the DevExpress.Data.Filtering.CriteriaOperator class descendant.

public CriteriaOperator TransformExpression(Expression<Func<T, bool>> expression)

Parameters

expression Expression<Func<T, bool>>

A lambda expression.

Returns

CriteriaOperator

An instance of the CriteriaOperator class descendant that represents the lambda expression.

TransformExpression(Expression<Func<T, bool>>, CustomCriteriaCollection)

Intended for internal use.

public CriteriaOperator TransformExpression(Expression<Func<T, bool>> expression, CustomCriteriaCollection customCriteriaCollection)

Parameters

expression Expression<Func<T, bool>>

customCriteriaCollection CustomCriteriaCollection

Returns

CriteriaOperator

WithCustomCriteria(CustomCriteriaCollection)

Intended for internal use.

public XPQuery<T> WithCustomCriteria(CustomCriteriaCollection customCriteriaCollection)

Parameters

customCriteriaCollection CustomCriteriaCollection

Returns

XPQuery<T>

WithCustomCriteria(ICustomCriteriaOperatorQueryable)

Intended for internal use.

public XPQuery<T> WithCustomCriteria(ICustomCriteriaOperatorQueryable customCriteria)

Parameters

customCriteria ICustomCriteriaOperatorQueryable

Returns

XPQuery<T>

WithDeleted()

Creates an XPQuery<T> based on the current XPQuery<T> instance. The new query retrieves objects specified by the original query and also selects objects marked as deleted that match that query.

public XPQuery<T> WithDeleted()

Returns

XPQuery<T>

An XPQuery<T> instance.