MultiDocumentQuery Class |
Namespace: CMS.DocumentEngine
public class MultiDocumentQuery : MultiDocumentQueryBase<MultiDocumentQuery, DocumentQuery, TreeNode>
The MultiDocumentQuery type exposes the following members.
Name | Description | |
---|---|---|
MultiDocumentQuery |
Name | Description | |
---|---|---|
mMaxRecords |
Maximum number of records to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
mOffset |
Offset
(Inherited from DataQuerySettingsBaseTQuery.) | |
mOrderByColumns |
Order by columns
(Inherited from DataQuerySettingsBaseTQuery.) | |
mParameters |
Query data parameters
(Inherited from QueryParametersBaseTParent.) | |
mSelectColumnsList |
Columns to select
(Inherited from DataQuerySettingsBaseTQuery.) |
Name | Description | |
---|---|---|
AllowMaterialization |
If true, the query allows materialization
(Inherited from DataQueryBaseTQuery.) | |
ClassName |
Class name
(Inherited from DataQueryBaseTQuery.) | |
ConnectionStringForced |
If true, the connection string was set explicitly
(Inherited from DataQueryBaseTQuery.) | |
ConnectionStringName |
Connection string name
(Inherited from DataQueryBaseTQuery.) | |
Count |
Number of total items in the collection
(Inherited from DataQueryBaseTQuery.) | |
CustomQueryText |
Custom query text
(Inherited from DataQueryBaseTQuery.) | |
DataSource |
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from DataQueryBaseTQuery.) | |
DataSourceName |
Data source identifier that represents the location from which the data are obtained.
(Inherited from WhereConditionBaseTParent.) | |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBaseTQuery.) | |
DefaultOrderByType |
If true, the result is ordered by source type by default, then by source order. If false (default), the result is ordered by the source order, and items from different types may interleave.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
DefaultQuery |
Default query used by the process when type queries are not used.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
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.) | |
ElementType |
Returns the element type.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
Expression |
Query expression
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBaseTQuery.) | |
FirstObject |
Returns first object from the query result DataSet. The property does not limit the actual number of fetched rows.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
ForceOrderBy |
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBaseTQuery.) | |
FullQueryName |
Represents a full query name of the query
(Inherited from DataQueryBaseTQuery.) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBaseTQuery.) | |
HasDataSource |
Returns true if the query has specific data source
(Inherited from DataQueryBaseTQuery.) | |
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 true
(Inherited from DataQueryBaseTQuery.) | |
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.
(Inherited from DataQueryBaseTQuery.) | |
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.) | |
IsOffline |
Returns true if the given collection is offline (disconnected from the database)
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
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 DataQueryBaseTQuery.) | |
NextPageAvailable |
Returns true if the next page is available.
(Inherited from DataQueryBaseTQuery.) | |
ObjectType |
Returns the object type of the objects stored within the collection.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
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.) | |
OrderByResultColumns |
List of columns for the result order by. If not specified, the result is ordered by sources and global order by.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
Parameters |
Query data parameters
(Inherited from QueryParametersBaseTParent.) | |
Properties |
Document query properties.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Provider |
Query provider
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
Queries |
Inner queries. Can be used to search for specific query.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
QueriesList |
Inner queries list. Defines order of the queries.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
QueryName |
Query name
(Inherited from DataQueryBaseTQuery.) | |
QuerySource |
Query source object
(Inherited from DataQuerySettingsBaseTQuery.) | |
QueryText |
Query text
(Inherited from DataQueryBaseTQuery.) | |
Result |
DataSet with the result
(Inherited from DataQueryBaseTQuery.) | |
ReturnsNoResults |
Returns true if query doesn't return any results
(Inherited from WhereConditionBaseTParent.) | |
ReturnsSingleColumn |
Returns true if the query returns single column
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
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.) | |
SelectedTypes |
Returns the types of the inner queries
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
SelectResultColumnsList |
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
SupportsReader |
Returns true if the query supports data reader
(Inherited from DataQueryBaseTQuery.) | |
Tables |
Collection of the result tables
(Inherited from DataQueryBaseTQuery.) | |
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.) | |
TotalRecords |
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from DataQueryBaseTQuery.) | |
TypedResult |
Typed result
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
UseDefaultQuery |
Flag indicating if the default query should be forcibly used. Default false. This flag is automatically reverted to false in case initializer of particular type query is used through Type("sometype", q => q.Where(...)).
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
UseGlobalWhereOnResult |
If true, the global where condition from the parent query is used outside the inner queries on the whole result. If false (default), the global where condition is used inside individual inner queries.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
UseObjectTypeCondition |
If true, the query uses the object type condition.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
UseTypeColumns |
If true (default), the query uses type columns for the output, otherwise it uses only global columns
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
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.) |
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumns(IEnumerableString) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumns(String) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumns(IQueryColumn) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddFilterColumn |
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddHavingInternal |
Adds the given having condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddResultColumn(String) |
Adds the additional column to the query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AddResultColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AddResultColumns(IEnumerableString) |
Adds the additional columns to the query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AddResultColumns(String) |
Adds the additional columns to the query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AddResultColumns(IQueryColumn) |
Adds the additional columns to the query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AddWhereCondition |
Adds the given where condition to the final where condition
(Inherited from WhereConditionBaseTParent.) | |
AddWhereConditionInternal |
Adds the given where condition
(Inherited from WhereConditionBaseTParent.) | |
All |
Ensures that there is no restriction applied for the result.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
AllCultures |
Ensures that all culture versions of the documents are retrieved.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
AllowTopNDistribution |
Returns true if distribution of TOP N to inner queries is allowed
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBaseTParent.) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from WhereConditionBaseTParent.) | |
And(ActionWhereCondition) |
Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from WhereConditionBaseTParent.) | |
AnySettingsDefined |
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBaseTQuery.) | |
ApplyPagingTopN |
Applies top N based on paging settings to the inner query to select only necessary data
(Inherited from DataQueryBaseTQuery.) | |
ApplyParametersTo |
Applies this query parameters to the target object
(Inherited from DataQueryBaseTQuery.) | |
ApplyProperties |
Applies main query properties to the given query to ensure synchronized state before execution
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
ApplySettings(AbstractQueryObject) |
Applies the given settings to the query
(Inherited from DataQueryBaseTQuery.) | |
ApplySettings(ActionDataQuerySettings) |
Applies the given settings to the query
(Inherited from DataQueryBaseTQuery.) | |
ApplyTopN |
Applies TOP N settings to the given query if it is more restrictive than the current query settings.
(Inherited from DataQueryBaseTQuery.) | |
AsTNewType |
Changes the type of the query to another type
(Inherited from DataQueryBaseTQuery.) | |
AsColumn |
Converts the query to the query column using this query as nested
(Inherited from DataQueryBaseTQuery.) | |
AsIDQuery |
Creates an ID query from the given query
(Inherited from DataQueryBaseTQuery.) | |
AsMaterializedList |
Makes a materialized list from the given query
(Inherited from DataQueryBaseTQuery.) | |
AsNested |
Creates a nested query from the given query
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
AsNestedTResult(NestedQuerySettings) |
Creates a nested query from the given query
(Inherited from DataQueryBaseTQuery.) | |
AsSingleColumn |
Creates a single column query from the given query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AsSubQuery |
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.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
AsValue |
Gets a query expression representing this object as a value
(Inherited from DataQueryBaseTQuery.) | |
BinaryData |
Sets whether the binary data should be included to the result
(Inherited from DataQueryBaseTQuery.) | |
BuildMultiQueryFrom |
Builds a multi-query from the given list of queries
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
CallOnDispose |
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.) | |
Changed |
Marks the object as changed
(Inherited from DataQueryBaseTQuery.) | |
CheckPermissions |
Ensures that the result will be filtered based on user Read permission.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
CheckReturnsNoResults |
Checks if where condition results in no data
(Inherited from WhereConditionBaseTParent.) | |
Clone |
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
CloneObject |
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
Column(String) |
Sets the column to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Column(IQueryColumn) |
Sets the column to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Columns(IEnumerableString) |
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Columns(String) |
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Columns(IQueryColumn) |
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
CombineWithAnyCulture |
The data will be combined with documents in any culture if not translated to the requested one(s). When several cultures are required, the order is taken in account as a priority for documents with several matching language versions followed by any other language version.
If no culture specified, the highest priority has site preferred culture, second the default culture followed by the rest of site cultures.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
CombineWithDefaultCulture |
The data will be combined with documents in site default culture if not translated to the requested one(s). When several cultures are required, the order is taken in account as a priority for documents with several matching language versions.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
CopyPropertiesTo |
Copies the properties to the target query.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
CreateChild |
Creates the child collection based on the given provider
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
CreateQuery |
Creates query for the given type
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Culture |
Filters the data to include only documents translated to given culture(s).
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
DataSourceChanged |
Marks the object as changed when data source changes
(Inherited from DataQueryBaseTQuery.) | |
Default |
Ensures default restrictions for the result.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Dispose |
Make sure the objects get disposed
(Inherited from DisposableObject.) | |
Distinct |
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBaseTQuery.) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from QueryParametersBaseTParent.) | |
EnsureQueries(IEnumerableString) |
Ensures the queries for the given types
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
EnsureQueries(String) |
Ensures the queries for the given types
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
EnsureQuery |
Ensures the query with the given type
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Equals(Object) | (Inherited from WhereConditionBaseTParent.) | |
Equals(TParent) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from WhereConditionBaseTParent.) | |
Except |
Gets the intersection of this data query with another query
(Inherited from DataQueryBaseTQuery.) | |
ExceptGlobal |
Filters the data to include only site objects, but not global objects
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
ExcludePath(String) |
Filters the data to exclude documents on given path(s).
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
ExcludePath(String, PathTypeEnum) |
Filters the data to exclude documents on given path.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Execute |
Executes the current query and returns it's results as a DataSet
(Inherited from DataQueryBaseTQuery.) | |
ExecuteReader |
Executes the current query and returns it's results as a data reader
(Inherited from DataQueryBaseTQuery.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBaseTParent.) | |
ExpandColumns |
Expands the columns within this query
(Inherited from DataQueryBaseTQuery.) | |
FilterDuplicates |
Ensures that duplicate document are filtered from the result. This means that linked documents are not retrieved, if there is the original document already included in the results.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
ForEachPage |
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.
(Inherited from DataQueryBaseTQuery.) | |
ForEachRow |
Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
(Inherited from DataQueryBaseTQuery.) | |
From |
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBaseTQuery.) | |
GetAvailableColumns |
Gets the list of all available columns for this query
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetBinaryColumns |
Gets the binary columns for this query
(Inherited from DataQueryBaseTQuery.) | |
GetClassName |
Gets the class name for current query
(Inherited from DataQueryBaseTQuery.) | |
GetClassStructureInfo |
Gets the class structure info for this query
(Inherited from DataQueryBaseTQuery.) | |
GetCompleteQueryParameters |
Returns query parameter container filled with the complete settings of current query.
(Inherited from DataQueryBaseTQuery.) | |
GetCompleteSettings |
Gets the complete parameters for the query execution
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
GetData |
Executes the query. Sets the total records number during execution.
(Inherited from DataQueryBaseTQuery.) | |
GetDataFromDataSource |
Executes the current over data source and returns it's results as a DataSet
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetDataFromDB |
Executes the query
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetDataSourceName |
Gets data source identifier that represents the location from which the data are obtained.
(Inherited from DataQueryBaseTQuery.) | |
GetDefaultOrderBy |
Gets the default order by columns
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetDefaultSingleColumn |
Gets the default single column for the query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
GetDefaultSource |
Gets the default source
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
GetEnumerator |
Gets the typed enumerator
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
GetExecutingQuery |
Gets the query to execute against database
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetExpression |
Gets a query expression representing this object as a value
(Inherited from DataQueryBaseTQuery.) | |
GetExpressions |
Gets the query expressions
(Inherited from DataQuerySettingsBaseTQuery.) | |
GetFullQueryText |
Gets the full query text including resolved parameters
(Inherited from DataQueryBaseTQuery.) | |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from WhereConditionBaseTParent.) | |
GetIDColumn |
Gets the ID column for this query
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetListResultT |
Gets the result as a list of values from the first column that the query returns. Excludes null values from the result.
(Inherited from DataQueryBaseTQuery.) | |
GetMultiQuery |
Gets a multi-query for execution
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
GetObjectType |
Returns object type of objects returned by this query
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
GetQueriesForMultiQuery |
Gets the list of queries for multi query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
GetReaderFromDB |
Executes the query
(Inherited from DataQueryBaseTQuery.) | |
GetResults |
Gets results from executing query
(Inherited from DataQueryBaseTQuery.) | |
GetScalarResultT |
Gets the scalar
(Inherited from DataQueryBaseTQuery.) | |
GetSingleInnerQuery |
Attempts to get a single query if multi-query is defined only by a single query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
GetSingleQuery |
Attempts to get a single query for the whole result based on the current state of the query object
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetSource |
Gets a source for this query
(Inherited from DataQueryBaseTQuery.) | |
GetTypedQuery |
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 QueryParametersBaseTParent.) | |
GetTypesWhereCondition |
Returns the where condition which filters the default query data for specific types
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
GetWhere(String, QueryOperator, Object) |
Gets the where condition for the given column
(Inherited from WhereConditionBaseTParent.) | |
GetWhere(IQueryObjectWithValue, QueryOperator, Object) |
Gets the where condition for the given column
(Inherited from WhereConditionBaseTParent.) | |
GroupBy |
Specifies the columns to group by
(Inherited from DataQuerySettingsBaseTQuery.) | |
HasCompatibleSource |
Returns true if the given query is an external source
(Inherited from DataQueryBaseTQuery.) | |
HasResults |
Returns true, if the query returns any results
(Inherited from DataQueryBaseTQuery.) | |
Having(IWhereCondition) |
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBaseTQuery.) | |
Having(ActionWhereCondition) |
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from DataQuerySettingsBaseTQuery.) | |
Having(String, Boolean) |
Specifies the having condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
Immutable |
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBaseTParent.) | |
InitTypedResult |
Initializes the typed result
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
InRelationWith |
Ensures that only documents in relationship with a specified document are retrieved.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Intersect |
Gets the intersection of this data query with another query
(Inherited from DataQueryBaseTQuery.) | |
LatestVersion |
Ensures that latest version of the documents is retrieved.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
LoadTotalRecordsNonPaged |
Loads the number of total records for an unpaged query
(Inherited from DataQueryBaseTQuery.) | |
LoadTotalRecordsPaged |
Loads the number of total records for a paged query
(Inherited from DataQueryBaseTQuery.) | |
Lock |
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.) | |
ModifyAllInnerQueries |
Modifies all inner queries with the given parameters
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
ModifySingleInnerQuery |
Modifies single inner query with the given parameters. Operation is not supported if multi query doesn't represent a single query source
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
NestingLevel |
Ensures that only documents within specified nesting level are retrieved.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
NewDataSet |
Creates a new DataSet for the query results
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
NewEmptyQuery |
Creates a new empty query
(Inherited from DataQueryBaseTQuery.) | |
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 DataQuerySettingsBaseTQuery.) | |
NewHaving |
Clears the current having condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
NewWhere |
Clears the current where condition
(Inherited from WhereConditionBaseTParent.) | |
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 DataQuerySettingsBaseTQuery.) | |
NoColumns |
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBaseTQuery.) | |
NoDefaultColumns |
Sets the query to return no columns at all
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBaseTParent.) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBaseTQuery.) | |
OnCurrentSite |
Filters the data to include only records on the current site.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
OnlyCoupledColumns |
Ensures that only coupled columns will be included in the results.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
OnlyGlobal |
Filters the data to include only global objects.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
OnSite |
Filters the documents to include only records on the given site.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBaseTParent.) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from WhereConditionBaseTParent.) | |
Or(ActionWhereCondition) |
Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from WhereConditionBaseTParent.) | |
OrderBy(String) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderBy(OrderDirection, String) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByDefault |
Sets the default order by for the query
(Inherited from DataQueryBaseTQuery.) | |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBaseTQuery.) | |
Page |
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from DataQuerySettingsBaseTQuery.) | |
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 DataQuerySettingsBaseTQuery.) | |
Path(String) |
Filters the data to include only documents on given path(s).
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Path(String, PathTypeEnum) |
Filters the data to include only documents on given path.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Published |
Ensures that only documents published on a live site are retrieved.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
PublishedVersion |
Ensures that published version of the documents is retrieved.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
ReplaceColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.) | |
ReplaceOrderByColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.) | |
ReplaceSelectedColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.) | |
Reset |
Flushes the results but leaves the generated query text unchanged.
After the reset, query can be executed again to obtain new data.
(Inherited from DataQueryBaseTQuery.) | |
ResetWhereOperator |
Resets the where operator to the default value
(Inherited from WhereConditionBaseTParent.) | |
ResolveColumns |
Resolves the columns in the given list
(Inherited from DataQueryBaseTQuery.) | |
ResolveType |
Resolves the given type into corresponding types
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
ResultColumn(String) |
Sets the column to select
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultColumn(IQueryColumn) |
Sets the column to select
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultColumns(IEnumerableString) |
Sets the columns to select
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultColumns(String) |
Sets the columns to select
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultColumns(IQueryColumn) |
Sets the columns to select
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultOrderBy(String) |
Adds the columns to the order by query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultOrderBy(OrderDirection, String) |
Adds the columns to the order by query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultOrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
ResultOrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
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 WhereConditionBaseTParent.) | |
SelectT |
Transforms the current result
(Inherited from DataQueryBaseTQuery.) | |
SetClassName |
Sets class name for current query
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
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 QueryParametersBaseTParent.) | |
Source |
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBaseTQuery.) | |
Take |
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBaseTQuery.) | |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBaseTQuery.) | |
TopN |
Selects only first top N number of records
(Inherited from DataQuerySettingsBaseTQuery.) | |
ToString |
Returns the string representation of the expression
(Inherited from QueryParametersBaseTParent.) | |
ToString(Boolean) |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from DataQueryBaseTQuery.) | |
Type |
Includes given type with optional parameters.
When additional parameters are specified, the query always executes using sub-queries for individual types.
If only type is specified, the query allows usage of the default query and additional data from sub-queries may not be included.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
Types |
Includes the given types to the resulting query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
Union |
Gets the union of this data query with another query
(Inherited from DataQueryBaseTQuery.) | |
UnionAll |
Gets the union of this data query with another query without eliminating the duplicities
(Inherited from DataQueryBaseTQuery.) | |
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 WhereConditionBaseTParent.) | |
Where(ActionWhereCondition) |
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from WhereConditionBaseTParent.) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from WhereConditionBaseTParent.) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBaseTParent.) | |
Where(IQueryObjectWithValue, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBaseTParent.) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.) | |
Where(IQueryObjectWithValue, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.) | |
WhereAnyColumn |
Matches the given condition on any column with the same type as the given value type.
(Inherited from DataQueryBaseTQuery.) | |
WhereAnyColumnContains |
Adds condition to all items that contain given text in any of the string columns. Performs a SQL substring search on the data.
(Inherited from DataQueryBaseTQuery.) | |
WhereContains(String, String) |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereContains(IQueryObjectWithValue, String) |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBaseTParent.) | |
WhereEndsWith(String, String) |
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereEndsWith(IQueryObjectWithValue, String) |
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereEquals(String, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.) | |
WhereEquals(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBaseTParent.) | |
WhereExists(IDataQuery) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereExists(IDataQuery, Boolean) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereFalse(String) |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBaseTParent.) | |
WhereFalse(IQueryObjectWithValue) |
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
WhereGreaterThan(String, Object) |
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereGreaterThan(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereIn(String, ICollectionInt32) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereIn(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 WhereConditionBaseTParent.) | |
WhereIn(String, ICollectionInt32, Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
WhereLessThan(String, Object) |
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereLessThan(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereLike(String, String) |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereLike(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from WhereConditionBaseTParent.) | |
WhereNotContains(String, String) |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereNotContains(IQueryObjectWithValue, String) |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEndsWith(String, String) |
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEndsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEquals(String, Object) |
Adds the given where condition to the query. Matches the column which is not equal to a given value.
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereNotIn(String, ICollectionInt32) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereNotLike(String, String) |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereNotLike(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereNotNull(String) |
Adds the where condition for a not null column value
(Inherited from WhereConditionBaseTParent.) | |
WhereNotNull(IQueryObjectWithValue) |
Adds the where condition for a not null expression value
(Inherited from WhereConditionBaseTParent.) | |
WhereNotStartsWith(String, String) |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNotStartsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNull(String) |
Adds the where condition for a null column value
(Inherited from WhereConditionBaseTParent.) | |
WhereNull(IQueryObjectWithValue) |
Adds the where condition for a null expression value
(Inherited from WhereConditionBaseTParent.) | |
WhereStartsWith(String, String) |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereStartsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereTrue(String) |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBaseTParent.) | |
WhereTrue(IQueryObjectWithValue) |
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBaseTParent.) | |
WithCodeName |
Sets the where condition for a specific object code name
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
WithComment |
Adds the comment to the given query
(Inherited from DataQuerySettingsBaseTQuery.) | |
WithCoupledColumns(Boolean) |
Ensures that coupled columns will be included in the results.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
WithCoupledColumns(IncludeCoupledDataEnum) |
Defines how coupled columns will be included in the results.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
WithGuid |
Sets the where condition for a specific object GUID
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
WithID |
Sets the where condition for a specific object ID
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
WithObjectType |
Changes the query to use the given object type. Applies the object type condition to the query. The new object type must have the same class name as the original one.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
WithSettings(AbstractQueryObject) |
Applies the given parameters to the query
(Inherited from DataQueryBaseTQuery.) | |
WithSettings(ActionDataQuerySettings) |
Applies the given parameters to the query
(Inherited from DataQueryBaseTQuery.) | |
WithSource(DataSet) |
Sets the given DataSet as the source of the data query
(Inherited from DataQueryBaseTQuery.) | |
WithSource(DataQuerySource) |
Sets the given source as the source of the data query
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) |
Name | Description | |
---|---|---|
WhereNotExpiredMultiDocumentQuery |
Filters out objects which have their 'Expiration' column's day (e.g. Expiration) before
currentDateTime.
(Defined by ScoreContactRuleInfoObjectQueryExtensions.) |