Click or drag to resize

QueryParameters Class

Bucket class which contains all the parameters for formulating a set fetch query.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesQueryParameters

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.5.0.0 (5.5.18.1019)
Syntax
public class QueryParameters

The QueryParameters type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAliasesOfEntitiesAlreadyTypeFiltered
Gets or sets the aliases of entities already type filtered. The aliases in this set have already received a type filter, and all fields with the same alias can be skipped for type filtering in the pipeline further. Can be null.
Public propertyAllowDuplicates
Gets or sets a value indicating whether [allow duplicates].
Public propertyCacheDuration
Gets or sets how long the resulset as a cached resultset should be placed in the cache.
Public propertyCacheResultset
Gets or sets a value indicating whether the resultset should be cached.
Public propertyCacheTag
Gets or sets the tag the resultset should be cached under. By default this is the empty string (no tag)
Public propertyCollectionToFetch
Gets or sets the collection to fetch.
Public propertyExcludedIncludedFields
Gets or sets the excluded / included fields list.
Public propertyFieldPersistenceInfosForQuery
Gets or sets the field persistence infos for query.
Public propertyFieldsForQuery
Gets or sets the fields for query. To obtain an array for query production, always call FieldsForQueryAsArray, as this property will return null if this instance was created with the CTor accepting an array of fields.
Public propertyFieldsForQueryAsArray
Gets the fields for the query as an array. This is equivalent to calling GetAsEntityFieldCoreArray on FieldsForQuery, however this property will cache the results and will return the same array every time.
Public propertyFilterRelationsAsBucket
Gets the filter + relations as bucket.
Public propertyFilterSpecified
Gets whether there is a predicate expression specified as filter and if so that it contains elements (true) or not (false).
Public propertyFilterToUse
Gets or sets the filter to use.
Public propertyFilterToUseAsPredicateExpression
Gets the FilterToUse as predicate expression.
Public propertyGroupBySpecified
Gets whether there are group by elements specified in this parameters object (true) or not (false)
Public propertyGroupByToUse
Gets or sets the group by to use.
Public propertyIsLocalCopy
Gets or sets a value indicating whether this instance is a local copy. If true, it's ok to modify it along the way to a query.
Public propertyOverwriteIfPresent
if set to true it will replace an existing cached set with the one specified.
Public propertyPerformValueProjectionsOnRawRow
if set to true the projection method will perform value projections on the plain row prior to using it in the projector and will create a new object row to store the projected values in. If false, the plain row is passed on as-is
Public propertyPostProcessDBNullValues
if set to true it will perform a DBNull to null conversion on the row passed to the projector. Only specify this to true if the projector deals with object arrays to the outside. In all other cases make the projectors already convert the DBNull values.
Public propertyPrefetchPathToUse
Gets or sets the prefetch path to use.
Public propertyQueryHints
Gets / sets the set of query hints to be used for the query created from these parameters. Can be empty.
Public propertyQueryTag
The optional tag for the SQL query/queries to relate SQL strings in an RDBMS with an origin.
Public propertyRelationsSpecified
Gets whether there are relations specified in this parameters object (true) or not (false)
Public propertyRelationsToUse
Gets or sets the relations to use.
Public propertyRowsToSkip
Gets or sets the rows to skip.
Public propertyRowsToTake
Gets or sets the rows to take.
Public propertySortClauseSpecified
Gets whether there are sort clauses specified in this parameters object (true) or not (false)
Public propertySorterToUse
Gets or sets the sorter to use.
Public propertyUnionedQueries
The query parameters of the queries which are unioned with the query represented by this query.
Public propertyUnionedQueriesSpecified
Gets whether there is at least one unioned query specified (true) or not (false).
Top
Methods
  NameDescription
Public methodClone
Clones this instance.
Public methodClone(Boolean)
Clones this instance using a memberwise clone and also creates usable clones inside the clone returned of the relations and filtertouse objects, so the original can be re-used.
Public methodDetermineTypeConvertersToRun
Determines the type converters to run during a projection fetch.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetCreator
Sets the dbspecific creator property for the elements inside this object which need it. If creator is null, the creator property is reset for these elements
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also