Interface WorkQueueTransactionalExecutor

An executor whose statements can join a provider-arbitrated transaction.

interface WorkQueueTransactionalExecutor {
    Dialect: SQLDialect;
    MJCoreSchemaName: string;
    PlatformKey: DatabasePlatform;
    BeginEntityTransaction(): Promise<EntityTransactionScope>;
    BuildParameterPlaceholder(index: number): string;
    ExecuteSQL<T>(
        sql: string,
        parameters?: SqlParam[],
        options?: ExecuteSQLOptions,
        contextUser?: UserInfo,
    ): Promise<T[]>;
    QuoteIdentifier(name: string): string;
    RunAfterCommit?(
        task: () => void | Promise<void>,
        description?: string,
    ): void;
}

Hierarchy (View Summary)

WorkQueueSqlExecutor
- WorkQueueTransactionalExecutor
  - WorkQueueIndependentExecutor
  - WorkQueueExecutorSource

Index

Properties

Dialect MJCoreSchemaName PlatformKey

Methods

BeginEntityTransaction BuildParameterPlaceholder ExecuteSQL QuoteIdentifier RunAfterCommit?

Properties

`Readonly`Dialect

Dialect: SQLDialect

`Readonly`MJCoreSchemaName

MJCoreSchemaName: string

`Readonly`PlatformKey

PlatformKey: DatabasePlatform

Methods

BeginEntityTransaction

BeginEntityTransaction(): Promise<EntityTransactionScope>
Returns Promise<EntityTransactionScope>
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlExecutor.ts:24

BuildParameterPlaceholder

BuildParameterPlaceholder(index: number): string
Parameters
- index: number
Returns string
Inherited from WorkQueueSqlExecutor.BuildParameterPlaceholder
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlExecutor.ts:18

ExecuteSQL

ExecuteSQL<T>(
    sql: string,
    parameters?: SqlParam[],
    options?: ExecuteSQLOptions,
    contextUser?: UserInfo,
): Promise<T[]>
Type Parameters
- T
Parameters
- sql: string
- Optionalparameters: SqlParam[]
- Optionaloptions: ExecuteSQLOptions
- OptionalcontextUser: UserInfo
Returns Promise<T[]>
Inherited from WorkQueueSqlExecutor.ExecuteSQL
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlExecutor.ts:19

QuoteIdentifier

QuoteIdentifier(name: string): string
Parameters
- name: string
Returns string
Inherited from WorkQueueSqlExecutor.QuoteIdentifier
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlExecutor.ts:17

`Optional`RunAfterCommit

RunAfterCommit?(task: () => void | Promise<void>, description?: string): void
Optional post-commit queue (implemented by DatabaseProviderBase / GenericDatabaseProvider).
Parameters
- task: () => void | Promise<void>
- Optionaldescription: string
Returns void
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlExecutor.ts:26