The IMultiDocumentQuery TQuery, TInnerQuery, TObject type exposes the following members.
Back to Top
Back to Top
Back to Top
Methods
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
(Inherited from IDataQuerySettings TQuery .) | |
AddColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from IDataQuerySettings TQuery .) | |
AddColumns(IEnumerable String ) |
Adds the additional columns to the query
(Inherited from IDataQuerySettings TQuery .) | |
AddColumns( IQueryColumn ) |
Adds the additional columns to the query
(Inherited from IDataQuerySettings TQuery .) | |
AddResultColumn(String) |
Adds the additional column to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
AddResultColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
AddResultColumns(IEnumerable String ) |
Adds the additional columns to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
AddResultColumns( IQueryColumn ) |
Adds the additional columns to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
All |
Ensures that there is no restriction applied for the result.
(Inherited from IDocumentQuery TQuery, TObject .) | |
AllCultures |
Ensures that all culture versions of the documents are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .) | |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from IWhereCondition TParent .) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from IWhereCondition TParent .) | |
And(Action WhereCondition ) |
Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereCondition TParent .) | |
ApplyParametersTo |
Applies this where condition to the target object
(Inherited from IQueryParameters.) | |
ApplySettings(AbstractQueryObject) |
Applies the given settings to the query
(Inherited from IDataQuery.) | |
ApplySettings(Action DataQuerySettings ) |
Applies the given settings to the query
(Inherited from IDataQuery.) | |
AsIDQuery |
Creates an ID query from the given query
(Inherited from IDataQuery.) | |
AsNested |
Creates a nested query from the given query
(Inherited from IObjectQuery TQuery, TObject .) | |
AsNested TResult |
Creates a nested query from the given query
(Inherited from IDataQuery.) | |
AsSingleColumn |
Creates a single column query from the given query
(Inherited from IDataQuery.) | |
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 IDataQuery.) | |
BinaryData |
Sets whether the binary data should be included to the result
(Inherited from IDataQuery TQuery .) | |
CloneObject |
Creates the clone of the object.
(Inherited from IQueryObject.) | |
Column(String) |
Sets the column to select
(Inherited from IDataQuerySettings TQuery .) | |
Column(IQueryColumn) |
Sets the column to select
(Inherited from IDataQuerySettings TQuery .) | |
Columns(IEnumerable String ) |
Sets the columns to select
(Inherited from IDataQuerySettings TQuery .) | |
Columns( String ) |
Sets the columns to select
(Inherited from IDataQuerySettings TQuery .) | |
CombineWithDefaultCulture |
The data will be combined with documents in site default culture if not translated to the requested one. This behavior can be used only when a single culture of documents is requested.
(Inherited from IDocumentQuery TQuery, TObject .) | |
Culture |
Filters the data to include only documents translated to given culture(s).
(Inherited from IDocumentQuery TQuery, TObject .) | |
Default |
Ensures default restrictions for the result.
(Inherited from IDocumentQuery TQuery, TObject .) | |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |
Distinct |
Sets the query to use distinct selection over the given columns
(Inherited from IDataQuerySettings TQuery .) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from IQueryParameters.) | |
ExceptGlobal |
Filters the data to include only site objects, but not global objects
(Inherited from IObjectQuery TQuery, TObject .) | |
ExcludePath( String ) |
Filters the data to exclude documents on given path(s).
(Inherited from IDocumentQuery TQuery, TObject .) | |
ExcludePath(String, PathTypeEnum) |
Filters the data to exclude documents on given path.
(Inherited from IDocumentQuery TQuery, TObject .) | |
Execute |
Executes the current query and returns it's results as a DataSet
(Inherited from IDataQuery.) | |
ExecuteReader |
Executes the current query and returns it's results as a data reader
(Inherited from IDataQuery.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.) | |
ExpandColumns |
Expands the columns within this query
(Inherited from IDataQuery TQuery .) | |
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 IDocumentQuery TQuery, TObject .) | |
FirstResult |
Sets the query as a single object query
(Inherited from IDataQuerySettings TQuery .) | |
ForEachRow |
Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
(Inherited from IDataQuery.) | |
From |
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQuery TQuery .) | |
GetCompleteSettings |
Gets the complete parameters for the query execution
(Inherited from IDataQuery.) | |
GetListResult T |
Gets the result as a list of values from the first column that the query returns. Excludes null values from the result.
(Inherited from IDataQuery.) | |
GetScalarResult T |
Gets the scalar
(Inherited from IDataQuery.) | |
GroupBy |
Specifies the columns to group by
(Inherited from IDataQuerySettings TQuery .) | |
Having( IWhereCondition ) |
Adds the given having conditions to the query.
(Inherited from IDataQuerySettings 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 IDataQuerySettings TQuery .) | |
Having(String, Boolean) |
Specifies the group by having condition
(Inherited from IDataQuerySettings TQuery .) | |
CheckPermissions |
Ensures that the result will be filtered based on user Read permission.
(Inherited from IDocumentQuery TQuery, TObject .) | |
InCategory |
Ensures that only documents assigned to specified category are retrieved (including all categories on path).
(Inherited from IDocumentQuery TQuery, TObject .) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from IQueryParameters.) | |
InRelationWith |
Ensures that only documents in relationship with a specified document are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .) | |
LatestVersion |
Ensures that latest version of the documents is retrieved.
(Inherited from IDocumentQuery TQuery, TObject .) | |
NestingLevel |
Ensures that only documents within specified nesting level are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .) | |
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 IDataQuerySettings TQuery .) | |
NewHaving |
Clears the current having condition
(Inherited from IDataQuerySettings TQuery .) | |
NewWhere |
Clears the current where condition
(Inherited from IWhereCondition TParent .) | |
NextPage |
Adjusts the query to a next page, using the current page size. Use in combination with PagedBy and NextPageAvailable to iterate over the data in batches.
(Inherited from IDataQuerySettings TQuery .) | |
NoDefaultColumns |
Sets the query to return no columns at all
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from IWhereCondition TParent .) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
(Inherited from IDataQuerySettings TQuery .) | |
OnCurrentSite |
Filters the data to include only records on the current site.
(Inherited from IDocumentQuery TQuery, TObject .) | |
OnlyGlobal |
Filters the data to include only global objects.
(Inherited from IObjectQuery TQuery, TObject .) | |
OnSite |
Filters the data to include only records on the given site. If site binding is defined, filters the global objects by the site ID
(Inherited from IObjectQuery TQuery, TObject .) | |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from IWhereCondition TParent .) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from IWhereCondition TParent .) | |
Or(Action WhereCondition ) |
Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereCondition TParent .) | |
OrderBy( String ) |
Adds the columns to the order by query
(Inherited from IDataQuerySettings TQuery .) | |
OrderBy(OrderDirection, String ) |
Adds the columns to the order by query
(Inherited from IDataQuerySettings TQuery .) | |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from IDataQuerySettings TQuery .) | |
OrderByDefault |
Sets the default order by for the query
(Inherited from IDataQuery TQuery .) | |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from IDataQuerySettings TQuery .) | |
Page |
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from IDataQuerySettings 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 IDataQuerySettings TQuery .) | |
Path( String ) |
Filters the data to include only documents on given path(s).
(Inherited from IDocumentQuery TQuery, TObject .) | |
Path(String, PathTypeEnum) |
Filters the data to include only documents on given path.
(Inherited from IDocumentQuery TQuery, TObject .) | |
Published |
Ensures that only documents published on a live site are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .) | |
PublishedVersion |
Ensures that latest version of the documents is retrieved.
(Inherited from IDocumentQuery TQuery, TObject .) | |
ReplaceColumn |
Replaces the selected column with a new name
(Inherited from IDataQuerySettings TQuery .) | |
ResultColumn(String) |
Sets the column to select
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultColumn(IQueryColumn) |
Sets the column to select
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultColumns(IEnumerable String ) |
Sets the columns to select
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultColumns( String ) |
Sets the columns to select
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultOrderBy( String ) |
Adds the columns to the order by query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultOrderBy(OrderDirection, String ) |
Adds the columns to the order by query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultOrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
ResultOrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from IMultiQuery TQuery, 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 IWhereCondition.) | |
Select T |
Transforms the current result
(Inherited from IDataQuery.) | |
Source |
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQuery TQuery .) | |
Take |
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
(Inherited from IDataQuerySettings TQuery .) | |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from IDataQuerySettings TQuery .) | |
TopN |
Selects only first top N number of records
(Inherited from IDataQuerySettings TQuery .) | |
ToString |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.) | |
Type |
Includes given type with optional parameters
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
Types |
Includes the given types to the resulting query
(Inherited from IMultiQuery TQuery, TInnerQuery .) | |
Where( IWhereCondition ) |
Adds the given where conditions to the query
(Inherited from IWhereCondition TParent .) | |
Where(Action WhereCondition ) |
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereCondition TParent .) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from IWhereCondition TParent .) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from IWhereCondition TParent .) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereCondition TParent .) | |
WhereAnyColumn |
Matches the given condition on any column with the same type as the given value type.
(Inherited from IDataQuery TQuery .) | |
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 IDataQuery TQuery .) | |
WhereContains |
Adds the condition for a string column to contain some substring
(Inherited from IWhereCondition TParent .) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from IWhereCondition TParent .) | |
WhereEquals |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereCondition TParent .) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from IWhereCondition TParent .) | |
WhereExists |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from IWhereCondition TParent .) | |
WhereFalse |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from IWhereCondition TParent .) | |
WhereID |
Adds the where condition to match the ID to the query. In case the column name is not provided or unknown, does not generate where condition. If given ID is invalid, adds the condition to match NULL.
(Inherited from IWhereCondition TParent .) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereLike |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from IWhereCondition TParent .) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from IWhereCondition TParent .) | |
WhereNotContains |
Adds the condition for a string column not to contain some substring
(Inherited from IWhereCondition TParent .) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from IWhereCondition TParent .) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from IWhereCondition TParent .) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereNotIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from IWhereCondition TParent .) | |
WhereNotLike |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from IWhereCondition TParent .) | |
WhereNotNull |
Adds the where condition for a not null column value
(Inherited from IWhereCondition TParent .) | |
WhereNotStartsWith |
Adds the condition for a string column not to start with some prefix
(Inherited from IWhereCondition TParent .) | |
WhereNull |
Adds the where condition for a null column value
(Inherited from IWhereCondition TParent .) | |
WhereStartsWith |
Adds the condition for a string column to start with some prefix
(Inherited from IWhereCondition TParent .) | |
WhereTrue |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from IWhereCondition TParent .) | |
WithCodeName |
Sets the where condition for a specific object code name
(Inherited from IObjectQuery TQuery, TObject .) | |
WithComment |
Adds the comment to the given query
(Inherited from IDataQuerySettings TQuery .) | |
WithGuid |
Sets the where condition for a specific object code name
(Inherited from IObjectQuery TQuery, TObject .) | |
WithID |
Sets the where condition for a specific object ID
(Inherited from IObjectQuery TQuery, 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 IObjectQuery TQuery, TObject .) | |
WithSettings(AbstractQueryObject) |
Applies the given parameters to the query
(Inherited from IDataQuery TQuery .) | |
WithSettings(Action DataQuerySettings ) |
Applies the given parameters to the query
(Inherited from IDataQuery TQuery .) | |
WithSource(DataSet) |
Sets the given DataSet as the source of the data query
(Inherited from IDataQuery TQuery .) | |
WithSource(DataQuerySource) |
Sets the given source as the source of the data query
(Inherited from IDataQuery TQuery .) |
Extension Methods
Name | Description | |
---|---|---|
FakeExecution |
Fakes the execution of a query
(Defined by UnitTestExtensions.) |
Properties
Name | Description | |
---|---|---|
ClassName |
Class name
(Inherited from IDataQuery.) | |
CustomQueryText |
Custom query text
(Inherited from IDataQuery.) | |
DataSource |
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from IDataQuery.) | |
DataSourceName |
Gets the unique query source ID
(Inherited from IDataQuery.) | |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
(Inherited from IDataQuery.) | |
DefaultSourceExpression |
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from IDataQuerySettings.) | |
HasDataSource |
Returns true if the query has specific data source
(Inherited from IDataQuery.) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IDataQuerySettings.) | |
IncludeBinaryData |
If true, the query includes the object binary data. Default is false
(Inherited from IDataQuery.) | |
IsNested |
Indicates that this query is part of multi query
(Inherited from IQueryObject.) | |
IsSubQuery |
If true, the query is a sub-query used in another query
(Inherited from IDataQuery.) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from IDataQuerySettings.) | |
Name |
Object name, empty by default
(Inherited from IQueryObject.) | |
ObjectType |
Returns the object type of the objects stored within the collection.
(Inherited from IObjectQuery.) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from IDataQuerySettings.) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from IDataQuerySettings.) | |
OrderByResultColumns |
List of columns for the result order by. If not specified, the result is ordered by sources and global order by.
(Inherited from IMultiQuery.) | |
Parameters |
Query data parameters
(Inherited from IQueryParameters.) | |
Properties |
Document query parameters.
(Inherited from IDocumentQuery.) | |
QueryName |
Query name
(Inherited from IDataQuery.) | |
QueryText |
Query text
(Inherited from IDataQuery.) | |
Result |
DataSet with the result
(Inherited from IDataQuery.) | |
SelectColumns |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from IDataQuerySettings.) | |
SelectResultColumns |
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from IMultiQuery.) | |
SourceExpression |
Source of the query
(Inherited from IDataQuerySettings.) | |
SupportsReader |
Returns true if the query supports data reader
(Inherited from IDataQuery.) | |
Tables |
Collection of the result tables
(Inherited from IDataQuery.) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.) | |
TotalRecords |
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from IDataQuery.) | |
UseTypeColumns |
If true (default), the query uses type columns for the output, otherwise it uses only global columns
(Inherited from IMultiQuery.) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.) | |
WhereIsComplex |
Returns true if the given where condition is a complex where condition
(Inherited from IWhereCondition.) |
See Also