RetrievalQuery Class

Implementation of the RetrievalQuery class.

Inheritance Hierarchy

SystemObject
SD.LLBLGen.Pro.ORMSupportClassesQuery
SD.LLBLGen.Pro.ORMSupportClassesRetrievalQuery

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

[SerializableAttribute]
public class RetrievalQuery : Query, 
	IRetrievalQuery, IQuery, IDisposable

<SerializableAttribute>
Public Class RetrievalQuery
	Inherits Query
	Implements IRetrievalQuery, IQuery, IDisposable

The RetrievalQuery type exposes the following members.

Constructors

	Name	Description
	RetrievalQuery(DbCommand)	CTor
	RetrievalQuery(DbConnection, DbCommand)	CTor

Top

Properties

	Name	Description
	CacheDuration	Gets or sets how long the resulset as a cached resultset should be placed in the cache.
	CacheResultset	Gets or sets a value indicating whether the resultset should be cached.
	CacheTag	Gets or sets the tag the resultset should be cached under. By default this is the empty string (no tag)
	Command	The command used for this query. (Inherited from Query.)
	Connection	The connection object to use with the Command (Inherited from Query.)
	ManualRowsToSkip	Only valid when RequiresClientSidePaging is set to true. Required to calculate the actual page start.
	ManualRowsToTake	Only valid when RequiresClientSidePaging is set to true. Required to calculate the actual page start.
	NoNameOverwriting	Gets a value indicating whether name overwriting has to take place (false) or not (true). Is true when this query was created from a proc call where name overwriting was already applied.
	OverwriteIfPresent	if set to true it will replace an existing cached set with the one specified.
	ParameterFieldRelations	List with the IParameterFieldRelation instances for the relations between entity fields and output parameters. (Inherited from Query.)
	Parameters	The list of parameters used in the Command. (Inherited from Query.)
	QueryTag	Gets or sets the optional tag for the SQL query/queries to relate SQL strings in an RDBMS with an origin.
	RequiresClientSideDistinctFiltering	Flag to tell the object fetcher to use manual distinct filtering, as the DISTINCT command couldn't be applied. Used to tell paging wrappers to set RequiresClientSidePaging.
	RequiresClientSideLimitation	Gets / sets the flag which signals fetch code to use client side (i.e. in code) limitation logic and it should not rely on the amount of rows returned for row limitations. This flag is set by DQEs if DISTINCT can't be used but row limitations are required and TOP is thus not reliable. Default: false. If true, ManualRowsToTake is the amount to read.
	RequiresClientSidePaging	Flag to tell the object fetcher to use manual paging. This is required when DISTINCT is required however due to DISTINCT violating types it can't be applied to the query. This then causes duplicates in the resultset, which shouldn't be there and thus causing pages with much lesser data. Only set by a DQE, normally false.
	ResultsetNumber	Gets or sets the resultset number to retrieve. This is a 1-based number (so first resultset is numbered '1', which is also the default). If set to 2 or higher, Execute will call NextResult() on the datareader till the required resultset is reached or NextResult returns false. If set to 0 or lower, the value is ignored.

Top

Methods

	Name	Description
	AddOutputParameterValueForSync	Adds the output parameter value for synchronization with the enclosed DbParameter, after the query has been executed. (Inherited from Query.)
	AddParameter	Adds the parameter to the query's command. (Inherited from Query.)
	AddParameterFieldRelation(IEntityFieldCore, DbParameter, TypeConverter)	Adds a new IParameterFieldRelation to the collection of ParameterFieldRelations. An output parameter can be stored once in the collection. (Inherited from Query.)
	AddParameterFieldRelation(IEntityFieldCore, DbParameter, TypeConverter, Boolean)	Adds a new IParameterFieldRelation to the collection of ParameterFieldRelations. An output parameter can be stored once in the collection. (Inherited from Query.)
	AddParameters	Adds the parameters to the query's command. (Inherited from Query.)
	CacheCurrentRow	Caches the current row of the datareader as-is in the cached resultset.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from Query.)
	Dispose(Boolean)	Performs the dispose action. (Inherited from Query.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	Executes the query contained by the IQuery instance. The connection has to be opened before calling Execute().
	ExecuteAsync	Async variant of Execute(CommandBehavior). Executes the query contained by the IQuery instance. The connection has to be opened before calling Execute().
	ExecuteScalar	Executes the query contained by the IQuery instance as a scalar query.
	ExecuteScalarAsync	Async variant of ExecuteScalar. Executes the query contained by the IQuery instance as a scalar query.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetExceptionInfo	Gets the exception info using the info retriever set to this query object. (Inherited from Query.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadComplete	Called when the consumer is done with the resultset read. Call this method to signal that the retrievalquery can cache its resultset, if required.
	ReflectOutputValuesInParameterValues	Reflects the output values of output parameters in parameter values, if any. (Inherited from Query.)
	ReflectOutputValuesInRelatedFields	Will walk all IParameterFieldRelation instances of this query and reflect the parameter values in the related fields. Only output parameters are taken into account. Used by Insert queries which retrieve Identity / sequence values back from the database after a succesful insert. (Inherited from Query.)
	SetCommandText	Sets the command text to the text specified (Inherited from Query.)
	SetCommandTimeout	Sets the command timeout. (Inherited from Query.)
	ToString	Overloaded ToString implementation (Inherited from Query.)
	ToString(Boolean)	Overloaded ToString implementation (Overrides QueryToString(Boolean).)
	WireTransaction	Wires the command of this query with the transaction passed in. (Inherited from Query.)

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace