Table of Contents

Class DataQuerySource

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Base class for Data query source

public abstract class DataQuerySource
Inheritance
object
DataQuerySource
Derived
Extension Methods

Fields

CMSDATABASE

Specifies default CMS database as a source

public const string CMSDATABASE = "Database|CMSConnectionString"

Field Value

string

DATABASE_PREFIX

Specifies database as a source

public const string DATABASE_PREFIX = "Database|"

Field Value

string

MATERIALIZED

Specifies source for a materialized query within a database

public const string MATERIALIZED = "Database|MATERIALIZED"

Field Value

string

MEMORY_PREFIX

Specifies memory as a source

public const string MEMORY_PREFIX = "Memory|"

Field Value

string

Properties

ConnectionStringName

Connection string name

public string ConnectionStringName { get; }

Property Value

string

DataSourceName

Data source identifier.

public virtual string DataSourceName { get; }

Property Value

string

Remarks

Source identifiers are used to determine whether sub queries should be materialized or inserted directly into parent query.

Methods

GetConnectionStringName()

Gets the connection string name

protected virtual string GetConnectionStringName()

Returns

string

GetCount(DataQuerySourceParameters)

Returns the number of rows in the result queried by this data source if GetData is called with the same parameters

public virtual int GetCount(DataQuerySourceParameters parameters)

Parameters

parameters DataQuerySourceParameters

Source parameters

Returns

int

GetData(DataQuerySourceParameters)

Gets the data for data query

public abstract DataSet GetData(DataQuerySourceParameters parameters)

Parameters

parameters DataQuerySourceParameters

Source parameters

Returns

DataSet

GetDataSourceName()

Gets data source identifier.

protected abstract string GetDataSourceName()

Returns

string

Remarks

Source identifiers are used to determine whether sub queries should be materialized or inserted directly into parent query.