Click or drag to resize

DaoBase Class

Base class for DAO classes which are generated.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesDaoBase

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.11.0.0 (5.11.23.1114)
Syntax
public abstract class DaoBase : IDao

The DaoBase type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyStatic memberCommandTimeOut
Gets / sets the command time out (in seconds). This is a global setting, so every Command object created after you've set this property to a value will have that value as CommandTimeOut. Default is 30 seconds which is the ADO.NET default.
Public propertyEntityFactoryToUse
Gets / sets entityFactory to use
Public propertyFunctionMappings
Gets the function mappings for the DQE related to this Dao class. These function mappings are static and therefore not changeable.
Top
Methods
  NameDescription
Public methodAddNew
Adds the given fields to the database as a new entity.
Public methodAddNewAsync
Async variant of AddNew(IEntityFields, ITransaction). Adds the given fields to the database as a new entity.
Public methodCallActionStoredProcedure
Calls the specified action stored procedure in the database. If a transaction is in progress, it will participate in that transaction.
Public methodCallActionStoredProcedureAsync
Async variant of CallActionStoredProcedure(String, DbParameter, ITransaction) Calls the specified action stored procedure in the database. If a transaction is in progress, it will participate in that transaction.
Public methodCallRetrievalStoredProcedure(String, DbParameter, DataSet, ITransaction)
Calls the specified retrieval stored procedure in the database. Fills the specified DataSet. Will participate in the transaction if a transaction is in progress.
Public methodCallRetrievalStoredProcedure(String, DbParameter, DataTable, ITransaction)
Calls the specified retrieval stored procedure in the database. Fills the specified datatable. Will participate in the transaction if a transaction is in progress.
Public methodCreateConnection
Creates a new closed ADO.NET Connection object based on the connection string read from the *.config file of the appdomain. The connection string is stored in a key with the name defined in the constant connectionKeyString
Public methodCreateConnection(String)
Creates a new ADO.NET Connection
Public methodCreateDataAdapter
Creates a new ADO.NET DataAdapter.
Public methodCreatePrimaryKeyFilter
Creates a new predicate expression which filters on the primary key fields and the set values for the given primary key fields. If no primary key fields are specified, null is returned.
Public methodCreatePrimaryKeyFilters
Creates for each entity which PK field(s) are in the passed in arraylist a new predicate expression which filters on the primary key fields of that entity and the set values for the given primary key fields. If no primary key fields are specified, null is returned.
Public methodCreateTransaction
Creates a new ADO.NET transaction
Public methodDeleteExisting
Deletes an entity from the persistent storage. Which entity is deleted is determined from the passed in EntityFields object.
Public methodDeleteExistingAsync
Async variant of DeleteExisting(IEntityFields, ITransaction, IPredicate). Deletes an entity from the persistent storage. Which entity is deleted is determined from the passed in EntityFields object.
Public methodDeleteMulti(ITransaction, IPredicate)
Deletes from the persistent storage all entities which match with the specified filter, formulated in the predicate or predicate expression definition, of the type and subtypes of the entity owning this DAO.
Public methodDeleteMulti(ITransaction, IPredicate, IRelationCollection)
Deletes from the persistent storage all 'Employee' entities which match with the specified filter, formulated in the predicate or predicate expression definition.
Public methodDeleteMultiAsync
Async variant of DeleteMulti(ITransaction, IPredicate, IRelationCollection). Deletes from the persistent storage all 'Employee' entities which match with the specified filter, formulated in the predicate or predicate expression definition.
Public methodDetermineConnectionToUse
Determines which connection to use: the connection held by the passed in transaction (if any) or a new one (if no Transaction was passed in)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteActionQuery
Executes the passed in action query and, if not null, runs it inside the passed in transaction.
Public methodExecuteActionQueryAsync
Async variant of ExecuteActionQuery(IActionQuery, ITransaction) Executes the passed in action query and, if not null, runs it inside the passed in transaction.
Public methodExecuteMultiRowDataTableRetrievalQuery(IRetrievalQuery, DbDataAdapter, IEntityFields)
Executes the passed in retrieval query and returns the results as a datatable using the passed in data-adapter.
Public methodExecuteMultiRowDataTableRetrievalQuery(IRetrievalQuery, DbDataAdapter, DataTable, IEntityFields)
Executes the passed in retrieval query and returns the results in thedatatable specified using the passed in data-adapter.
Public methodExecuteMultiRowRetrievalQuery
Executes the passed in retrieval query and, if not null, runs it inside the passed in transaction. Used to read 1 row.
Public methodExecuteScalarQuery
Executes the passed in query as a scalar query and returns the value returned from this scalar execution.
Public methodExecuteScalarQueryAsync
Async variant of ExecuteScalarQuery(IRetrievalQuery, ITransaction) Executes the passed in query as a scalar query and returns the value returned from this scalar execution.
Public methodExecuteSingleRowRetrievalQuery
Executes the passed in retrieval query and, if not null, runs it inside the passed in transaction. Used to read 1 row.
Public methodExecuteSQL
Executes the specified plain SQL query using this DAO. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery
Public methodExecuteSQLAsync(ITransaction, String, Object)
Async variant of ExecuteSQL(ITransaction, String, Object) Executes the specified plain SQL query using this DAO. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery
Public methodExecuteSQLAsync(ITransaction, CancellationToken, String, Object)
Async variant of ExecuteSQL(ITransaction, String, Object) Executes the specified plain SQL query using this DAO. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery
Public methodFetchExcludedFields(IEntity, ITransaction, ExcludeIncludeFieldsList)
Loads the data for the excluded fields specified in the list of excluded fields into the entity passed in.
Public methodFetchExcludedFields(IEntityCollection, ITransaction, ExcludeIncludeFieldsList)
Loads the data for the excluded fields specified in the list of excluded fields into all the entities in the entities collection passed in.
Public methodFetchExcludedFieldsAsync(IEntity, ITransaction, ExcludeIncludeFieldsList)
Async variant of FetchExcludedFields(IEntity, ITransaction, ExcludeIncludeFieldsList). Loads the data for the excluded fields specified in the list of excluded fields into the entity passed in.
Public methodFetchExcludedFieldsAsync(IEntityCollection, ITransaction, ExcludeIncludeFieldsList)
Async variant of FetchExcludedFields(IEntityCollection, ITransaction, ExcludeIncludeFieldsList). Loads the data for the excluded fields specified in the list of excluded fields into all the entities in the entities collection passed in.
Public methodFetchExcludedFieldsAsync(IEntity, ITransaction, ExcludeIncludeFieldsList, CancellationToken)
Async variant of FetchExcludedFields(IEntity, ITransaction, ExcludeIncludeFieldsList). Loads the data for the excluded fields specified in the list of excluded fields into the entity passed in.
Public methodFetchExcludedFieldsAsync(IEntityCollection, ITransaction, ExcludeIncludeFieldsList, CancellationToken)
Async variant of FetchExcludedFields(IEntityCollection, ITransaction, ExcludeIncludeFieldsList). Loads the data for the excluded fields specified in the list of excluded fields into all the entities in the entities collection passed in.
Public methodFetchExisting
Reads the data of an entity into the specified EntityFields object and returns that object. Which data is read is determined using the passed in Primary Key field(s). If specified, it also processes the prefetch path.
Public methodFetchExistingPolymorphic
Performs the polymorphic entity fetch for the entity type of this DAO. It will produce an entity of that type or a subtype of that type, based on the values retrieved, or an empty entity if not found. The passed in fields object has its PK fields filled, which are used to produce a PK filter.
Public methodFetchQueryT(ITransaction, String, Object)
Executes the specified plain SQL query using this DAO and projects each row in the resultset to an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery. Uses default fetch aspects.
Public methodFetchQueryT(PlainSQLFetchAspects, ITransaction, String, Object)
Executes the specified plain SQL query using this DAO and projects each row in the resultset to an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery.
Public methodFetchQueryAsyncT(ITransaction, String, Object)
Async variant of FetchQueryT(ITransaction, String, Object) Executes the specified plain SQL query using this DAO and projects each row in the resultset to an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery. Uses default fetch aspects.
Public methodFetchQueryAsyncT(ITransaction, CancellationToken, String, Object)
Async variant of FetchQueryT(ITransaction, String, Object) Executes the specified plain SQL query using this DAO and projects each row in the resultset to an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery. Uses default fetch aspects.
Public methodFetchQueryAsyncT(PlainSQLFetchAspects, ITransaction, String, Object)
Async variant of FetchQueryT(PlainSQLFetchAspects, ITransaction, String, Object) Executes the specified plain SQL query using this DAO and projects each row in the resultset to an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery.
Public methodFetchQueryAsyncT(PlainSQLFetchAspects, ITransaction, CancellationToken, String, Object)
Async variant of FetchQueryT(PlainSQLFetchAspects, ITransaction, String, Object) Executes the specified plain SQL query using this DAO and projects each row in the resultset to an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery.
Public methodFetchScalarQueryT(ITransaction, String, Object)
Executes the specified plain SQL query using this DAO and returns the first scalar value returned as an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery. Uses default fetch aspects.
Public methodFetchScalarQueryT(PlainSQLFetchAspects, ITransaction, String, Object)
Executes the specified plain SQL query using this DAO and returns the first scalar value returned as an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery.
Public methodFetchScalarQueryAsyncT(ITransaction, String, Object)
Async variant of FetchScalarQueryT(ITransaction, String, Object). Executes the specified plain SQL query using this DAO and returns the first scalar value returned as an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery. Uses default fetch aspects.
Public methodFetchScalarQueryAsyncT(CancellationToken, ITransaction, String, Object)
Async variant of FetchScalarQueryT(ITransaction, String, Object). Executes the specified plain SQL query using this DAO and returns the first scalar value returned as an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery. Uses default fetch aspects.
Public methodFetchScalarQueryAsyncT(PlainSQLFetchAspects, ITransaction, String, Object)
Async variant of FetchScalarQueryT(PlainSQLFetchAspects, ITransaction, String, Object). Executes the specified plain SQL query using this DAO and returns the first scalar value returned as an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery.
Public methodFetchScalarQueryAsyncT(CancellationToken, ITransaction, PlainSQLFetchAspects, String, Object)
Async variant of FetchScalarQueryT(PlainSQLFetchAspects, ITransaction, String, Object). Executes the specified plain SQL query using this DAO and returns the first scalar value returned as an instance of T. Every parameter value is converted into one or more parameters which have to be pre-defined in the sqlQuery.
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 methodGetAsDataReader(ITransaction, IRetrievalQuery, CommandBehavior)
Executes the passed in retrievalquery and returns an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReader(ITransaction, CommandBehavior, QueryParameters)
Creates a new Retrieval query from the elements passed in and executes that retrievalquery to return an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReader(ITransaction, IEntityFields, IPredicate, IRelationCollection, CommandBehavior, Int32, Boolean)
Creates a new Retrieval query from the elements passed in and executes that retrievalquery to return an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReader(ITransaction, IEntityFields, IPredicate, IRelationCollection, CommandBehavior, Int32, ISortExpression, Boolean)
Creates a new Retrieval query from the elements passed in and executes that retrievalquery to return an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReader(ITransaction, IEntityFields, IPredicate, IRelationCollection, CommandBehavior, Int32, ISortExpression, Boolean, Int32, Int32)
Creates a new Retrieval query from the elements passed in and executes that retrievalquery to return an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReader(ITransaction, IEntityFields, IPredicate, IRelationCollection, CommandBehavior, Int32, ISortExpression, IGroupByCollection, Boolean, Int32, Int32)
Creates a new Retrieval query from the elements passed in and executes that retrievalquery to return an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReaderAsync(ITransaction, IRetrievalQuery, CommandBehavior, CancellationToken)
Async variant of GetAsDataReader(ITransaction, IRetrievalQuery, CommandBehavior). Executes the passed in retrievalquery and returns an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsDataReaderAsync(ITransaction, CommandBehavior, QueryParameters, CancellationToken)
Async variant of GetAsDataReader(ITransaction, CommandBehavior, QueryParameters). Creates a new Retrieval query from the elements passed in and executes that retrievalquery to return an open, ready to use IDataReader. The datareader's command behavior is set to the readerBehavior passed in. If a transaction is specified, the command is wired to the transaction.
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, IDataReader)
Projects the current resultset of the passed in datareader using the value projectors and the projector specified. The reader will be left open
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, IRetrievalQuery, IDataReader)
Projects the current resultset of the passed in datareader using the value projectors and the projector specified. The reader will be left open
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IRetrievalQuery)
Executes the passed in retrievalquery and projects the resultset using the value projectors and the projector specified. IF a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, QueryParameters)
Creates a new Retrieval query from the elements passed in, executes that retrievalquery and projects the resultset of that query using the value projectors and the projector specified. If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Protected methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IRetrievalQuery, DictionaryInt32, TypeConverter)
Executes the passed in retrievalquery and projects the resultset using the value projectors and the projector specified. IF a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Protected methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IRetrievalQuery, Boolean, Boolean, DictionaryInt32, TypeConverter)
Executes the passed in retrievalquery and projects the resultset using the value projectors and the projector specified. IF a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IEntityFields, IPredicateExpression, IRelationCollection, Int32, Boolean)
Creates a new Retrieval query from the elements passed in, executes that retrievalquery and projects the resultset of that query using the value projectors and the projector specified. If a transaction is in progress, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IEntityFields, IPredicateExpression, IRelationCollection, Int32, ISortExpression, Boolean)
Creates a new Retrieval query from the elements passed in, executes that retrievalquery and projects the resultset of that query using the value projectors and the projector specified. If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IEntityFields, IPredicateExpression, IRelationCollection, Int32, ISortExpression, Boolean, Int32, Int32)
Creates a new Retrieval query from the elements passed in, executes that retrievalquery and projects the resultset of that query using the value projectors and the projector specified. If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IEntityFields, IPredicateExpression, IRelationCollection, Int32, ISortExpression, IGroupByCollection, Boolean, Int32, Int32)
Creates a new Retrieval query from the elements passed in, executes that retrievalquery and projects the resultset of that query using the value projectors and the projector specified. If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjectionT(IDataReader)
Projects the current resultset of the passed in datareader using the value projectors and the projector specified. The reader will be left open
Public methodGetAsProjectionT(IRetrievalQuery)
Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T).
Public methodGetAsProjectionT(IDataReader, IRetrievalQuery)
Projects the current resultset of the passed in datareader using the value projectors and the projector specified. The reader will be left open
Public methodGetAsProjectionT(ITransaction, IRetrievalQuery)
Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T). If a transaction is specified, the command is wired to the transaction and executed inside the transaction.
Protected methodGetAsProjectionT(ITransaction, ListT, IRetrievalQuery, Boolean)
Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T). If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the specified destination set.
Public methodGetAsProjectionAsync(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IRetrievalQuery, CancellationToken)
Async variant of GetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IRetrievalQuery) Executes the passed in retrievalquery and projects the resultset using the value projectors and the projector specified. IF a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjectionAsync(ListIDataValueProjector, IGeneralDataProjector, ITransaction, QueryParameters, CancellationToken)
Async variant of GetAsProjection(ListIDataValueProjector, IGeneralDataProjector, ITransaction, QueryParameters). Creates a new Retrieval query from the elements passed in, executes that retrievalquery and projects the resultset of that query using the value projectors and the projector specified. If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Protected methodGetAsProjectionAsync(ListIDataValueProjector, IGeneralDataProjector, ITransaction, IRetrievalQuery, Boolean, Boolean, DictionaryInt32, TypeConverter, CancellationToken)
Executes the passed in retrievalquery and projects the resultset using the value projectors and the projector specified. IF a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the projector.
Public methodGetAsProjectionAsyncT(IRetrievalQuery)
Async variant of GetAsProjectionT(IRetrievalQuery) Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T).
Public methodGetAsProjectionAsyncT(IRetrievalQuery, CancellationToken)
Async variant of GetAsProjectionT(IRetrievalQuery) Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T).
Public methodGetAsProjectionAsyncT(ITransaction, IRetrievalQuery)
Async variant of GetAsProjectionT(ITransaction, IRetrievalQuery) Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T). If a transaction is specified, the command is wired to the transaction and executed inside the transaction.
Public methodGetAsProjectionAsyncT(ITransaction, IRetrievalQuery, CancellationToken)
Async variant of GetAsProjectionT(ITransaction, IRetrievalQuery) Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T). If a transaction is specified, the command is wired to the transaction and executed inside the transaction.
Protected methodGetAsProjectionAsyncT(ITransaction, ListT, IRetrievalQuery, CancellationToken, Boolean)
Async variant of GetAsProjectionT(ITransaction, ListT, IRetrievalQuery, Boolean) Executes the passed in retrievalquery and projects the resultset onto instances of T (each row is materialized into an instance of T). If a transaction is specified, the command is wired to the transaction and executed inside the transaction. The projection results will be stored in the specified destination set.
Protected methodGetConnectionString
Gets the connection string to use
Public methodGetDbCount(IEntityFields, ITransaction, IPredicate, IRelationCollection, IGroupByCollection)
Gets the number of rows returned by a query for the fields specified, using the filter and groupby clause specified.
Public methodGetDbCount(IEntityFields, ITransaction, IPredicate, IRelationCollection, IGroupByCollection, Boolean)
Gets the number of rows returned by a query for the fields specified, using the filter and groupby clause specified.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMulti(ITransaction, IEntityFactory, QueryParameters)
Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Public methodGetMulti(ITransaction, IEntityCollection, Int64, ISortExpression, IEntityFactory, IPredicate, IRelationCollection, IPrefetchPath)
Retrieves in the calling entity collection object all entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query. It will also prefetch all related objects defined in the prefetchpath specified.
Public methodGetMulti(ITransaction, IEntityCollection, Int64, ISortExpression, IEntityFactory, IPredicate, IRelationCollection, Int32, Int32)
Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Public methodGetMulti(ITransaction, IEntityCollection, Int64, ISortExpression, IEntityFactory, IPredicate, IRelationCollection, IPrefetchPath, Int32, Int32)
Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Public methodGetMulti(ITransaction, IEntityCollection, Int64, ISortExpression, IEntityFactory, IPredicate, IRelationCollection, IPrefetchPath, ExcludeIncludeFieldsList, Int32, Int32)
Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Public methodGetMultiAsDataTable(ISortExpression, IPredicate, IRelationCollection)
Retrieves entities of the type this dao is for in a datatable which match the specified filter. It will always create a new connection to the database.
Public methodGetMultiAsDataTable(IEntityFields, DataTable, IRetrievalQuery, ITransaction)
Retrieves the results of the query specified into the tableToFill.
Public methodGetMultiAsDataTable(Int64, ISortExpression, IPredicate, IRelationCollection, Int32, Int32)
Retrieves entities of the type this dao is for in a datatable which match the specified filter. It will always create a new connection to the database.
Public methodGetMultiAsDataTable(Int64, ISortExpression, IPredicate, IRelationCollection, ITransaction, Int32, Int32)
Retrieves entities of the type this dao is for in a datatable which match the specified filter. It will always create a new connection to the database.
Public methodGetMultiAsDataTable(IEntityFields, DataTable, ISortExpression, IPredicate, IRelationCollection, Boolean, ITransaction)
Retrieves rows in the datatable provided which match the specified filter, containing the fields specified. It will always create a new connection to the database.
Public methodGetMultiAsDataTable(IEntityFields, DataTable, Int64, ISortExpression, IPredicate, IRelationCollection, Boolean, IGroupByCollection, ITransaction, Int32, Int32)
Retrieves rows in the datatable provided which match the specified filter, containing the fields specified. It will always create a new connection to the database.
Public methodGetMultiAsync
Async variant of GetMulti(ITransaction, IEntityFactory, QueryParameters). Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Public methodGetScalar(IEntityFields, ITransaction, IPredicate, IRelationCollection, IGroupByCollection)
Executes the expression defined with the field in the fields collection specified, using the various elements defined. The expression is executed as a scalar query and a single value is returned.
Public methodGetScalar(IEntityFields, ITransaction, IPredicate, IRelationCollection, IGroupByCollection, Boolean)
Executes the expression defined with the field in the fields collection specified, using the various elements defined. The expression is executed as a scalar query and a single value is returned.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleValueReadErrors
Routine which is meant to handle value read errors when GetValues is called on the passed in reader. This routine is only called when the GetValues() method on the passed in reader throws an exception. Implementors of this routine thus have to call different methods to retrieve the values for the current row. The data has to be read into the toFill array.
Public methodInsertMulti
Inserts all rows matching the select query into the target of the entity type this DAO is for. Which fields are inserted is defined by the select query. Sequenced fields are taken care of if they're not specified in the select query. This method will result in an INSERT INTO entityTarget (field1, field2...) SELECT ... statement.
Public methodInsertMultiAsync
Async variant of InsertMulti(ITransaction, DynamicQuery) Inserts all rows matching the select query into the target of the entity type this DAO is for. Which fields are inserted is defined by the select query. Sequenced fields are taken care of if they're not specified in the select query. This method will result in an INSERT INTO entityTarget (field1, field2...) SELECT ... statement.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformExecuteSingleRowRetrievalQuery
Performs the execute single row retrieval query action. This method simply calls Execute on the queryToExecute passed in.
Public methodPerformFetchEntityAction
Reads the data of the entity passed in, and returns that object. Which data is read is determined using the set Primary Key field(s). If specified, it also processes the prefetch path.
Protected methodPerformGetMultiAction(ITransaction, QueryParameters)
Retrieves in the passed in entity collection object all entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Protected methodPerformGetMultiAction(ITransaction, IEntityCollection, Int64, ISortExpression, IPredicate, IRelationCollection, IPrefetchPath, ExcludeIncludeFieldsList, Int32, Int32)
Retrieves in the passed in entity collection object all entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Protected methodPerformGetMultiActionAsync
Retrieves in the passed in entity collection object all entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Protected methodPerformPolymorphicEntityFetch
Performs the polymorphic entity fetch for the entity type of this DAO. It will produce an entity of that type or a subtype of that type, based on the values retrieved, or an empty entity if not found. The passed in filter, is a filter to be used to filter out the entity to fetch.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateExisting(IEntityFields, ITransaction)
Updates an existing entity using the given fields.
Public methodUpdateExisting(IEntityFields, ITransaction, IPredicate)
Updates an existing entity using the given fields.
Public methodUpdateExistingAsync
Async variant of UpdateExisting(IEntityFields, ITransaction, IPredicate). Updates an existing entity using the given fields.
Public methodUpdateMulti(IEntity, ITransaction, IPredicate)
Updates all entities of the same type or subtype of the entity entityWithNewValues directly in the persistent storage if they match the filter supplied in filterBucket. Only the fields changed in entityWithNewValues are updated for these fields. Entities of a subtype of the type of entityWithNewValues which are affected by the filterBucket's filter will thus also be updated.
Public methodUpdateMulti(IEntity, ITransaction, IPredicate, IRelationCollection)
Updates all entities of the same type or subtype of the entity entityWithNewValues directly in the persistent storage if they match the filter supplied in filterBucket. Only the fields changed in entityWithNewValues are updated for these fields. Entities of a subtype of the type of entityWithNewValues which are affected by the filterBucket's filter will thus also be updated.
Public methodUpdateMultiAsync
Async variant of UpdateMulti(IEntity, ITransaction, IPredicate, IRelationCollection). Updates all entities of the same type or subtype of the entity entityWithNewValues directly in the persistent storage if they match the filter supplied in filterBucket. Only the fields changed in entityWithNewValues are updated for these fields. Entities of a subtype of the type of entityWithNewValues which are affected by the filterBucket's filter will thus also be updated.
Top
Fields
  NameDescription
Public fieldStatic memberParameterisedPrefetchPathThreshold
The parameterised prefetch path threshold. This threshold is used to determine when the prefetch path logic should switch to a subquery or when it should use a WHERE field IN (value1, value2, ... valueN) construct, based on the # of elements in the parent collection. If that # of elements exceeds this threshold, a subquery is constructed, otherwise field IN (value1, value2, ...) construct is used. The default value is 50. On average, this is faster than using a subquery which returns 50 elements. Use this to tune prefetch path fetch logic for your particular needs.

This threshold is also used to determine if paging is possible. A page size bigger than this threshold will disable the paging functionality when using paging + prefetch paths.
Top
Extension Methods
  NameDescription
Public Extension MethodFetchAsDataReader
Fetches the query as an open data reader.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataReaderAsync(ITransaction, DynamicQuery, CommandBehavior)Overloaded.
Async variant of FetchAsDataReader(IDao, ITransaction, DynamicQuery, CommandBehavior). Fetches the query as an open data reader.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataReaderAsync(ITransaction, DynamicQuery, CommandBehavior, CancellationToken)Overloaded.
Async variant of FetchAsDataReader(IDao, ITransaction, DynamicQuery, CommandBehavior). Fetches the query as an open data reader.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTable(DynamicQuery)Overloaded.
Fetches the specified query into a new DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTable(DynamicQuery, ITransaction)Overloaded.
Fetches the specified query into a new DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTable(DynamicQuery, DataTable)Overloaded.
Fetches the specified query into the DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTable(DynamicQuery, DataTable, ITransaction)Overloaded.
Fetches the specified query into the DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery). Fetches the specified query into a new DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, ITransaction)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery, ITransaction). Fetches the specified query into a new DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, DataTable)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery, DataTable). Fetches the specified query into the DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, CancellationToken)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery). Fetches the specified query into a new DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, DataTable, ITransaction)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery, DataTable, ITransaction). Fetches the specified query into the DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, ITransaction, CancellationToken)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery, ITransaction). Fetches the specified query into a new DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, DataTable, CancellationToken)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery, DataTable). Fetches the specified query into the DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsDataTableAsync(DynamicQuery, DataTable, ITransaction, CancellationToken)Overloaded.
Async variant of FetchAsDataTable(IDao, DynamicQuery, DataTable, ITransaction). Fetches the specified query into the DataTable specified and returns that datatable.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsProjection
Fetches the query as a projection, using the projector specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsProjectionAsync(ITransaction, DynamicQuery, IGeneralDataProjector)Overloaded.
Async variant of FetchAsProjection(IDao, ITransaction, DynamicQuery, IGeneralDataProjector). Fetches the query as a projection, using the projector specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchAsProjectionAsync(ITransaction, DynamicQuery, IGeneralDataProjector, CancellationToken)Overloaded.
Async variant of FetchAsProjection(IDao, ITransaction, DynamicQuery, IGeneralDataProjector). Fetches the query as a projection, using the projector specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQuery(DynamicQuery)Overloaded.
Fetches the query specified and returns the results in plain object arrays, one object array per returned row of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQuery(DynamicQuery, ITransaction)Overloaded.
Fetches the query specified and returns the results in plain object arrays, one object array per returned row of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryTElement(DynamicQueryTElement)Overloaded.
Fetches the query specified and returns the results in a list of TElement objects, which are created using the projectorFunc of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryTElement(DynamicQueryTElement, ITransaction)Overloaded.
Fetches the query specified and returns the results in a list of TElement objects, which are created using the projectorFunc of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsync(DynamicQuery)Overloaded.
Async variant of FetchQuery(IDao, DynamicQuery). Fetches the query specified and returns the results in plain object arrays, one object array per returned row of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsync(DynamicQuery, CancellationToken)Overloaded.
Async variant of FetchQuery(IDao, DynamicQuery). Fetches the query specified and returns the results in plain object arrays, one object array per returned row of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsync(DynamicQuery, ITransaction)Overloaded.
Async variant of FetchQuery(IDao, DynamicQuery, ITransaction). Fetches the query specified and returns the results in plain object arrays, one object array per returned row of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsync(DynamicQuery, ITransaction, CancellationToken)Overloaded.
Async variant of FetchQuery(IDao, DynamicQuery, ITransaction). Fetches the query specified and returns the results in plain object arrays, one object array per returned row of the query specified.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsyncTElement(DynamicQueryTElement)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsyncTElement(DynamicQueryTElement, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsyncTElement(DynamicQueryTElement, ITransaction)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryAsyncTElement(DynamicQueryTElement, ITransaction, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryFromSourceTElement(DynamicQueryTElement, IRetrievalQuery)Overloaded.
Fetches the query which projection specified from the source query specified. Typically used to fetch a typed view from a stored procedure source.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryFromSourceTElement(DynamicQueryTElement, IRetrievalQuery, ITransaction)Overloaded.
Fetches the query which projection specified from the source query specified. Typically used to fetch a typed view from a stored procedure source.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryFromSourceAsyncTElement(DynamicQueryTElement, IRetrievalQuery)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryFromSourceAsyncTElement(DynamicQueryTElement, IRetrievalQuery, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryFromSourceAsyncTElement(DynamicQueryTElement, IRetrievalQuery, ITransaction)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodFetchQueryFromSourceAsyncTElement(DynamicQueryTElement, IRetrievalQuery, ITransaction, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetFirstT(DynamicQueryT)Overloaded.
Fetches the first object of the set returned by the query and returns that object, if any, otherwise null.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetFirstT(DynamicQueryT, ITransaction)Overloaded.
Fetches the first object of the set returned by the query and returns that object, if any, otherwise null.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetFirstAsyncT(DynamicQueryT)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetFirstAsyncT(DynamicQueryT, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetFirstAsyncT(DynamicQueryT, ITransaction)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetFirstAsyncT(DynamicQueryT, ITransaction, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetScalarTValue(DynamicQuery)Overloaded.
Fetches a scalar value using the query specified, and returns this value typed as TValue, using a cast. The query specified will be converted to a scalar query prior to execution.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetScalarTValue(DynamicQuery, ITransaction)Overloaded.
Fetches a scalar value using the query specified, and returns this value typed as TValue, using a cast. The query specified will be converted to a scalar query prior to execution.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetScalarAsyncTValue(DynamicQuery)Overloaded.
Async variant of GetScalarTValue(IDao, DynamicQuery). Fetches a scalar value using the query specified, and returns this value typed as TValue, using a cast. The query specified will be converted to a scalar query prior to execution.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetScalarAsyncTValue(DynamicQuery, ITransaction)Overloaded.
Async variant of GetScalarTValue(IDao, DynamicQuery, ITransaction). Fetches a scalar value using the query specified, and returns this value typed as TValue, using a cast. The query specified will be converted to a scalar query prior to execution.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetScalarAsyncTValue(DynamicQuery, CancellationToken)Overloaded.
Async variant of GetScalarTValue(IDao, DynamicQuery). Fetches a scalar value using the query specified, and returns this value typed as TValue, using a cast. The query specified will be converted to a scalar query prior to execution.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetScalarAsyncTValue(DynamicQuery, ITransaction, CancellationToken)Overloaded.
Async variant of GetScalarTValue(IDao, DynamicQuery, ITransaction). Fetches a scalar value using the query specified, and returns this value typed as TValue, using a cast. The query specified will be converted to a scalar query prior to execution.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetSingleT(DynamicQueryT)Overloaded.
Fetches the single object of the set returned by the query and returns that object. If there are no elements or more than 1 element, a NotSupportedException will be thrown.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetSingleT(DynamicQueryT, ITransaction)Overloaded.
Fetches the single object of the set returned by the query and returns that object. If there are no elements or more than 1 element, a NotSupportedException will be thrown.
(Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetSingleAsyncT(DynamicQueryT)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetSingleAsyncT(DynamicQueryT, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetSingleAsyncT(DynamicQueryT, ITransaction)Overloaded. (Defined by SelfServicingExtensionMethods.)
Public Extension MethodGetSingleAsyncT(DynamicQueryT, ITransaction, CancellationToken)Overloaded. (Defined by SelfServicingExtensionMethods.)
Top
See Also