Class PostgresEntityQueryContextProvider

Query context provider for knex (postgres).

Hierarchy

default
- PostgresEntityQueryContextProvider

Index

Constructors

constructor

new PostgresEntityQueryContextProvider(knexInstance): PostgresEntityQueryContextProvider
Parameters
- knexInstance: Knex<any, any[]>
Returns PostgresEntityQueryContextProvider
Overrides EntityQueryContextProvider.constructor
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityQueryContextProvider.ts:12

Properties

`Private` `Readonly` knexInstance

knexInstance: Knex<any, any[]>

Methods

`Protected` 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>
Overrides EntityQueryContextProvider.createNestedTransactionRunner
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityQueryContextProvider.ts:32

`Protected` createTransactionRunner

createTransactionRunner<T>(transactionConfig?): ((transactionScope) => Promise<T>)
Type Parameters
- T
Parameters
- Optional transactionConfig: TransactionConfig
Returns ((transactionScope) => Promise<T>)
- - (transactionScope): Promise<T>
  - Parameters
    - transactionScope: ((trx) => Promise<T>)
      
      (trx): Promise<T>
      
      Parameters
      
      trx: any
      
      Returns Promise<T>
    Returns Promise<T>
Overrides EntityQueryContextProvider.createTransactionRunner
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityQueryContextProvider.ts:20

getQueryContext

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

Returns EntityNonTransactionalQueryContext
Inherited from EntityQueryContextProvider.getQueryContext
- Defined in packages/entity/build/EntityQueryContextProvider.d.ts:9

`Protected` getQueryInterface

getQueryInterface(): any
Returns any
Overrides EntityQueryContextProvider.getQueryInterface
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityQueryContextProvider.ts:16

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>
Inherited from EntityQueryContextProvider.runInNestedTransactionAsync
- Defined in packages/entity/build/EntityQueryContextProvider.d.ts:30

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>
Inherited from EntityQueryContextProvider.runInTransactionAsync
- Defined in packages/entity/build/EntityQueryContextProvider.d.ts:23

`Static` `Private` convertTransactionConfig

convertTransactionConfig(transactionConfig): TransactionConfig
Parameters
- transactionConfig: TransactionConfig
Returns TransactionConfig
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityQueryContextProvider.ts:38

Class PostgresEntityQueryContextProvider

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

knexInstance: Knex<any, any[]>

Returns PostgresEntityQueryContextProvider

Properties

Private Readonly knexInstance

Methods

Protected 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 createTransactionRunner

Type Parameters

T

Parameters

Optional transactionConfig: TransactionConfig

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

Parameters

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

Parameters

trx: any

Returns Promise<T>

Returns Promise<T>

getQueryContext

Returns EntityNonTransactionalQueryContext

Protected 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>

Static Private convertTransactionConfig

Parameters

transactionConfig: TransactionConfig

Returns TransactionConfig

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` knexInstance

`Protected` createNestedTransactionRunner

`Protected` createTransactionRunner

`Optional` transactionConfig: TransactionConfig

`Protected` getQueryInterface

`Optional` transactionConfig: TransactionConfig

`Static` `Private` convertTransactionConfig