Table of Contents

Class MultiQueryBase<TQuery, TInnerQuery>

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Base class for the query consisting of multiple queries

public abstract class MultiQueryBase<TQuery, TInnerQuery> : DataQueryBase<TQuery>, IMultiQuery<TQuery, TInnerQuery>, IDataQuery<TQuery>, IDataQuerySettings<TQuery>, IWhereCondition<TQuery>, IQueryParameters<TQuery>, IMultiQuery, IDataQuery, IDataQuerySettings, IWhereCondition, IQueryParameters, IQueryObjectWithValue, IQueryObject where TQuery : MultiQueryBase<TQuery, TInnerQuery>, new() where TInnerQuery : AbstractQueryObject, IDataQuery<TInnerQuery>, new()

Type Parameters

TQuery
TInnerQuery
Inheritance
object
MultiQueryBase<TQuery, TInnerQuery>
Implements
IMultiQuery<TQuery, TInnerQuery>
IDataQuery<TQuery>
Derived
Inherited Members
Extension Methods

Constructors

MultiQueryBase()

Constructor

protected MultiQueryBase()

Properties

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.

public bool DefaultOrderByType { get; set; }

Property Value

bool

DefaultQuery

Default query used by the process when type queries are not used.

protected TInnerQuery DefaultQuery { get; set; }

Property Value

TInnerQuery

OrderByResultColumns

List of columns for the result order by. If not specified, the result is ordered by sources and global order by.

public virtual string OrderByResultColumns { get; set; }

Property Value

string

Queries

Inner queries. Can be used to search for specific query.

public StringSafeDictionary<TInnerQuery> Queries { get; protected set; }

Property Value

StringSafeDictionary<TInnerQuery>

QueriesList

Inner queries list. Defines order of the queries.

public List<TInnerQuery> QueriesList { get; protected set; }

Property Value

List<TInnerQuery>

ReturnsSingleColumn

Returns true if the query returns single column

public override bool ReturnsSingleColumn { get; }

Property Value

bool

SelectResultColumnsList

List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"

public virtual QueryColumnList SelectResultColumnsList { get; set; }

Property Value

QueryColumnList

SelectedTypes

Returns the types of the inner queries

public IEnumerable<string> SelectedTypes { get; }

Property Value

IEnumerable<string>

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(...)).

protected UseDefaultQueryEnum UseDefaultQuery { get; set; }

Property Value

UseDefaultQueryEnum

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.

[Obsolete("Property was not intended for public use and will be removed in the next version.")]
public bool UseGlobalWhereOnResult { get; set; }

Property Value

bool

UseOrderBy

Flag indicating whether the OrderBy parameter should be applied.

protected virtual bool UseOrderBy { get; }

Property Value

bool

UseTypeColumns

If true (default), the query uses type columns for the output, otherwise it uses only global columns

public virtual bool UseTypeColumns { get; set; }

Property Value

bool

Methods

AddResultColumn(IQueryColumn)

Adds the additional column to the query

public virtual TQuery AddResultColumn(IQueryColumn column)

Parameters

column IQueryColumn

Column to add

Returns

TQuery

AddResultColumn(string)

Adds the additional column to the query

public virtual TQuery AddResultColumn(string column)

Parameters

column string

Column to add

Returns

TQuery

AddResultColumns(params IQueryColumn[])

Adds the additional columns to the query

public virtual TQuery AddResultColumns(params IQueryColumn[] columns)

Parameters

columns IQueryColumn[]

Columns to add

Returns

TQuery

AddResultColumns(IEnumerable<string>)

Adds the additional columns to the query

public virtual TQuery AddResultColumns(IEnumerable<string> columns)

Parameters

columns IEnumerable<string>

Columns to add

Returns

TQuery

AddResultColumns(params string[])

Adds the additional columns to the query

public virtual TQuery AddResultColumns(params string[] columns)

Parameters

columns string[]

Columns to add

Returns

TQuery

ApplyGlobalParametersToOuterQuery(ref DataQuery, DataQuerySettings, bool)

Applies global parameters to a sub-queries outer query

protected virtual void ApplyGlobalParametersToOuterQuery(ref DataQuery query, DataQuerySettings globalSettings, bool isSingleQuery)

Parameters

query DataQuery

Outer query

globalSettings DataQuerySettings

Global parameters for the query

isSingleQuery bool

Indicates if the query is a single query

ApplyGlobalParametersToSubqueries(List<TInnerQuery>, QueryDataParameters, DataQuerySettings)

Applies global parameters to inner sub-queries

protected virtual List<string> ApplyGlobalParametersToSubqueries(List<TInnerQuery> queries, QueryDataParameters parameters, DataQuerySettings globalSettings)

Parameters

queries List<TInnerQuery>

List of queries

parameters QueryDataParameters

Data parameters for query execution

globalSettings DataQuerySettings

Parameters for the query

Returns

List<string>

List of full sub-queries text including resolved parameters.

Exceptions

NotSupportedException

Thrown in case of invalid order by column

AsSingleColumn(string, bool)

Creates a single column query from the given query

public override IDataQuery AsSingleColumn(string defaultColumn = null, bool forceColumn = false)

Parameters

defaultColumn string

Specific column to use in case query doesn't return single column yet

forceColumn bool

If true, the given column is forced to the output

Returns

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.

public override IDataQuery AsSubQuery()

Returns

IDataQuery

BuildMultiQueryFrom(List<TInnerQuery>, DataQuerySettings)

Builds a multi-query from the given list of queries

protected IDataQuery BuildMultiQueryFrom(List<TInnerQuery> queries, DataQuerySettings globalSettings)

Parameters

queries List<TInnerQuery>

List of queries

globalSettings DataQuerySettings

Parameters for the query

Returns

IDataQuery

CopyPropertiesTo(IQueryObject)

Copies the properties to the target query.

public override void CopyPropertiesTo(IQueryObject target)

Parameters

target IQueryObject

Target query

CreateQuery(string)

Creates query for the given type

protected abstract TInnerQuery CreateQuery(string type)

Parameters

type string

Query type

Returns

TInnerQuery

EnsureQueries(IEnumerable<string>)

Ensures the queries for the given types

protected void EnsureQueries(IEnumerable<string> types)

Parameters

types IEnumerable<string>

Types to ensure

EnsureQueries(params string[])

Ensures the queries for the given types

protected void EnsureQueries(params string[] types)

Parameters

types string[]

Types to ensure

EnsureQuery(string)

Ensures the query with the given type

protected virtual TInnerQuery EnsureQuery(string type)

Parameters

type string

Query type

Returns

TInnerQuery

GetAvailableColumns()

Gets the list of all available columns for this query

protected override List<string> GetAvailableColumns()

Returns

List<string>

GetCompleteSettings(IDataQuery)

Gets the complete parameters for the query execution

public override DataQuerySettings GetCompleteSettings(IDataQuery executingQuery = null)

Parameters

executingQuery IDataQuery

Executing query for which the parameters are retrieved

Returns

DataQuerySettings

GetDefaultSingleColumn()

Gets the default single column for the query

protected override string GetDefaultSingleColumn()

Returns

string

GetDefaultSource()

Gets the default source

protected override QuerySource GetDefaultSource()

Returns

QuerySource

GetExecutingQuery(DataQuerySettings)

Gets the query to execute against database

public override IDataQuery GetExecutingQuery(DataQuerySettings settings = null)

Parameters

settings DataQuerySettings

Parameters for the query

Returns

IDataQuery

GetGlobalSettings()

Gets the global settings for the query execution

protected virtual DataQuerySettings GetGlobalSettings()

Returns

DataQuerySettings

GetMultiQuery(DataQuerySettings)

Gets a multi-query for execution

protected virtual IDataQuery GetMultiQuery(DataQuerySettings settings)

Parameters

settings DataQuerySettings

Parameters for the query

Returns

IDataQuery

GetQueriesForMultiQuery()

Gets the list of queries for multi query

protected List<TInnerQuery> GetQueriesForMultiQuery()

Returns

List<TInnerQuery>

GetSingleInnerQuery()

Attempts to get a single query if multi-query is defined only by a single query

protected virtual TInnerQuery GetSingleInnerQuery()

Returns

TInnerQuery

GetSingleQuery(DataQuerySettings)

Attempts to get a single query for the whole result based on the current state of the query object

protected virtual IDataQuery GetSingleQuery(DataQuerySettings globalSettings)

Parameters

globalSettings DataQuerySettings

Parameters for the query

Returns

IDataQuery

GetTypesWhereCondition(IEnumerable<string>)

Returns the where condition which filters the default query data for specific types

protected virtual string GetTypesWhereCondition(IEnumerable<string> types)

Parameters

types IEnumerable<string>

List of types for which create the where condition

Returns

string

NewDataSet()

Creates a new DataSet for the query results

protected virtual DataSet NewDataSet()

Returns

DataSet

NoDefaultColumns()

Sets the query to return no columns at all

public virtual TQuery NoDefaultColumns()

Returns

TQuery

ResolveType(string)

Resolves the given type into corresponding types

protected virtual List<string> ResolveType(string type)

Parameters

type string

Source type

Returns

List<string>

ResultColumn(IQueryColumn)

Sets the column to select

public virtual TQuery ResultColumn(IQueryColumn column)

Parameters

column IQueryColumn

Column to set to be selected

Returns

TQuery

ResultColumn(string)

Sets the column to select

public virtual TQuery ResultColumn(string column)

Parameters

column string

Column to set to be selected

Returns

TQuery

ResultColumns(params IQueryColumn[])

Sets the columns to select

public virtual TQuery ResultColumns(params IQueryColumn[] columns)

Parameters

columns IQueryColumn[]

Columns to set to be selected

Returns

TQuery

ResultColumns(IEnumerable<string>)

Sets the columns to select

public virtual TQuery ResultColumns(IEnumerable<string> columns)

Parameters

columns IEnumerable<string>

Columns to set to be selected

Returns

TQuery

ResultColumns(params string[])

Sets the columns to select

public virtual TQuery ResultColumns(params string[] columns)

Parameters

columns string[]

Columns to set to be selected

Returns

TQuery

ResultOrderBy(OrderDirection, params string[])

Adds the columns to the order by query

public virtual TQuery ResultOrderBy(OrderDirection dir, params string[] columns)

Parameters

dir OrderDirection

Order direction

columns string[]

Columns to add to order by

Returns

TQuery

ResultOrderBy(params string[])

Adds the columns to the order by query

public virtual TQuery ResultOrderBy(params string[] columns)

Parameters

columns string[]

Columns to add to order by

Returns

TQuery

ResultOrderByAscending(params string[])

Adds the columns to the order by query to order by the given columns in ascending order

public virtual TQuery ResultOrderByAscending(params string[] columns)

Parameters

columns string[]

Columns to add to order by

Returns

TQuery

ResultOrderByDescending(params string[])

Adds the columns to the order by query to order by the given columns in descending order

public virtual TQuery ResultOrderByDescending(params string[] columns)

Parameters

columns string[]

Columns to add to order by

Returns

TQuery

SetClassName(string)

Sets class name for current query

protected override void SetClassName(string value)

Parameters

value string

New class name value

Type(string, Action<TInnerQuery>)

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.

public virtual TQuery Type(string type, Action<TInnerQuery> parameters = null)

Parameters

type string

Type to include

parameters Action<TInnerQuery>

Action to setup the inner type parameters

Returns

TQuery

Types(params string[])

Includes the given types to the resulting query

public virtual TQuery Types(params string[] types)

Parameters

types string[]

Types to include

Returns

TQuery

WithSource(DataQuerySource)

Sets the given source as the source of the data query

public override TQuery WithSource(DataQuerySource source)

Parameters

source DataQuerySource

Data query source

Returns

TQuery