Interface IDataQuerySettings

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Data query parameters interface

public interface IDataQuerySettings : IWhereCondition, IQueryParameters, IQueryObject

Inherited Members

IWhereCondition.DataSourceName

IWhereCondition.WhereCondition

IWhereCondition.WhereIsComplex

IWhereCondition.WhereIsEmpty

IQueryParameters.ApplyParametersTo(IQueryObject)

IQueryParameters.CopyPropertiesTo(IQueryObject)

IQueryParameters.Expand(string)

IQueryParameters.ToString(bool)

IQueryParameters.EnsureParameters()

IQueryObject.Name

IQueryObject.Parameters

IQueryObject.CloneObject()

IQueryObject.IncludeDataParameters(QueryDataParameters, string)

IQueryObject.Changed()

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

DefaultQuerySource

Default source of the query in case source is not defined

QuerySource DefaultQuerySource { get; set; }

Property Value

QuerySource

FilterColumns

List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"

QueryColumnList FilterColumns { get; set; }

Property Value

QueryColumnList

GetTotalRecordsForPagedQuery

If true, the query is configured to get total number of records when the paging is set.

bool GetTotalRecordsForPagedQuery { get; set; }

Property Value

bool

See Also

Offset

MaxRecords

GroupByColumns

List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"

string GroupByColumns { get; set; }

Property Value

string

HasGroupBy

Returns true if the given query has group by set

bool HasGroupBy { get; }

Property Value

bool

HavingCondition

Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"

string HavingCondition { get; set; }

Property Value

string

IsNested

Indicates that this query is nested within another query as its source. This brings certain constraints such as that is cannot use CTE.

bool IsNested { get; set; }

Property Value

bool

IsPagedQuery

Returns true if the query has the paging enabled

bool IsPagedQuery { get; }

Property Value

bool

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.

bool IsSubQuery { get; set; }

Property Value

bool

MaxRecords

Maximum number of results to return (use for paging together with Offset)

int MaxRecords { get; set; }

Property Value

int

Offset

Index of the first record to return (use for paging together with MaxRecords)

int Offset { get; set; }

Property Value

int

OrderByColumns

List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"

string OrderByColumns { get; set; }

Property Value

string

QuerySource

Source of the query

QuerySource QuerySource { get; set; }

Property Value

QuerySource

SelectColumnsList

List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"

QueryColumnList SelectColumnsList { get; set; }

Property Value

QueryColumnList

SelectDistinct

If set to true, returns only distinct (different) values.

bool SelectDistinct { get; set; }

Property Value

bool

TopNRecords

If set, selects only first top N number of records

int TopNRecords { get; set; }

Property Value

int

TotalExpression

Total items expression. When defined, used instead default total items for a paged query.

string TotalExpression { get; set; }

Property Value

string