DataQuerySettingsBase<TQuery> Class

Defines parameters for the data selection

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractQueryObject
    CMS.DataEngine.QueryParametersBase<TQuery>
      CMS.DataEngine.WhereConditionBase<TQuery>
        CMS.DataEngine.DataQuerySettingsBase<TQuery>
          CMS.DataEngine.DataQueryBase<TQuery>
          CMS.DataEngine.DataQuerySettings

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

Syntax

public abstract class DataQuerySettingsBase<TQuery> : WhereConditionBase<TQuery>, 
	IDataQuerySettings<TQuery>, IWhereCondition<TQuery>, IWhereCondition, IQueryParameters, 
	IQueryObject, IQueryParameters<TQuery>, IDataQuerySettings
where TQuery : new(), DataQuerySettingsBase<TQuery>

Type Parameters

TQuery

The DataQuerySettingsBase<TQuery> type exposes the following members.

Constructors

	Name	Description
Protected method	DataQuerySettingsBase<TQuery>

Fields

	Name	Description
Protected field	mMaxRecords	Maximum number of records to select
Protected field	mOffset	Offset
Protected field	mOrderByColumns	Order by columns
Protected field	mParameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)
Protected field	mSelectColumnsList	Columns to select

Properties

	Name	Description
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained. (Inherited from WhereConditionBase<TParent>.)
Public property	DefaultQuerySource	Default source of the query in case source is not defined
Public property	FilterColumns	List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
Protected property	ForceOrderBy	If true, the order by should be forced in the process of execution
Public property	GroupByColumns	List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
Public property	HasGroupBy	Returns true if the given query has group by set
Public property	HavingCondition	Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
Public property	HavingIsComplex	Returns true if the given having condition is a complex condition
Public property	HavingIsEmpty	Returns true if the having condition is empty
Protected property	IsImmutable	If true, this object instance is immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
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.
Public property	IsPagedQuery	Returns true if the query has the paging enabled
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.
Public property	MaxRecords	Maximum number of results to return (use for paging together with Offset)
Public property	Name	Object name, empty by default (Inherited from AbstractQueryObject.)
Public property	Offset	Index of the first record to return (use for paging together with MaxRecords)
Public property	OrderByColumns	List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
Public property	Parameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)
Public property	QuerySource	Query source object
Public property	ReturnsNoResults	Returns true if query doesn't return any results (Inherited from WhereConditionBase<TParent>.)
Public property	SelectColumnsList	List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
Public property	SelectDistinct	If set to true, returns only distinct (different) values.
Public property	TopNRecords	If set, selects only first top N number of records
Public property	TotalExpression	Total items expression. When defined, used instead default total items for a paged query.
Protected property	WhereBuilder	Where condition builder (Inherited from WhereConditionBase<TParent>.)
Public property	WhereCondition	Where condition on the data, e.g. "DocumentName = 'ABC'" (Inherited from WhereConditionBase<TParent>.)
Public property	WhereIsComplex	Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5" (Inherited from WhereConditionBase<TParent>.)
Public property	WhereIsEmpty	Returns true if the where condition is empty (Inherited from WhereConditionBase<TParent>.)
Protected property	WhereOperator	Operator used for adding where condition. Default is AND (Inherited from WhereConditionBase<TParent>.)

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	AddFilterColumn	Adds the additional filter column to the query
Protected method	AddHavingInternal	Adds the given having condition
Protected method	AddWhereCondition	Adds the given where condition to the final where condition (Inherited from WhereConditionBase<TParent>.)
Protected method	AddWhereConditionInternal	Adds the given where condition (Inherited from WhereConditionBase<TParent>.)
Public method	And()	Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where... (Inherited from WhereConditionBase<TParent>.)
Public method	And(IWhereCondition)	Adds the given where condition with the AND operator (Inherited from WhereConditionBase<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 WhereConditionBase<TParent>.)
Protected method	AnySettingsDefined	Returns true if the object has any settings defined that influence the resulting query (Overrides WhereConditionBase<TParent>.AnySettingsDefined().)
Public method	ApplyParametersTo	Applies this query parameters to the target object (Overrides WhereConditionBase<TParent>.ApplyParametersTo(IQueryObject).)
Public method	Changed	Marks the object as changed (Inherited from AbstractQueryObject.)
Protected method	CheckReturnsNoResults	Checks if where condition results in no data (Inherited from WhereConditionBase<TParent>.)
Public method	Clone	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	CloneObject	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
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	Creates the clone of the collection. (Overrides WhereConditionBase<TParent>.CopyPropertiesTo(IQueryObject).)
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 QueryParametersBase<TParent>.)
Public method	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from WhereConditionBase<TParent>.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from QueryParametersBase<TParent>.)
Protected method	GetDataSourceName	Gets data source identifier that represents the location from which the data are obtained. (Inherited from WhereConditionBase<TParent>.)
Protected method	GetDefaultSource	Gets the default source for this query
Public method	GetExpressions	Gets the query expressions
Public method	GetHashCode	Serves as a hash function for a particular type. (Inherited from WhereConditionBase<TParent>.)
Public method	GetTypedQuery	Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax. If current Query is immutable then its clone is returned. (Inherited from QueryParametersBase<TParent>.)
Protected method	GetWhere(String, QueryOperator, Object)	Gets the where condition for the given column (Inherited from WhereConditionBase<TParent>.)
Protected method	GetWhere(IQueryObjectWithValue, QueryOperator, Object)	Gets the where condition for the given column (Inherited from WhereConditionBase<TParent>.)
Public method	GroupBy	Specifies the columns to group by
Public method	HasCompatibleSource	Returns true if the given query is an external source (Inherited from WhereConditionBase<TParent>.)
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 having condition
Public method	Immutable	Makes this object instance immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from QueryParametersBase<TParent>.)
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 WhereConditionBase<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.
Protected method	NoColumns	Sets the query to return no columns at all
Public method	NoResults	Sets the where condition to exclude all data from result (Inherited from WhereConditionBase<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 WhereConditionBase<TParent>.)
Public method	Or(IWhereCondition)	Adds the given where condition with the OR operator (Inherited from WhereConditionBase<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 WhereConditionBase<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
Protected method	ReplaceOrderByColumn	Replaces the selected column with a new name
Protected method	ReplaceSelectedColumn	Replaces the selected column with a new name
Public method	Reset	Flushes the results but leaves the generated query text unchanged. After the reset, query can be executed again to obtain new data. (Inherited from AbstractQueryObject.)
Protected method	ResetWhereOperator	Resets the where operator to the default value (Inherited from WhereConditionBase<TParent>.)
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 WhereConditionBase<TParent>.)
Public method	Snapshot	Obsolete. Creates an immutable snapshot of the current query as a base for further evaluation. Doesn't modify the original query in any way. (Inherited from QueryParametersBase<TParent>.)
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 (Inherited from QueryParametersBase<TParent>.)
Public method	ToString(Boolean)	Returns the string representation of the expression, with possibility of expanding parameters (Overrides WhereConditionBase<TParent>.ToString(Boolean).)
Public method	Where(IWhereCondition[])	Adds the given where conditions to the query (Inherited from WhereConditionBase<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 WhereConditionBase<TParent>.)
Public method	Where(String, QueryDataParameters)	Adds the given where condition to the query (Inherited from WhereConditionBase<TParent>.)
Public method	Where(String, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(IQueryObjectWithValue, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(String, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(IQueryObjectWithValue, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereContains(String, String)	Adds the condition for a string column to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereContains(IQueryObjectWithValue, String)	Adds the condition for a string column to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEmpty	Adds the where condition for a null or empty column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEndsWith(String, String)	Adds the condition for a string column to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEndsWith(IQueryObjectWithValue, String)	Adds the condition for a string expression to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEquals(String, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side to the given right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEqualsOrNull	Adds the given where condition to the query. Matches the column to a given value or null value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereExists(IDataQuery)	Adds where condition with EXISTS and the nested query "EXISTS (...)" (Inherited from WhereConditionBase<TParent>.)
Protected method	WhereExists(IDataQuery, Boolean)	Adds where condition with EXISTS and the nested query "EXISTS (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereFalse(String)	Adds the where condition for a false column value (boolean column equals false). (Inherited from WhereConditionBase<TParent>.)
Public method	WhereFalse(IQueryObjectWithValue)	Adds the where condition for a false expression value (boolean expression equals false). (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterOrEquals(String, Object)	Adds the given where condition to the query. Matches the left side which is greater or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterOrEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is greater or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterThan(String, Object)	Adds the given where condition to the query. Matches the left side which is greater than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterThan(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is greater than the right side. (Inherited from WhereConditionBase<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 WhereConditionBase<TParent>.)
Public method	WhereIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Protected method	WhereIn(String, IDataQuery, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)". Supported generic type is int, long, string or guid ONLY! (Inherited from WhereConditionBase<TParent>.)
Protected method	WhereIn(String, ICollection<Int32>, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessOrEquals(String, Object)	Adds the given where condition to the query. Matches the left side which is less or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessOrEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is less or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessThan(String, Object)	Adds the given where condition to the query. Matches the left side which is less than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessThan(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is less than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLike(String, String)	Adds the given where condition to the query. Matches the column to a given value using LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLike(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side and right side using LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNot	Adds the negation of the given where condition (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotContains(String, String)	Adds the condition for a string column not to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotContains(IQueryObjectWithValue, String)	Adds the condition for a string column not to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEmpty	Adds the where condition for a non empty column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEndsWith(String, String)	Adds the condition for a string column not to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEndsWith(IQueryObjectWithValue, String)	Adds the condition for a string column not to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEquals(String, Object)	Adds the given where condition to the query. Matches the column which is not equal to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is not equal to the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotExists	Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName NOT IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotLike(String, String)	Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotLike(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotNull(String)	Adds the where condition for a not null column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotNull(IQueryObjectWithValue)	Adds the where condition for a not null expression value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotStartsWith(String, String)	Adds the condition for a string column not to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotStartsWith(IQueryObjectWithValue, String)	Adds the condition for a string column not to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNull(String)	Adds the where condition for a null column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNull(IQueryObjectWithValue)	Adds the where condition for a null expression value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereStartsWith(String, String)	Adds the condition for a string column to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereStartsWith(IQueryObjectWithValue, String)	Adds the condition for a string column to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereTrue(String)	Adds the where condition for a true column value (boolean column equals true). (Inherited from WhereConditionBase<TParent>.)
Public method	WhereTrue(IQueryObjectWithValue)	Adds the where condition for a true expression value (boolean expression equals true). (Inherited from WhereConditionBase<TParent>.)
Public method	WithComment	Adds the comment to the given query

Extension Methods

	Name	Description
Public Extension Method	WhereNotExpired<TQuery>	Filters out objects which have their 'Expiration' column's day (e.g. Expiration) before currentDateTime. (Defined by ScoreContactRuleInfoObjectQueryExtensions.)