Click or drag to resize
DataQueryBase<TQuery> Methods

The DataQueryBase< TQuery> generic type exposes the following members.

Methods
  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodAddColumns(IEnumerable<String>)
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodAddColumns(String[])
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodAddColumns(IQueryColumn[])
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodAddFilterColumn
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBase<TQuery>.)
Protected methodAddHavingInternal
Adds the given having condition
(Inherited from DataQuerySettingsBase<TQuery>.)
Protected methodAddWhereCondition
Adds the given where condition to the final where condition
(Inherited from WhereConditionBase<TParent>.)
Protected methodAddWhereConditionInternal
Adds the given where condition
(Inherited from WhereConditionBase<TParent>.)
Protected methodAllowTopNDistribution
Returns true if distribution of TOP N to inner queries is allowed. Defaults to false. Distribution of TOP N to inner queries helps performance mainly in case the inner query is complex and includes nesting levels, for simple queries it is better not to allow the distribution.
Public methodAnd()
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase<TParent>.)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from WhereConditionBase<TParent>.)
Public methodAnd(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>.)
Protected methodAnySettingsDefined
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBase<TQuery>.)
Protected methodStatic memberApplyOrderBy
Applies order by from the given settings to the inner query
Protected methodApplyPagingTopN
Applies top N based on paging settings to the inner query to select only necessary data
Public methodApplyParametersTo
Applies this query parameters to the target object
(Overrides DataQuerySettingsBase<TQuery>.ApplyParametersTo(IQueryObject).)
Protected methodApplyProperties
Applies main query properties to the given query to ensure synchronized state before execution
Public methodApplySettings(AbstractQueryObject)
Applies the given settings to the query
Public methodApplySettings(Action<DataQuerySettings>)
Applies the given settings to the query
Protected methodApplyTopN
Applies TOP N settings to the given query if it is more restrictive than the current query settings.
Public methodAs<TNewType>
Changes the type of the query to another type
Public methodAsColumn
Converts the query to the query column using this query as nested
Public methodAsIDQuery
Creates an ID query from the given query
Public methodAsMaterializedList
Makes a materialized list from the given query
Public methodAsNested<TResult>
Creates a nested query from the given query
Public methodAsSingleColumn
Creates a single column query from the given query
Public methodAsSubQuery
Modifies the query to be able to be used as a sub-query, e.g. for usage in WHERE A IN ([query]). Ensures single column result, and removes order by from the result.
Public methodAsValue
Gets a query expression representing this object as a value
Public methodBinaryData
Sets whether the binary data should be included to the result
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.)
Public methodChanged
Marks the object as changed
(Overrides AbstractQueryObject.Changed().)
Protected methodCheckReturnsNoResults
Checks if where condition results in no data
(Inherited from WhereConditionBase<TParent>.)
Public methodClone
Creates the clone of the object.
(Inherited from QueryParametersBase<TParent>.)
Public methodCloneObject
Creates the clone of the object.
(Inherited from QueryParametersBase<TParent>.)
Public methodColumn(String)
Sets the column to select
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodColumn(IQueryColumn)
Sets the column to select
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodColumns(IEnumerable<String>)
Sets the columns to select
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodColumns(String[])
Sets the columns to select
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodColumns(IQueryColumn[])
Sets the columns to select
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodCopyPropertiesTo
Copies the properties to the target query.
(Overrides DataQuerySettingsBase<TQuery>.CopyPropertiesTo(IQueryObject).)
Protected methodDataSourceChanged
Marks the object as changed when data source changes
Public methodDispose
Make sure the objects get disposed
(Inherited from DisposableObject.)
Public methodDistinct
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from QueryParametersBase<TParent>.)
Public methodEquals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from WhereConditionBase<TParent>.)
Public methodExcept
Gets the intersection of this data query with another query
Public methodExecute
Executes the current query and returns it's results as a DataSet
Public methodExecuteReader
Executes the current query and returns it's results as a data reader
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBase<TParent>.)
Public methodExpandColumns
Expands the columns within this query
Public methodForEachPage
Executes the given action for each page (DataSet) in the results. If the query is not set up as a paged query before calling this method and pageSize is not set, executes the action once with the current results.
Public methodForEachRow
Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
Public methodFrom
Defines the source of the data (table, view or a nested query)
Protected methodGetAvailableColumns
Gets the list of all available columns for this query
Protected methodGetBinaryColumns
Gets the binary columns for this query
Protected methodGetClassName
Gets the class name for current query
Protected methodGetClassStructureInfo
Gets the class structure info for this query
Public methodGetCompleteQueryParameters
Returns query parameter container filled with the complete settings of current query.
Public methodGetCompleteSettings
Gets the complete parameters for the query execution. The parameters are always a new instance of DataQuerySettings which can be further modified without any impact to the query itself.
Protected methodGetData
Executes the query. Sets the total records number during execution.
Protected methodGetDataFromDataSource
Executes the current over data source and returns it's results as a DataSet
Protected methodGetDataFromDB
Executes the query
Protected methodGetDataSourceName
Gets data source identifier that represents the location from which the data are obtained.
(Overrides WhereConditionBase<TParent>.GetDataSourceName().)
Protected methodGetDefaultOrderBy
Gets the default order by columns
Protected methodGetDefaultSingleColumn
Gets the default single column for the query
Protected methodGetDefaultSource
Gets the default source for this query
(Overrides DataQuerySettingsBase<TQuery>.GetDefaultSource().)
Public methodGetExecutingQuery
Gets the query to execute against database
Public methodGetExpression
Gets a query expression representing this object as a value
Public methodGetExpressions
Gets the query expressions
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodGetFullQueryText
Gets the full query text including resolved parameters
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from WhereConditionBase<TParent>.)
Protected methodGetIDColumn
Gets the ID column for this query
Public methodGetListResult<T>
Gets the result as a list of values from the first column that the query returns. Excludes null values from the result.
Protected methodGetReaderFromDB
Executes the query
Protected methodGetResults
Gets results from executing query
Public methodGetScalarResult<T>
Gets the scalar
Public methodGetSource
Gets a source for this query
Public methodGetTypedQuery
Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax. If current Query is immutable then its clone is returned.
(Inherited from QueryParametersBase<TParent>.)
Protected methodGetWhere(String, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBase<TParent>.)
Protected methodGetWhere(IQueryObjectWithValue, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBase<TParent>.)
Public methodGroupBy
Specifies the columns to group by
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodHasCompatibleSource
Returns true if the given query is an external source
(Overrides WhereConditionBase<TParent>.HasCompatibleSource(IDataQuery).)
Public methodHasResults
Returns true, if the query returns any results
Public methodHaving(IWhereCondition[])
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodHaving(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>.)
Public methodHaving(String, Boolean)
Specifies the having condition
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodImmutable
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase<TParent>.)
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBase<TParent>.)
Public methodIntersect
Gets the intersection of this data query with another query
Protected methodLoadTotalRecordsNonPaged
Loads the number of total records for an unpaged query
Protected methodLoadTotalRecordsPaged
Loads the number of total records for a paged query
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Protected methodNewEmptyQuery
Creates a new empty query
Public methodNewGroupBy
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>.)
Public methodNewHaving
Clears the current having condition
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodNewWhere
Clears the current where condition
(Inherited from WhereConditionBase<TParent>.)
Public methodNextPage
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>.)
Protected methodNoColumns
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBase<TParent>.)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodOr()
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase<TParent>.)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from WhereConditionBase<TParent>.)
Public methodOr(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>.)
Public methodOrderBy(String[])
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodOrderBy(OrderDirection,String[])
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodOrderByDefault
Sets the default order by for the query
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodPage
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodPagedBy
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>.)
Public methodReplaceColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase<TQuery>.)
Protected methodReplaceOrderByColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase<TQuery>.)
Protected methodReplaceSelectedColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodReset
Flushes the results but leaves the generated query text unchanged. After the reset, query can be executed again to obtain new data.
(Overrides AbstractQueryObject.Reset().)
Protected methodResetWhereOperator
Resets the where operator to the default value
(Inherited from WhereConditionBase<TParent>.)
Protected methodResolveColumns
Resolves the columns in the given list
Public methodReturnNoResults
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>.)
Public methodSelect<T>
Transforms the current result
Protected methodSetClassName
Gets the class name for current query
Public methodSnapshot
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>.)
Public methodSource
Defines the source of the data (table, view or a nested query)
Public methodTake
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>.)
Public methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodTopN
Selects only first top N number of records
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodToString()
Returns the string representation of the expression
(Inherited from QueryParametersBase<TParent>.)
Public methodToString(Boolean)
Returns the string representation of the expression, with possibility of expanding parameters
(Overrides DataQuerySettingsBase<TQuery>.ToString(Boolean).)
Public methodUnion
Gets the union of this data query with another query
Public methodUnionAll
Gets the union of this data query with another query without eliminating the duplicities
Public methodUsing
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.)
Public methodWhere(IWhereCondition[])
Adds the given where conditions to the query
(Inherited from WhereConditionBase<TParent>.)
Public methodWhere(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>.)
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from WhereConditionBase<TParent>.)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhere(IQueryObjectWithValue, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhere(IQueryObjectWithValue, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereAnyColumn
Matches the given condition on any column with the same type as the given value type.
Public methodWhereAnyColumnContains
Adds condition to all items that contain given text in any of the string columns. Performs a SQL substring search on the data.
Public methodWhereContains(String, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereContains(IQueryObjectWithValue, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereEndsWith(String, String)
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereEquals(String, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereExists(IDataQuery)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase<TParent>.)
Protected methodWhereExists(IDataQuery, Boolean)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereFalse(String)
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereFalse(IQueryObjectWithValue)
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereGreaterOrEquals(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>.)
Public methodWhereGreaterOrEquals(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>.)
Public methodWhereGreaterThan(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>.)
Public methodWhereGreaterThan(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>.)
Public methodWhereID
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>.)
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereIn(String, ICollection<Int32>)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase<TParent>.)
Protected methodWhereIn(String, IDataQuery, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)". Supported generic type is int, long, string or guid ONLY!
(Inherited from WhereConditionBase<TParent>.)
Protected methodWhereIn(String, ICollection<Int32>, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereLessOrEquals(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>.)
Public methodWhereLessOrEquals(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>.)
Public methodWhereLessThan(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>.)
Public methodWhereLessThan(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>.)
Public methodWhereLike(String, String)
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereLike(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNot
Adds the negation of the given where condition
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotContains(String, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotContains(IQueryObjectWithValue, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotEndsWith(String, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotEquals(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>.)
Public methodWhereNotEquals(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>.)
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotIn(String, ICollection<Int32>)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotLike(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>.)
Public methodWhereNotLike(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>.)
Public methodWhereNotNull(String)
Adds the where condition for a not null column value
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotNull(IQueryObjectWithValue)
Adds the where condition for a not null expression value
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotStartsWith(String, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNotStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNull(String)
Adds the where condition for a null column value
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereNull(IQueryObjectWithValue)
Adds the where condition for a null expression value
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereStartsWith(String, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereTrue(String)
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBase<TParent>.)
Public methodWhereTrue(IQueryObjectWithValue)
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBase<TParent>.)
Public methodWithComment
Adds the comment to the given query
(Inherited from DataQuerySettingsBase<TQuery>.)
Public methodWithSettings(AbstractQueryObject)
Applies the given parameters to the query
Public methodWithSettings(Action<DataQuerySettings>)
Applies the given parameters to the query
Public methodWithSource(DataSet)
Sets the given DataSet as the source of the data query
Public methodWithSource(DataQuerySource)
Sets the given source as the source of the data query
Top
Extension Methods
See Also