Class EntityQueryContextProvider`Abstract`

A query context provider vends transactional and non-transactional query contexts.

Hierarchy (View Summary)

EntityQueryContextProvider
- PostgresEntityQueryContextProvider
- StubQueryContextProvider

Index

Constructors

Methods

createNestedTransactionRunner createTransactionRunner getQueryContext getQueryInterface runInNestedTransactionAsync runInTransactionAsync

Constructors

constructor

new EntityQueryContextProvider(): EntityQueryContextProvider
Returns EntityQueryContextProvider

Methods

`Protected` `Abstract`createNestedTransactionRunner

createNestedTransactionRunner<T>(
outerQueryInterface: any,
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T>
Type Parameters
- T
Parameters
- outerQueryInterface: any
Returns (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T>
- Defined in packages/entity/src/EntityQueryContextProvider.ts:31

`Protected` `Abstract`createTransactionRunner

createTransactionRunner<T>(
transactionConfig?: TransactionConfig,
): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T>
Vend a transaction runner for use in runInTransactionAsync.
Type Parameters
- T
Parameters
- OptionaltransactionConfig: TransactionConfig
Returns (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T>
- Defined in packages/entity/src/EntityQueryContextProvider.ts:27

getQueryContext

getQueryContext(): EntityNonTransactionalQueryContext
Vend a regular (non-transactional) entity query context.

Returns EntityNonTransactionalQueryContext
- Defined in packages/entity/src/EntityQueryContextProvider.ts:15

`Protected` `Abstract`getQueryInterface

getQueryInterface(): any
Get the query interface for constructing a query context.

Returns any
- Defined in packages/entity/src/EntityQueryContextProvider.ts:22

runInNestedTransactionAsync

runInNestedTransactionAsync<T>(
    outerQueryContext: EntityTransactionalQueryContext,
    transactionScope: (
        innerQueryContext: EntityNestedTransactionalQueryContext,
    ) => Promise<T>,
): Promise<T>
Start a nested transaction from the specified parent transaction and execure the provided nested-transaction-scoped closure within the nested transaction.
Type Parameters
- T
Parameters
- outerQueryContext: EntityTransactionalQueryContext
  the query context of the parent transaction
- transactionScope: (innerQueryContext: EntityNestedTransactionalQueryContext) => Promise<T>
  async callback to execute within the nested transaction
Returns Promise<T>
- Defined in packages/entity/src/EntityQueryContextProvider.ts:61

runInTransactionAsync

runInTransactionAsync<T>(
    transactionScope: (
        queryContext: EntityTransactionalQueryContext,
    ) => Promise<T>,
    transactionConfig?: TransactionConfig,
): Promise<T>
Start a transaction and execute the provided transaction-scoped closure within the transaction.
Type Parameters
- T
Parameters
- transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
  async callback to execute within the transaction
- OptionaltransactionConfig: TransactionConfig
Returns Promise<T>
- Defined in packages/entity/src/EntityQueryContextProvider.ts:39