IRetrievalQuery Interface |
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
The IRetrievalQuery type exposes the following members.
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 IQuery.) | |
Connection |
The connection object to use with the Command (Inherited from IQuery.) | |
ManualRowsToSkip |
Only valid when RequiresClientSidePaging is set to true.
| |
ManualRowsToTake |
Only valid when RequiresClientSidePaging is set to true.
| |
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 |
Array list with the IParameterFieldRelation instances for the relations between IEntityFields and output parameters.
(Inherited from IQuery.) | |
Parameters |
The list of parameters used in the Command.
(Inherited from IQuery.) | |
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 set, 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 number is ignored.
|
Name | Description | |
---|---|---|
AddOutputParameterValueForSync |
Adds the output parameter value for synchronization with the enclosed DbParameter, after the query has been executed.
(Inherited from IQuery.) | |
AddParameter |
Adds the parameter to the query's command.
(Inherited from IQuery.) | |
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 IQuery.) | |
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 IQuery.) | |
AddParameters |
Adds the parameters to the query's command.
(Inherited from IQuery.) | |
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 IDisposable.) | |
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.
| |
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 IQuery.) | |
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.
(Inherited from IQuery.) | |
SetCommandText |
Sets the command text to the text specified
(Inherited from IQuery.) | |
SetCommandTimeout |
Sets the command timeout.
(Inherited from IQuery.) | |
WireTransaction |
Wires the command of this query with the transaction passed in.
(Inherited from IQuery.) |