IDataQuerySettings Interface |
Namespace: CMS.DataEngine
public interface IDataQuerySettings : IWhereCondition, IQueryParameters, IQueryObject, IDisposable
The IDataQuerySettings type exposes the following members.
Name | Description | |
---|---|---|
DataSourceName |
Data source identifier that represents the location from which the data are obtained.
(Inherited from IWhereCondition.) | |
DefaultQuerySource |
Default source of the query in case source is not defined
| |
DefaultSourceExpression | Obsolete.
Default source of the query in case source is not defined
| |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
| |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
| |
HasGroupBy |
Returns true if the given query has group by set
| |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
| |
IsNested |
Indicates that this query is nested within another query as its source.
This brings certain constraints such as that is cannot use CTE.
| |
IsPagedQuery |
Returns true if the query has the paging enabled
| |
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.
| |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
| |
Name |
Object name, empty by default
(Inherited from IQueryObject.) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
| |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
| |
Parameters |
Query data parameters
(Inherited from IQueryObject.) | |
QuerySource |
Source of the query
| |
SelectColumnsList |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
| |
SelectDistinct |
If set to true, returns only distinct (different) values.
| |
SourceExpression | Obsolete.
Source of the query
| |
TopNRecords |
If set, selects only first top N number of records
| |
TotalExpression |
Total items expression. When defined, used instead default total items for a paged query.
| |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.) | |
WhereIsComplex |
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from IWhereCondition.) | |
WhereIsEmpty |
Returns true if the where condition is empty
(Inherited from IWhereCondition.) |
Name | Description | |
---|---|---|
ApplyParametersTo |
Applies this where condition to the target object
(Inherited from IQueryParameters.) | |
CloneObject |
Creates the clone of the object.
(Inherited from IQueryObject.) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from IQueryParameters.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.) | |
Changed |
Marks the object as changed
(Inherited from IQueryObject.) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from IQueryObject.) | |
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.) | |
ToString |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.) |