Class QueryDataParameters

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Container that holds a list of query parameters.

public class QueryDataParameters

Inheritance

object

QueryDataParameters

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

QueryExtensions.EnsureDataSet<TInfo>(QueryDataParameters)

BaseExtensions.Batch<T>(IEnumerable<T>, int)

Constructors

QueryDataParameters(QueryDataParameters)

Constructor

public QueryDataParameters(QueryDataParameters parentParameters = null)

Parameters

parentParameters QueryDataParameters

Parent query parameters

Properties

Count

Number of the registered parameters

public int Count { get; }

Property Value

int

ExistingLocalParameters

Table of existing parameters [name -> DataParameter]

protected Dictionary<string, DataParameter> ExistingLocalParameters { get; }

Property Value

Dictionary<string, DataParameter>

ExtraLocalMacros

Extra query macros

protected Dictionary<string, string> ExtraLocalMacros { get; }

Property Value

Dictionary<string, string>

FillDataSet

DataSet to be filled by the query. If not given, new DataSet is created

public DataSet FillDataSet { get; set; }

Property Value

DataSet

this[int]

Returns the parameter on specified index.

public DataParameter this[int index] { get; }

Parameters

index int

Index

Property Value

DataParameter

this[string]

Returns the parameter of the specified name.

public DataParameter this[string name] { get; }

Parameters

name string

Parameter name

Property Value

DataParameter

LocalParameters

List of parameters defined locally in this instance

protected List<DataParameter> LocalParameters { get; }

Property Value

List<DataParameter>

MacroCount

Number of macros in the data parameters

public int MacroCount { get; }

Property Value

int

ParentParameters

Parent query parameters

protected QueryDataParameters ParentParameters { get; set; }

Property Value

QueryDataParameters

QueryAfter

Text included after the query

public string QueryAfter { get; set; }

Property Value

string

QueryBefore

Text included before the query

public string QueryBefore { get; set; }

Property Value

string

Source

Source of the data

public string Source { get; set; }

Property Value

string

Methods

Add(DataParameter)

Adds the parameter into the list.

public void Add(DataParameter param)

Parameters

param DataParameter

Parameter to add

Add(DataParameter, bool)

Adds the parameter into the list.

protected virtual void Add(DataParameter param, bool unique)

Parameters

param DataParameter

Parameter to add

unique bool

If true, the parameter will be added with a unique name if already present

Add(string, object, bool)

Adds the parameter into the list.

public DataParameter Add(string name, object value, bool condition)

Parameters

name string

Parameter name

value object

Parameter value

condition bool

Condition, if false, the NULL value is set

Returns

DataParameter

Add(string, object, Type)

Adds the parameter into the list.

public DataParameter Add(string name, object value, Type type = null)

Parameters

name string

Parameter name

value object

Parameter value

type Type

Type of the parameter

Returns

DataParameter

AddDateTime(string, DateTime)

Adds the date time parameter into the list (if the date time is DateTime.MinValue, adds DBNull.Value).

public DataParameter AddDateTime(string name, DateTime value)

Parameters

name string

Parameter name

value DateTime

Parameter value

Returns

DataParameter

AddGuid(string, Guid)

Adds the guid parameter into the list (if the guid id Guid.Empty, adds DBNull.Value).

public DataParameter AddGuid(string name, Guid value)

Parameters

name string

Parameter name

value Guid

Parameter value

Returns

DataParameter

AddId(string, int)

Adds the ID parameter into the list (if the ID is not larger than 0, adds DBNull.Value).

public DataParameter AddId(string name, int value)

Parameters

name string

Parameter name

value int

Parameter value

Returns

DataParameter

AddMacro(string, string, bool)

Adds the macro to the query data parameters

public void AddMacro(string name, string value, bool addHashes = false)

Parameters

name string

Macro name

value string

Macro value

addHashes bool

If true, hash chars are added to the macro automatically, e.g. "TABLE" is converted to "##TABLE##"

AddUnique(DataParameter, bool)

Adds the parameter into the list, if the parameter already exists, defines a unique name for it.

public DataParameter AddUnique(DataParameter par, bool mergeSameParameters = true)

Parameters

par DataParameter

Parameter to add

mergeSameParameters bool

If true, the process merges the parameters with same name and value into one

Returns

DataParameter

AddUnique(string, object, bool)

Adds the parameter into the list, if the parameter already exists, defines a unique name for it.

public DataParameter AddUnique(string name, object value, bool mergeSameParameters = true)

Parameters

name string

Parameter name

value object

Parameter value

mergeSameParameters bool

If true, the process merges the parameters with same name and value into one

Returns

DataParameter

Equals(object)

Returns true if the object equals another object

public override bool Equals(object obj)

Parameters

obj object

Object to compare to

Returns

bool

Expand(string)

Expands the expression by replacing parameters with their values

public string Expand(string expression)

Parameters

expression string

Expression to expand

Returns

string

GetCompleteQueryText(string)

Gets the complete query text updated with the parameters

public string GetCompleteQueryText(string queryText)

Parameters

queryText string

Query text template

Returns

string

GetEnumerator()

Gets the enumerator.

public IEnumerator<DataParameter> GetEnumerator()

Returns

IEnumerator<DataParameter>

GetHashCode()

Provides a hashcode for the object

public override int GetHashCode()

Returns

int

GetMacros()

Gets the enumerator.

protected IEnumerable<KeyValuePair<string, string>> GetMacros()

Returns

IEnumerable<KeyValuePair<string, string>>

IncludeDataParameters(QueryDataParameters, string, bool)

Adds the data parameters to the current query parameters

public string IncludeDataParameters(QueryDataParameters addParameters, string expression, bool mergeSameParameters = true)

Parameters

addParameters QueryDataParameters

Parameters to add

expression string

Expression which refers to the parameters

mergeSameParameters bool

If true, the process merges the parameters with same name and value into one

Returns

string

ResolveMacros(string)

Resolves macros within the given query text

public string ResolveMacros(string queryText)

Parameters

queryText string

Query text template

Returns

string

ToString()

Converts the data parameter to string

public override string ToString()

Returns

string