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