IDataQuerySettings<TQuery> Interface

Data query parameters interface for a specific query

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public interface IDataQuerySettings<TQuery> : IWhereCondition<TQuery>, 
	IWhereCondition, IQueryParameters, IQueryObject, IDisposable, IQueryParameters<TQuery>, 
	IDataQuerySettings

Type Parameters

TQuery

The IDataQuerySettings<TQuery> type exposes the following members.

Properties

	Name	Description
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained. (Inherited from IWhereCondition.)
Public property	DefaultQuerySource	Default source of the query in case source is not defined (Inherited from IDataQuerySettings.)
Public property	FilterColumns	List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN" (Inherited from IDataQuerySettings.)
Public property	GroupByColumns	List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner" (Inherited from IDataQuerySettings.)
Public property	HasGroupBy	Returns true if the given query has group by set (Inherited from IDataQuerySettings.)
Public property	HavingCondition	Where condition for the group by on the data, e.g. "DocumentName = 'ABC'" (Inherited from IDataQuerySettings.)
Public property	IsNested	Indicates that this query is nested within another query as its source. This brings certain constraints such as that is cannot use CTE. (Inherited from IDataQuerySettings.)
Public property	IsPagedQuery	Returns true if the query has the paging enabled (Inherited from IDataQuerySettings.)
Public property	IsSubQuery	If true, the query is a sub-query used in another query. This brings certain constraints such as that it cannot use order by or CTE. (Inherited from IDataQuerySettings.)
Public property	MaxRecords	Maximum number of results to return (use for paging together with Offset) (Inherited from IDataQuerySettings.)
Public property	Name	Object name, empty by default (Inherited from IQueryObject.)
Public property	Offset	Index of the first record to return (use for paging together with MaxRecords) (Inherited from IDataQuerySettings.)
Public property	OrderByColumns	List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC" (Inherited from IDataQuerySettings.)
Public property	Parameters	Query data parameters (Inherited from IQueryObject.)
Public property	QuerySource	Source of the query (Inherited from IDataQuerySettings.)
Public property	SelectColumnsList	List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID" (Inherited from IDataQuerySettings.)
Public property	SelectDistinct	If set to true, returns only distinct (different) values. (Inherited from IDataQuerySettings.)
Public property	TopNRecords	If set, selects only first top N number of records (Inherited from IDataQuerySettings.)
Public property	TotalExpression	Total items expression. When defined, used instead default total items for a paged query. (Inherited from IDataQuerySettings.)
Public property	WhereCondition	Where condition on the data, e.g. "DocumentName = 'ABC'" (Inherited from IWhereCondition.)
Public property	WhereIsComplex	Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5" (Inherited from IWhereCondition.)
Public property	WhereIsEmpty	Returns true if the where condition is empty (Inherited from IWhereCondition.)

Methods

	Name	Description
Public method	AddColumn(String)	Adds the additional column to the query
Public method	AddColumn(IQueryColumn)	Adds the additional column to the query
Public method	AddColumns(IEnumerable<String>)	Adds the additional columns to the query
Public method	AddColumns(String[])	Adds the additional columns to the query
Public method	AddColumns(IQueryColumn[])	Adds the additional columns to the query
Public method	And()	Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where... (Inherited from IWhereCondition<TParent>.)
Public method	And(IWhereCondition)	Adds the given where condition with the AND operator (Inherited from IWhereCondition<TParent>.)
Public method	And(Action<WhereCondition>)	Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it. (Inherited from IWhereCondition<TParent>.)
Public method	ApplyParametersTo	Applies this where condition to the target object (Inherited from IQueryParameters.)
Public method	Changed	Marks the object as changed (Inherited from IQueryObject.)
Public method	CloneObject	Creates the clone of the object. (Inherited from IQueryObject.)
Public method	Column(String)	Sets the column to select
Public method	Column(IQueryColumn)	Sets the column to select
Public method	Columns(IEnumerable<String>)	Sets the columns to select
Public method	Columns(String[])	Sets the columns to select
Public method	Columns(IQueryColumn[])	Sets the columns to select
Public method	CopyPropertiesTo	Copies the properties to the target query. (Inherited from IQueryParameters.)
Public method	Distinct	Sets the query to use distinct selection over the given columns
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from IQueryParameters.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from IQueryParameters.)
Public method	GetTypedQuery	Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax. (Inherited from IQueryParameters<TParent>.)
Public method	GroupBy	Specifies the columns to group by
Public method	Having(IWhereCondition[])	Adds the given having conditions to the query.
Public method	Having(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
Public method	Having(String, Boolean)	Specifies the group by having condition
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from IQueryObject.)
Public method	NewGroupBy	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 method	NewHaving	Clears the current having condition
Public method	NewWhere	Clears the current where condition (Inherited from IWhereCondition<TParent>.)
Public method	NextPage	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 method	NoResults	Sets the where condition to exclude all data from result (Inherited from IWhereCondition<TParent>.)
Public method	NotPaged	Sets up the query to become not paged query and output all results at once.
Public method	Or()	Changes the where operator to OR for next where conditions. Use in combination of methods Where... (Inherited from IWhereCondition<TParent>.)
Public method	Or(IWhereCondition)	Adds the given where condition with the OR operator (Inherited from IWhereCondition<TParent>.)
Public method	Or(Action<WhereCondition>)	Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it. (Inherited from IWhereCondition<TParent>.)
Public method	OrderBy(String[])	Adds the columns to the order by query
Public method	OrderBy(OrderDirection, String[])	Adds the columns to the order by query
Public method	OrderByAscending	Adds the columns to the order by query to order by the given columns in ascending order
Public method	OrderByDescending	Adds the columns to the order by query to order by the given columns in descending order
Public method	Page	Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
Public method	PagedBy	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 method	ReplaceColumn	Replaces the selected column with a new name
Public method	ReturnNoResults	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 method	Take	Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
Public method	Then	Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
Public method	TopN	Selects only first top N number of records
Public method	ToString	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from IQueryParameters.)
Public method	Where(IWhereCondition[])	Adds the given where conditions to the query (Inherited from IWhereCondition<TParent>.)
Public method	Where(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it. (Inherited from IWhereCondition<TParent>.)
Public method	Where(String, QueryDataParameters)	Adds the given where condition to the query (Inherited from IWhereCondition<TParent>.)
Public method	Where(String, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator. (Inherited from IWhereCondition<TParent>.)
Public method	Where(String, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from IWhereCondition<TParent>.)
Public method	WhereContains	Adds the condition for a string column to contain some substring (Inherited from IWhereCondition<TParent>.)
Public method	WhereEmpty	Adds the where condition for a null or empty column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereEquals	Adds the given where condition to the query. Matches the column to a given value. (Inherited from IWhereCondition<TParent>.)
Public method	WhereEqualsOrNull	Adds the given where condition to the query. Matches the column to a given value or null value. (Inherited from IWhereCondition<TParent>.)
Public method	WhereExists	Adds where condition with EXISTS and the nested query "EXISTS (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereFalse	Adds the where condition for a false column value (boolean column equals false). (Inherited from IWhereCondition<TParent>.)
Public method	WhereID	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 IWhereCondition<TParent>.)
Public method	WhereIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereLike	Adds the given where condition to the query. Matches the column to a given value using LIKE operator. (Inherited from IWhereCondition<TParent>.)
Public method	WhereNot	Adds the negation of the given where condition (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotContains	Adds the condition for a string column not to contain some substring (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotEmpty	Adds the where condition for a non empty column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotExists	Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName NOT IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotLike	Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator. (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotNull	Adds the where condition for a not null column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotStartsWith	Adds the condition for a string column not to start with some prefix (Inherited from IWhereCondition<TParent>.)
Public method	WhereNull	Adds the where condition for a null column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereStartsWith	Adds the condition for a string column to start with some prefix (Inherited from IWhereCondition<TParent>.)
Public method	WhereTrue	Adds the where condition for a true column value (boolean column equals true). (Inherited from IWhereCondition<TParent>.)
Public method	WithComment	Adds the comment to the given query