Class EntityQueryContextProvider`Abstract`

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

Hierarchy

EntityQueryContextProvider

Index

Constructors

Methods

createNestedTransactionRunner createTransactionRunner getQueryContext getQueryInterface runInNestedTransactionAsync runInTransactionAsync

Constructors

constructor

new EntityQueryContextProvider(): EntityQueryContextProvider
Returns EntityQueryContextProvider

Methods

`Protected` `Abstract` createNestedTransactionRunner

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

`Protected` `Abstract` createTransactionRunner

createTransactionRunner<T>(transactionConfig?): ((transactionScope) => Promise<T>)
Vend a transaction runner for use in runInTransactionAsync.
Type Parameters
- T
Parameters
- Optional transactionConfig: TransactionConfig
Returns ((transactionScope) => Promise<T>)
- - (transactionScope): Promise<T>
  - Vend a transaction runner for use in runInTransactionAsync.
    Parameters
    - transactionScope: ((queryInterface) => Promise<T>)
      
      (queryInterface): Promise<T>
      
      Parameters
      
      queryInterface: any
      
      Returns Promise<T>
    Returns 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, transactionScope): 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) => Promise<T>)
  
  async callback to execute within the nested transaction
  - - (innerQueryContext): Promise<T>
    - Parameters
      
      innerQueryContext: EntityNestedTransactionalQueryContext
      
      Returns Promise<T>
Returns Promise<T>
- Defined in packages/entity/src/EntityQueryContextProvider.ts:61

runInTransactionAsync

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

Class EntityQueryContextProviderAbstract

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EntityQueryContextProvider

Methods

Protected Abstract createNestedTransactionRunner

Type Parameters

T

Parameters

outerQueryInterface: any

Returns ((transactionScope) => Promise<T>)

Parameters

transactionScope: ((queryInterface) => Promise<T>)

Parameters

queryInterface: any

Returns Promise<T>

Returns Promise<T>

Protected Abstract createTransactionRunner

Type Parameters

T

Parameters

Optional transactionConfig: TransactionConfig

Returns ((transactionScope) => Promise<T>)

Parameters

transactionScope: ((queryInterface) => Promise<T>)

Parameters

queryInterface: any

Returns Promise<T>

Returns Promise<T>

getQueryContext

Returns EntityNonTransactionalQueryContext

Protected Abstract getQueryInterface

Returns any

runInNestedTransactionAsync

Type Parameters

T

Parameters

outerQueryContext: EntityTransactionalQueryContext

transactionScope: ((innerQueryContext) => Promise<T>)

Parameters

innerQueryContext: EntityNestedTransactionalQueryContext

Returns Promise<T>

Returns Promise<T>

runInTransactionAsync

Type Parameters

T

Parameters

transactionScope: ((queryContext) => Promise<T>)

Parameters

queryContext: EntityTransactionalQueryContext

Returns Promise<T>

Optional transactionConfig: TransactionConfig

Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

Class EntityQueryContextProvider`Abstract`

`Protected` `Abstract` createNestedTransactionRunner

`Protected` `Abstract` createTransactionRunner

`Optional` transactionConfig: TransactionConfig

`Protected` `Abstract` getQueryInterface

`Optional` transactionConfig: TransactionConfig