The DataQuerySettings type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
DataQuerySettings |
Methods
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddColumns(IEnumerable String ) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddColumns( IQueryColumn ) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddFilterColumn |
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddHavingInternal |
Adds the given having condition
(Inherited from DataQuerySettingsBase TQuery .) | |
AddWhereCondition |
Adds the given where condition to the final where condition
(Inherited from WhereConditionBase TParent .) | |
AddWhereConditionInternal |
Adds the given where condition
(Inherited from WhereConditionBase TParent .) | |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from WhereConditionBase 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 WhereConditionBase TParent .) | |
AnySettingsDefined |
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBase TQuery .) | |
ApplyParametersTo |
Applies this query parameters to the target object
(Inherited from DataQuerySettingsBase TQuery .) | |
CallOnDispose |
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.) | |
Clone |
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .) | |
CloneObject |
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .) | |
Column(String) |
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .) | |
Column(IQueryColumn) |
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .) | |
Columns(IEnumerable String ) |
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .) | |
Columns( String ) |
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .) | |
CopyPropertiesTo |
Creates the clone of the collection.
(Inherited from DataQuerySettingsBase TQuery .) | |
Dispose |
Make sure the objects get disposed
(Inherited from DisposableObject.) | |
Distinct |
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBase TQuery .) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from QueryParametersBase TParent .) | |
Equals | (Inherited from Object.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBase TParent .) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FirstResult |
Sets the query as a single object query
(Inherited from DataQuerySettingsBase TQuery .) | |
GetExpressions |
Gets the query expressions
(Inherited from DataQuerySettingsBase TQuery .) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetWhere(String, QueryOperator, Object) |
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .) | |
GetWhere(IQueryObjectWithValue, QueryOperator, Object) |
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .) | |
GroupBy |
Specifies the columns to group by
(Inherited from DataQuerySettingsBase TQuery .) | |
HasCompatibleSource |
Returns true if the given query is an external source
(Inherited from WhereConditionBase TParent .) | |
Having( IWhereCondition ) |
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBase TQuery .) | |
Having(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 DataQuerySettingsBase TQuery .) | |
Having(String, Boolean) |
Specifies the group by having condition
(Inherited from DataQuerySettingsBase TQuery .) | |
Changed |
Marks the object as changed
(Inherited from AbstractQueryObject.) | |
CheckReturnsNoResults |
Checks if where condition results in no data
(Inherited from WhereConditionBase TParent .) | |
Immutable |
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBase TParent .) | |
Lock |
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
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.
(Inherited from DataQuerySettingsBase TQuery .) | |
NewHaving |
Clears the current having condition
(Inherited from DataQuerySettingsBase TQuery .) | |
NewResult |
Returns properly typed this
(Inherited from QueryParametersBase TParent .) | |
NewWhere |
Clears the current where condition
(Inherited from WhereConditionBase 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.
(Inherited from DataQuerySettingsBase TQuery .) | |
NoColumns |
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBase TQuery .) | |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBase TParent .) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBase TQuery .) | |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from WhereConditionBase 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 WhereConditionBase TParent .) | |
OrderBy( String ) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderBy(OrderDirection, String ) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBase TQuery .) | |
Page |
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from DataQuerySettingsBase TQuery .) | |
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.
(Inherited from DataQuerySettingsBase TQuery .) | |
ReplaceColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .) | |
ReplaceOrderByColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .) | |
ReplaceSelectedColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .) | |
ResetWhereOperator |
Resets the where operator to the default value
(Inherited from WhereConditionBase TParent .) | |
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 WhereConditionBase TParent .) | |
Snapshot |
Creates an immutable snapshot of the current query as a base for further evaluation. Doesn't modify the original query in any way.
(Inherited from QueryParametersBase TParent .) | |
Take |
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBase TQuery .) | |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBase TQuery .) | |
TopN |
Selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .) | |
ToString |
Returns the string representation of the expression
(Inherited from QueryParametersBase TParent .) | |
ToString(Boolean) |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from DataQuerySettingsBase TQuery .) | |
Using |
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.) | |
Where( IWhereCondition ) |
Adds the given where conditions to the query
(Inherited from WhereConditionBase 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 WhereConditionBase TParent .) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from WhereConditionBase TParent .) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .) | |
Where(IQueryObjectWithValue, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .) | |
Where(IQueryObjectWithValue, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .) | |
WhereContains(String, String) |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .) | |
WhereContains(IQueryObjectWithValue, String) |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBase TParent .) | |
WhereEndsWith(String, String) |
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereEndsWith(IQueryObjectWithValue, String) |
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereEquals(String, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .) | |
WhereEquals(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBase TParent .) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBase TParent .) | |
WhereExists(IDataQuery) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereExists(IDataQuery, Boolean) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereFalse(String) |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBase TParent .) | |
WhereFalse(IQueryObjectWithValue) |
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBase TParent .) | |
WhereGreaterOrEquals(String, Object) |
Adds the given where condition to the query. Matches the left side which is greater or equal than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereGreaterOrEquals(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is greater or equal than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereGreaterThan(String, Object) |
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereGreaterThan(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBase 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 WhereConditionBase TParent .) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereIn(String, IDataQuery, Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereIn(String, IList Int32 , Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereLessOrEquals(String, Object) |
Adds the given where condition to the query. Matches the left side which is less or equal than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereLessOrEquals(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is less or equal than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereLessThan(String, Object) |
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereLessThan(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereLike(String, String) |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBase TParent .) | |
WhereLike(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
(Inherited from WhereConditionBase TParent .) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from WhereConditionBase TParent .) | |
WhereNotContains(String, String) |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .) | |
WhereNotContains(IQueryObjectWithValue, String) |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from WhereConditionBase TParent .) | |
WhereNotEndsWith(String, String) |
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereNotEndsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereNotEquals(String, Object) |
Adds the given where condition to the query. Matches the column which is not equal to a given value.
(Inherited from WhereConditionBase TParent .) | |
WhereNotEquals(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is not equal to the right side.
(Inherited from WhereConditionBase TParent .) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereNotIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereNotLike(String, String) |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from WhereConditionBase TParent .) | |
WhereNotLike(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator.
(Inherited from WhereConditionBase TParent .) | |
WhereNotNull(String) |
Adds the where condition for a not null column value
(Inherited from WhereConditionBase TParent .) | |
WhereNotNull(IQueryObjectWithValue) |
Adds the where condition for a not null expression value
(Inherited from WhereConditionBase TParent .) | |
WhereNotStartsWith(String, String) |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereNotStartsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereNull(String) |
Adds the where condition for a null column value
(Inherited from WhereConditionBase TParent .) | |
WhereNull(IQueryObjectWithValue) |
Adds the where condition for a null expression value
(Inherited from WhereConditionBase TParent .) | |
WhereStartsWith(String, String) |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereStartsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereTrue(String) |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBase TParent .) | |
WhereTrue(IQueryObjectWithValue) |
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBase TParent .) | |
WithComment |
Adds the comment to the given query
(Inherited from DataQuerySettingsBase TQuery .) |
Extension Methods
Name | Description | |
---|---|---|
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
Name | Description | |
---|---|---|
mMaxRecords |
Maximum number of records to select
(Inherited from DataQuerySettingsBase TQuery .) | |
mOffset |
Offset
(Inherited from DataQuerySettingsBase TQuery .) | |
mParameters |
Query data parameters
(Inherited from QueryParametersBase TParent .) |
Properties
Name | Description | |
---|---|---|
DefaultSourceExpression |
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBase TQuery .) | |
DisposeUsedObjects |
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBase TParent .) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBase TQuery .) | |
ForceOrderBy |
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBase TQuery .) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBase TQuery .) | |
HasGroupBy |
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBase TQuery .) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBase TQuery .) | |
HavingIsComplex |
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBase TQuery .) | |
HavingIsEmpty |
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBase TQuery .) | |
IsImmutable |
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .) | |
IsNested |
Indicates that this query is part of multi query
(Inherited from AbstractQueryObject.) | |
IsPagedQuery |
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBase TQuery .) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBase TQuery .) | |
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 DataQuerySettingsBase TQuery .) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBase TQuery .) | |
Parameters |
Query data parameters
(Inherited from QueryParametersBase TParent .) | |
ReturnsNoResults |
Returns true if query doesn't return any results
(Inherited from WhereConditionBase TParent .) | |
SelectColumns | Obsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase TQuery .) | |
SelectColumnsList |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase TQuery .) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBase TQuery .) | |
SourceExpression |
Source of the query
(Inherited from DataQuerySettingsBase TQuery .) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .) | |
WhereBuilder |
Where condition builder
(Inherited from WhereConditionBase TParent .) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBase TParent .) | |
WhereIsComplex |
Returns true if the given where condition is a complex where condition
(Inherited from WhereConditionBase TParent .) | |
WhereIsEmpty |
Returns true if the where condition is empty
(Inherited from WhereConditionBase TParent .) | |
WhereOperator |
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBase TParent .) |
See Also