Click or drag to resize
IDataQuerySettingsTQuery Interface
Data query parameters interface for a specific query

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public interface IDataQuerySettings<TQuery> : IWhereCondition<TQuery>, 
	IDataQuerySettings, IWhereCondition, IQueryParameters, IQueryObject, IDisposable

Type Parameters

TQuery

The IDataQuerySettingsTQuery type exposes the following members.

Methods
  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
Public methodAddColumns(IEnumerableString)
Adds the additional columns to the query
Public methodAddColumns(String)
Adds the additional columns to the query
Public methodAddColumns(IQueryColumn)
Adds the additional columns to the query
Public methodAnd
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from IWhereConditionTParent.)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from IWhereConditionTParent.)
Public methodAnd(ActionWhereCondition)
Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereConditionTParent.)
Public methodApplyParametersTo
Applies this where condition to the target object
(Inherited from IQueryParameters.)
Public methodCloneObject
Creates the clone of the object.
(Inherited from IQueryObject.)
Public methodColumn(String)
Sets the column to select
Public methodColumn(IQueryColumn)
Sets the column to select
Public methodColumns(IEnumerableString)
Sets the columns to select
Public methodColumns(String)
Sets the columns to select
Public methodColumns(IQueryColumn)
Sets the columns to select
Public methodDistinct
Sets the query to use distinct selection over the given columns
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from IQueryParameters.)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.)
Public methodFirstResult
Sets the query as a single object query
Public methodGroupBy
Specifies the columns to group by
Public methodHaving(IWhereCondition)
Adds the given having conditions to the query.
Public methodHaving(ActionWhereCondition)
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
Public methodHaving(String, Boolean)
Specifies the group by having condition
Public methodChanged
Marks the object as changed
(Inherited from IQueryObject.)
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from IQueryObject.)
Public methodNewGroupBy
Clears the current group by, reverting the source of data to the original. Note, that this method also resets the existing having condition which is closely bound to the group by.
Public methodNewHaving
Clears the current having condition
Public methodNewWhere
Clears the current where condition
(Inherited from IWhereConditionTParent.)
Public methodNextPage
Adjusts the query to a next page, using the current page size. Use in combination with PagedBy and NextPageAvailable to iterate over the data in batches.
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from IWhereConditionTParent.)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
Public methodOr
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from IWhereConditionTParent.)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from IWhereConditionTParent.)
Public methodOr(ActionWhereCondition)
Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereConditionTParent.)
Public methodOrderBy(String)
Adds the columns to the order by query
Public methodOrderBy(OrderDirection, String)
Adds the columns to the order by query
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
Public methodPage
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
Public methodPagedBy
Sets up the query as a paged query with the given page size. Resets the page index to first page. Use in combination with NextPageAvailable and NextPage to iterate over the data in batches.
Public methodReplaceColumn
Replaces the selected column with a new name
Public methodReturnNoResults
Sets the query to return no results. This action is irreversible, once the query is set to return no results it cannot be changed. This method is used by data engine to forbid access to data that are not allowed to be accessed (e.g. license limitations), without notifying the process about the fact.
(Inherited from IWhereCondition.)
Public methodTake
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
Public methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
Public methodTopN
Selects only first top N number of records
Public methodToString
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.)
Public methodWhere(IWhereCondition)
Adds the given where conditions to the query
(Inherited from IWhereConditionTParent.)
Public methodWhere(ActionWhereCondition)
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereConditionTParent.)
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from IWhereConditionTParent.)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from IWhereConditionTParent.)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereConditionTParent.)
Public methodWhereContains
Adds the condition for a string column to contain some substring
(Inherited from IWhereConditionTParent.)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from IWhereConditionTParent.)
Public methodWhereEquals
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereConditionTParent.)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from IWhereConditionTParent.)
Public methodWhereExists
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereFalse
Adds the where condition for a false column value (boolean column equals false).
(Inherited from IWhereConditionTParent.)
Public methodWhereID
Adds the where condition to match the ID to the query. In case the column name is not provided or unknown, does not generate where condition. If given ID is invalid, adds the condition to match NULL.
(Inherited from IWhereConditionTParent.)
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereIn(String, IListInt32)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereLike
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from IWhereConditionTParent.)
Public methodWhereNot
Adds the negation of the given where condition
(Inherited from IWhereConditionTParent.)
Public methodWhereNotContains
Adds the condition for a string column not to contain some substring
(Inherited from IWhereConditionTParent.)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from IWhereConditionTParent.)
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereNotIn(String, IListInt32)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereNotLike
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from IWhereConditionTParent.)
Public methodWhereNotNull
Adds the where condition for a not null column value
(Inherited from IWhereConditionTParent.)
Public methodWhereNotStartsWith
Adds the condition for a string column not to start with some prefix
(Inherited from IWhereConditionTParent.)
Public methodWhereNull
Adds the where condition for a null column value
(Inherited from IWhereConditionTParent.)
Public methodWhereStartsWith
Adds the condition for a string column to start with some prefix
(Inherited from IWhereConditionTParent.)
Public methodWhereTrue
Adds the where condition for a true column value (boolean column equals true).
(Inherited from IWhereConditionTParent.)
Public methodWithComment
Adds the comment to the given query
Top
Properties
  NameDescription
Public propertyDefaultSourceExpression
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.)
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from IDataQuerySettings.)
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from IDataQuerySettings.)
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IDataQuerySettings.)
Public propertyIsNested
Indicates that this query is part of multi query
(Inherited from IDataQuerySettings.)
Public propertyIsSubQuery
If true, the query is a sub-query used in another query
(Inherited from IDataQuerySettings.)
Public propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
(Inherited from IDataQuerySettings.)
Public propertyName
Object name, empty by default
(Inherited from IQueryObject.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from IDataQuerySettings.)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from IDataQuerySettings.)
Public propertyParameters
Query data parameters
(Inherited from IQueryObject.)
Public propertySelectColumns Obsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.)
Public propertySelectColumnsList
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.)
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
(Inherited from IDataQuerySettings.)
Public propertySourceExpression
Source of the query
(Inherited from IDataQuerySettings.)
Public propertyTopNRecords
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.)
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.)
Public propertyWhereIsComplex
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from IWhereCondition.)
Top
See Also