The IDataQuerySettings TQuery type exposes the following members.
Back to Top
Back to Top
Methods
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
| |
AddColumn(IQueryColumn) |
Adds the additional column to the query
| |
AddColumns(IEnumerable String ) |
Adds the additional columns to the query
| |
AddColumns( String ) |
Adds the additional columns to the query
| |
AddColumns( IQueryColumn ) |
Adds the additional columns to the query
| |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from IWhereCondition TParent .) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from IWhereCondition TParent .) | |
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 IWhereCondition TParent .) | |
ApplyParametersTo |
Applies this where condition to the target object
(Inherited from IQueryParameters.) | |
CloneObject |
Creates the clone of the object.
(Inherited from IQueryObject.) | |
Column(String) |
Sets the column to select
| |
Column(IQueryColumn) |
Sets the column to select
| |
Columns(IEnumerable String ) |
Sets the columns to select
| |
Columns( String ) |
Sets the columns to select
| |
Columns( IQueryColumn ) |
Sets the columns to select
| |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |
Distinct |
Sets the query to use distinct selection over the given columns
| |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from IQueryParameters.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.) | |
FirstResult |
Sets the query as a single object query
| |
GroupBy |
Specifies the columns to group by
| |
Having( IWhereCondition ) |
Adds the given having conditions to the query.
| |
Having(Action WhereCondition ) |
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
| |
Having(String, Boolean) |
Specifies the group by having condition
| |
Changed |
Marks the object as changed
(Inherited from IQueryObject.) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from IQueryObject.) | |
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.
| |
NewHaving |
Clears the current having condition
| |
NewWhere |
Clears the current where condition
(Inherited from IWhereCondition TParent .) | |
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.
| |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from IWhereCondition TParent .) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
| |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from IWhereCondition TParent .) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from IWhereCondition TParent .) | |
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 IWhereCondition TParent .) | |
OrderBy( String ) |
Adds the columns to the order by query
| |
OrderBy(OrderDirection, String ) |
Adds the columns to the order by query
| |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
| |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
| |
Page |
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
| |
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.
| |
ReplaceColumn |
Replaces the selected column with a new name
| |
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.) | |
Take |
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
| |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
| |
TopN |
Selects only first top N number of records
| |
ToString |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.) | |
Where( IWhereCondition ) |
Adds the given where conditions to the query
(Inherited from IWhereCondition TParent .) | |
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 IWhereCondition TParent .) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from IWhereCondition TParent .) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from IWhereCondition TParent .) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereCondition TParent .) | |
WhereContains |
Adds the condition for a string column to contain some substring
(Inherited from IWhereCondition TParent .) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from IWhereCondition TParent .) | |
WhereEquals |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereCondition TParent .) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from IWhereCondition TParent .) | |
WhereExists |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from IWhereCondition TParent .) | |
WhereFalse |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from IWhereCondition TParent .) | |
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 IWhereCondition TParent .) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereLike |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from IWhereCondition TParent .) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from IWhereCondition TParent .) | |
WhereNotContains |
Adds the condition for a string column not to contain some substring
(Inherited from IWhereCondition TParent .) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from IWhereCondition TParent .) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from IWhereCondition TParent .) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereNotIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereNotLike |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from IWhereCondition TParent .) | |
WhereNotNull |
Adds the where condition for a not null column value
(Inherited from IWhereCondition TParent .) | |
WhereNotStartsWith |
Adds the condition for a string column not to start with some prefix
(Inherited from IWhereCondition TParent .) | |
WhereNull |
Adds the where condition for a null column value
(Inherited from IWhereCondition TParent .) | |
WhereStartsWith |
Adds the condition for a string column to start with some prefix
(Inherited from IWhereCondition TParent .) | |
WhereTrue |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from IWhereCondition TParent .) | |
WithComment |
Adds the comment to the given query
|
Properties
Name | Description | |
---|---|---|
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.) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(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.) | |
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.) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.) | |
WhereIsComplex |
Returns true if the given where condition is a complex where condition
(Inherited from IWhereCondition.) |
See Also