IDataQuery Properties |
The IDataQuery type exposes the following members.
Name | Description | |
---|---|---|
AllowMaterialization |
If true, the query allows materialization
| |
ClassName |
Class name
| |
ConnectionStringName |
Query connection string name
| |
Count |
Number of actual records retrieved from the database
| |
CustomQueryText |
Custom query text
| |
DataSource |
Data source that provides the query data. If not set, the query queries the database directly
| |
DataSourceName |
Gets the unique query source ID
| |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
| |
DefaultSourceExpression |
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from IDataQuerySettings.) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from IDataQuerySettings.) | |
HasDataSource |
Returns true if the query has specific data source
| |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IDataQuerySettings.) | |
IncludeBinaryData |
If true, the query includes the object binary data. Default is false
| |
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.
| |
IsNested |
Indicates that this query is part of multi query
(Inherited from IDataQuerySettings.) | |
IsSubQuery |
If true, the query is a sub-query used in another query
(Inherited from IDataQuerySettings.) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from IDataQuerySettings.) | |
Name |
Object name, empty by default
(Inherited from IQueryObject.) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from IDataQuerySettings.) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from IDataQuerySettings.) | |
Parameters |
Query data parameters
(Inherited from IQueryObject.) | |
QueryName |
Query name
| |
QueryText |
Query text
| |
Result |
DataSet with the result
| |
ReturnsSingleColumn |
Returns true if the query returns single column
| |
SelectColumns | Obsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.) | |
SelectColumnsList |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from IDataQuerySettings.) | |
SourceExpression |
Source of the query
(Inherited from IDataQuerySettings.) | |
SupportsReader |
Returns true if the query supports data reader
| |
Tables |
Collection of the result tables
| |
TopNRecords |
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.) | |
TotalRecords |
Gets the number of total records when paging is used. Gets updated once the query executes
| |
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.) |