Class: BatchJobService
Hierarchy
TransactionBaseService
Copy to Clipboard↳
BatchJobService
Copy to Clipboard
Constructors
constructor
• new BatchJobService(__namedParameters
Copy to Clipboard)
Parameters
Name | Type |
---|---|
__namedParameters Copy to Clipboard | InjectedDependencies Copy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/batch-job.ts:91
Properties
__configModule__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __configModule__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• Protected
Copy to Clipboard Readonly
Copy to Clipboard __container__: any
Copy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __moduleDeclaration__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
batchJobRepository_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard batchJobRepository_: Repository
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:39
batchJobStatusMapToProps
• Protected
Copy to Clipboard batchJobStatusMapToProps: Map
Copy to Clipboard<BatchJobStatus
Copy to Clipboard, { entityColumnName
Copy to Clipboard: string
Copy to Clipboard ; eventType
Copy to Clipboard: string
Copy to Clipboard }>
Defined in
medusa/src/services/batch-job.ts:43
eventBus_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard eventBus_: EventBusService
Copy to Clipboard
Defined in
medusa/src/services/batch-job.ts:40
manager_
• Protected
Copy to Clipboard manager_: EntityManager
Copy to Clipboard
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
strategyResolver_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard strategyResolver_: StrategyResolverService
Copy to Clipboard
Defined in
medusa/src/services/batch-job.ts:41
transactionManager_
• Protected
Copy to Clipboard transactionManager_: undefined
Copy to Clipboard | EntityManager
Copy to Clipboard
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Events
▪ Static
Copy to Clipboard Readonly
Copy to Clipboard Events: Object
Copy to Clipboard
Type declaration
Name | Type |
---|---|
CANCELED Copy to Clipboard | string Copy to Clipboard |
COMPLETED Copy to Clipboard | string Copy to Clipboard |
CONFIRMED Copy to Clipboard | string Copy to Clipboard |
CREATED Copy to Clipboard | string Copy to Clipboard |
FAILED Copy to Clipboard | string Copy to Clipboard |
PRE_PROCESSED Copy to Clipboard | string Copy to Clipboard |
PROCESSING Copy to Clipboard | string Copy to Clipboard |
UPDATED Copy to Clipboard | string Copy to Clipboard |
Defined in
medusa/src/services/batch-job.ts:28
Accessors
activeManager_
• Protected
Copy to Clipboard get
Copy to Clipboard activeManager_(): EntityManager
Copy to Clipboard
Returns
EntityManager
Copy to Clipboard
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
▸ Protected
Copy to Clipboard atomicPhase_<TResult
Copy to Clipboard, TError
Copy to Clipboard>(work
Copy to Clipboard, isolationOrErrorHandler?
Copy to Clipboard, maybeErrorHandlerOrDontFail?
Copy to Clipboard): Promise
Copy to Clipboard<TResult
Copy to Clipboard>
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
Name |
---|
TResult Copy to Clipboard |
TError Copy to Clipboard |
Parameters
Name | Type | Description |
---|---|---|
work Copy to Clipboard | (transactionManager Copy to Clipboard: EntityManager Copy to Clipboard) => Promise Copy to Clipboard<TResult Copy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler? Copy to Clipboard | IsolationLevel Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | Potential error handler |
Returns
Promise
Copy to Clipboard<TResult
Copy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
cancel
▸ cancel(batchJobOrId
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:270
complete
▸ complete(batchJobOrId
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:252
confirm
▸ confirm(batchJobOrId
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:234
create
▸ create(data
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
data Copy to Clipboard | BatchJobCreateProps Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:144
listAndCount
▸ listAndCount(selector?
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<[BatchJob
Copy to Clipboard[], number
Copy to Clipboard]>
Parameters
Name | Type |
---|---|
selector Copy to Clipboard | FilterableBatchJobProps Copy to Clipboard |
config Copy to Clipboard | FindConfig Copy to Clipboard<BatchJob Copy to Clipboard> |
Returns
Promise
Copy to Clipboard<[BatchJob
Copy to Clipboard[], number
Copy to Clipboard]>
Defined in
medusa/src/services/batch-job.ts:132
prepareBatchJobForProcessing
▸ prepareBatchJobForProcessing(data
Copy to Clipboard, req
Copy to Clipboard): Promise
Copy to Clipboard<CreateBatchJobInput
Copy to Clipboard>
Parameters
Name | Type |
---|---|
data Copy to Clipboard | CreateBatchJobInput Copy to Clipboard |
req Copy to Clipboard | Request Copy to Clipboard<ParamsDictionary Copy to Clipboard, any Copy to Clipboard, any Copy to Clipboard, ParsedQs Copy to Clipboard, Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard>> |
Returns
Promise
Copy to Clipboard<CreateBatchJobInput
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:367
retrieve
▸ retrieve(batchJobId
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobId Copy to Clipboard | string Copy to Clipboard |
config Copy to Clipboard | FindConfig Copy to Clipboard<BatchJob Copy to Clipboard> |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:104
setFailed
▸ setFailed(batchJobOrId
Copy to Clipboard, error?
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
error? Copy to Clipboard | string Copy to Clipboard | BatchJobResultError Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:341
setPreProcessingDone
▸ setPreProcessingDone(batchJobOrId
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:288
setProcessing
▸ setProcessing(batchJobOrId
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:321
shouldRetryTransaction_
▸ Protected
Copy to Clipboard shouldRetryTransaction_(err
Copy to Clipboard): boolean
Copy to Clipboard
Parameters
Name | Type |
---|---|
err Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, unknown Copy to Clipboard> | { code Copy to Clipboard: string Copy to Clipboard } |
Returns
boolean
Copy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
▸ update(batchJobOrId
Copy to Clipboard, data
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
data Copy to Clipboard | Partial Copy to Clipboard<Pick Copy to Clipboard<BatchJob Copy to Clipboard, "context" Copy to Clipboard | "result" Copy to Clipboard>> |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:161
updateStatus
▸ Protected
Copy to Clipboard updateStatus(batchJobOrId
Copy to Clipboard, status
Copy to Clipboard): Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Parameters
Name | Type |
---|---|
batchJobOrId Copy to Clipboard | string Copy to Clipboard | BatchJob Copy to Clipboard |
status Copy to Clipboard | BatchJobStatus Copy to Clipboard |
Returns
Promise
Copy to Clipboard<BatchJob
Copy to Clipboard>
Defined in
medusa/src/services/batch-job.ts:200
withTransaction
▸ withTransaction(transactionManager?
Copy to Clipboard): BatchJobService
Copy to Clipboard
Parameters
Name | Type |
---|---|
transactionManager? Copy to Clipboard | EntityManager Copy to Clipboard |
Returns
BatchJobService
Copy to Clipboard
Inherited from
TransactionBaseService.withTransaction