IDataQuery Interface

Data query interface

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

Syntax

public interface IDataQuery : IDataQuerySettings, 
	IWhereCondition, IQueryParameters, IQueryObject, IQueryObjectWithValue

The IDataQuery type exposes the following members.

Properties

	Name	Description
Public property	AllowMaterialization	If true, the query allows materialization
Public property	ClassName	Class name
Public property	ConnectionStringName	Query connection string name
Public property	Count	Number of actual records retrieved from the database
Public property	CustomQueryText	Custom query text
Public property	DataSource	Data source that provides the query data. If not set, the query queries the database directly
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained. (Inherited from IWhereCondition.)
Public property	DefaultOrderByColumns	Default order by columns used in case if needed, and order by is not specified
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	HasDataSource	Returns true if the query has specific data source
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	IncludeBinaryData	If true, the query includes the object binary data
Public property	IsCombinedQuery	If true, this query is combined from several queries. When additional parameters are applied to it, it will be wrapped into a nested query.
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	QueryName	Query name
Public property	QuerySource	Source of the query (Inherited from IDataQuerySettings.)
Public property	QueryText	Query text
Public property	Result	DataSet with the result.
Public property	ReturnsSingleColumn	Returns true if the query returns single column
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	SupportsReader	Gets a value indicating whether the query supports the ExecuteReader(CommandBehavior, Boolean) method. Otherwise the Execute() method must be used.
Public property	Tables	Collection of the result tables
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	TotalRecords	Gets the number of total records when paging is used. Gets updated once the query executes
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	ApplyParametersTo	Applies this where condition to the target object (Inherited from IQueryParameters.)
Public method	ApplySettings(AbstractQueryObject)	Applies the given settings to the query
Public method	ApplySettings(Action<DataQuerySettings>)	Applies the given settings to the query
Public method	As<T>	Changes the type of the query to another type
Public method	AsIDQuery	Creates an ID query from the given query
Public method	AsMaterializedList	Makes a materialized list from the given query
Public method	AsNested<TResult>	Creates a nested query from the given query
Public method	AsSingleColumn	Creates a single column query from the given query
Public method	AsSubQuery	Modifies the query to be able to be used as a sub-query, e.g. for usage in WHERE A IN ([query]). Ensures single column result, and removes order by from the result.
Public method	AsValue	Gets a query expression representing this object as a value (Inherited from IQueryObjectWithValue.)
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	CopyPropertiesTo	Copies the properties to the target query. (Inherited from IQueryParameters.)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from IQueryParameters.)
Public method	Execute	Executes the current query and returns it's results as a DataSet.
Public method	ExecuteReader	Executes the current query and returns it's results as an IDataReader. The SupportsReader flag indicates whether this operation is supported.
Public method	ExecuteReaderAsync	Asynchronously executes the current query and returns it's results as an IDataReader. The SupportsReader flag indicates whether this operation is supported.
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from IQueryParameters.)
Public method	ForEachRow	Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
Public method	GetCompleteQueryParameters	Returns query parameter container filled with the complete settings of current query.
Public method	GetCompleteSettings	Gets the complete parameters for the query execution
Public method	GetEnumerableResult	Gets an enumeration of data records representing the result of this query.
Public method	GetEnumerableResultAsync	Asynchronously gets an enumeration of data records representing the result of this query.
Public method	GetExecutingQuery	Gets the query to execute against database
Public method	GetExpression	Gets a string expression representing this object (Inherited from IQueryObjectWithValue.)
Public method	GetFullQueryText	Gets the full query text including resolved parameters
Public method	GetListResult<T>	Gets the result as a list of values from the first column that the query returns. Excludes null values from the result.
Public method	GetScalarResult<T>	Gets the scalar
Public method	GetSource	Gets a source for this query
Public method	HasCompatibleSource	Returns true if the given query is an external source
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from IQueryObject.)
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	Select<T>	Transforms the current result
Public method	ToString	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from IQueryParameters.)