Skip to main content
Skip to main content

IBatchJobStrategy

Properties

manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
__container__anyRequired
__configModule__Record<string, unknown>
__moduleDeclaration__Record<string, unknown>

Accessors

activeManager_

Returns

EntityManagerEntityManagerRequired

Methods

prepareBatchJobForProcessing

Method for preparing a batch job for processing

Parameters

batchJobEntityCreateBatchJobInputRequired
reqRequestRequired

Returns

PromisePromise<CreateBatchJobInput>Required
Method for preparing a batch job for processing

preProcessBatchJob

Method for pre-processing a batch job

Parameters

batchJobIdstringRequired

Returns

PromisePromise<void>Required
Method for pre-processing a batch job

processJob

Method does the actual processing of the job. Should report back on the progress of the operation.

Parameters

batchJobIdstringRequired

Returns

PromisePromise<void>Required
Method does the actual processing of the job. Should report back on the progress of the operation.

buildTemplate

Builds and returns a template file that can be downloaded and filled in

Returns

PromisePromise<string>Required
Builds and returns a template file that can be downloaded and filled in

withTransaction

Parameters

transactionManagerEntityManager

Returns

thisthisRequired

shouldRetryTransaction_

Parameters

errRecord<string, unknown> | objectRequired

Returns

booleanbooleanRequired

atomicPhase_

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type Parameters

TResultobjectRequired
TErrorobjectRequired

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>
the isolation level to be used for the work.
maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>
Potential error handler

Returns

PromisePromise<TResult>Required
the result of the transactional work
Was this section helpful?