Table of Contents

Interface IDataQuery<TQuery>

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Interface for the data query for a specific query type

public interface IDataQuery<TQuery> : IDataQuerySettings<TQuery>, IWhereCondition<TQuery>, IQueryParameters<TQuery>, IDataQuery, IDataQuerySettings, IWhereCondition, IQueryParameters, IQueryObjectWithValue, IQueryObject

Type Parameters

TQuery
Inherited Members
Extension Methods

Methods

BinaryData(bool)

Sets whether the binary data should be included to the result

TQuery BinaryData(bool binary)

Parameters

binary bool

Include binary data?

Returns

TQuery

Except(TQuery)

Gets the intersection of this data query with another query

TQuery Except(TQuery query)

Parameters

query TQuery

Query to intersect with

Returns

TQuery

ExpandColumns()

Expands the columns within this query

TQuery ExpandColumns()

Returns

TQuery

From(QuerySource)

Defines the source of the data (table, view or a nested query)

TQuery From(QuerySource source)

Parameters

source QuerySource

Source

Returns

TQuery

Intersect(TQuery)

Gets the intersection of this data query with another query

TQuery Intersect(TQuery query)

Parameters

query TQuery

Query to intersect with

Returns

TQuery

OrderByDefault()

Sets the default order by for the query

TQuery OrderByDefault()

Returns

TQuery

Source(Action<QuerySource>)

Defines the source of the data (table, view or a nested query)

TQuery Source(Action<QuerySource> sourceParameters)

Parameters

sourceParameters Action<QuerySource>

Source parameters

Returns

TQuery

Union(TQuery, bool)

Gets the union of this data query with another query

TQuery Union(TQuery query, bool unionAll = false)

Parameters

query TQuery

Query to union with

unionAll bool

If true, the union does not eliminate the duplicities (produces UNION ALL)

Returns

TQuery

UnionAll(TQuery)

Gets the union of this data query with another query without eliminating the duplicities

TQuery UnionAll(TQuery query)

Parameters

query TQuery

Query to union with

Returns

TQuery

WhereAnyColumn(QueryOperator, object)

Matches the given condition on any column with the same type as the given value type.

[Obsolete("Use method Where() instead with custom WhereCondition.")]
[ObsoleteSince(27, 0)]
TQuery WhereAnyColumn(QueryOperator op, object value)

Parameters

op QueryOperator

Operator

value object

Value

Returns

TQuery

WhereAnyColumnContains(string)

Adds condition to all items that contain given text in any of the string columns. Performs a SQL substring search on the data.

[Obsolete("Use method Where() instead with custom WhereCondition.")]
[ObsoleteSince(27, 0)]
TQuery WhereAnyColumnContains(string text)

Parameters

text string

Text to search

Returns

TQuery

WithSettings(AbstractQueryObject)

Applies the given parameters to the query

[Obsolete("Use method ApplySettings(AbstractQueryObject parameters) instead.")]
[ObsoleteSince(27, 0)]
TQuery WithSettings(AbstractQueryObject parameters)

Parameters

parameters AbstractQueryObject

Parameters to use

Returns

TQuery

WithSettings(Action<DataQuerySettings>)

Applies the given parameters to the query

[Obsolete("Use method ApplySettings(Action<DataQuerySettings> parameters) instead.")]
[ObsoleteSince(27, 0)]
TQuery WithSettings(Action<DataQuerySettings> parameters)

Parameters

parameters Action<DataQuerySettings>

Parameters to use

Returns

TQuery

WithSource(DataQuerySource)

Sets the given source as the source of the data query

TQuery WithSource(DataQuerySource source)

Parameters

source DataQuerySource

Data query source

Returns

TQuery

WithSource(DataSet)

Sets the given DataSet as the source of the data query

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(99, 9)]
TQuery WithSource(DataSet data)

Parameters

data DataSet

Source data

Returns

TQuery