QueryParameters Class

Query parameters container.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.QueryParameters

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 9.0.0

Syntax

public class QueryParameters

The QueryParameters type exposes the following members.

Constructors

	Name	Description
Public method	QueryParameters(QueryInfo, QueryDataParameters, QueryMacros)	Constructor.
Public method	QueryParameters(String, QueryDataParameters, QueryTypeEnum, Boolean)	Constructor.
Public method	QueryParameters(String, String, QueryDataParameters, QueryTypeEnum, Boolean, QueryMacros, String)	Constructor.

Properties

	Name	Description
Public property	AllowCache	If true, caching of the query is allowed.
Public property	ConnectionStringName	Connection string name to use
Public property	ExecutionType	Execution type.
Public property	IsNested	Indicates that this query is nested within another query as its source. This brings certain constraints such as that is cannot use CTE.
Public property	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.
Public property	Macros	Query expressions
Public property	MaxRecords	Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)
Public property	Name	Query name
Public property	Offset	Index of first record to get
Public property	Params	Query parameters.
Public property	RequiresTransaction	Requires transaction.
Public property	Text	Query text.
Public property	Type	Query type.
Public property	UseNewConnection	If true, a new connection instance is created for this query execution

Methods

	Name	Description
Public method	ResolveMacros	Resolves the query macros in Text property value.
Public method	ToString	Returns the string representation of the query parameters (Overrides Object.ToString().)