ChainGraph API Documentation / @badaitech/chaingraph-executor / server / IExecutionStore

Interface: IExecutionStore

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:32

Properties

claimExecution()

claimExecution: (executionId, workerId, timeoutMs) => Promise<boolean>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:48

Parameters

executionId

string

workerId

string

timeoutMs

number

Returns

Promise<boolean>

---

create()

create: (instance) => Promise<void>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:33

Parameters

instance

completedAt

Date | null

createdAt

Date

errorMessage

string | null

errorNodeId

string | null

executionDepth

number

externalEvents

object[] | null

failureCount

number

flowId

string

id

string

integration

object & object | null

lastFailureAt

Date | null

lastFailureReason

string | null

options

{ breakpoints?: string[]; debug?: boolean; execution?: { flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; }; } | null

ownerId

string

parentExecutionId

string | null

processingStartedAt

Date | null

processingWorkerId

string | null

rootExecutionId

string | null

startedAt

Date | null

status

ExecutionStatus

updatedAt

Date

Returns

Promise<void>

---

delete()

delete: (id) => Promise<boolean>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:35

Parameters

id

string

Returns

Promise<boolean>

---

expireOldClaims()

expireOldClaims: () => Promise<number>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:53

Returns

Promise<number>

---

extendClaim()

extendClaim: (executionId, workerId, timeoutMs) => Promise<boolean>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:50

Parameters

executionId

string

workerId

string

timeoutMs

number

Returns

Promise<boolean>

---

get()

get: (id) => Promise<{ completedAt: Date | null; createdAt: Date; errorMessage: string | null; errorNodeId: string | null; executionDepth: number; externalEvents: object[] | null; failureCount: number; flowId: string; id: string; integration: object & object | null; lastFailureAt: Date | null; lastFailureReason: string | null; options: { breakpoints?: string[]; debug?: boolean; execution?: { flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; }; } | null; ownerId: string; parentExecutionId: string | null; processingStartedAt: Date | null; processingWorkerId: string | null; rootExecutionId: string | null; startedAt: Date | null; status: ExecutionStatus; updatedAt: Date; } | null>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:34

Parameters

id

string

Returns

Promise<{ completedAt: Date | null; createdAt: Date; errorMessage: string | null; errorNodeId: string | null; executionDepth: number; externalEvents: object[] | null; failureCount: number; flowId: string; id: string; integration: object & object | null; lastFailureAt: Date | null; lastFailureReason: string | null; options: { breakpoints?: string[]; debug?: boolean; execution?: { flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; }; } | null; ownerId: string; parentExecutionId: string | null; processingStartedAt: Date | null; processingWorkerId: string | null; rootExecutionId: string | null; startedAt: Date | null; status: ExecutionStatus; updatedAt: Date; } | null>

---

getActiveClaims()

getActiveClaims: () => Promise<ExecutionClaim[]>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:51

Returns

Promise<ExecutionClaim[]>

---

getChildExecutions()

getChildExecutions: (parentId) => Promise<object[]>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:44

Parameters

parentId

string

Returns

Promise<object[]>

---

getClaimForExecution()

getClaimForExecution: (executionId) => Promise<ExecutionClaim | null>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:52

Parameters

executionId

string

Returns

Promise<ExecutionClaim | null>

---

getExecutionsNeedingRecovery()

getExecutionsNeedingRecovery: (limit?) => Promise<object[]>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:62

Parameters

limit?

number

Returns

Promise<object[]>

---

getExecutionTree()

getExecutionTree: (rootId) => Promise<ExecutionTreeNode[]>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:45

Parameters

rootId

string

Returns

Promise<ExecutionTreeNode[]>

---

getRecoveryHistory()

getRecoveryHistory: (executionId) => Promise<object[]>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:72

Parameters

executionId

string

Returns

Promise<object[]>

---

getRootExecutions()

getRootExecutions: (flowId, limit?, after?) => Promise<RootExecution[]>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:39

Parameters

flowId

string

limit?

number

after?

Date | null

Returns

Promise<RootExecution[]>

---

recordRecovery()

recordRecovery: (executionId, workerId, reason, previousStatus?, previousWorkerId?) => Promise<void>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:64

Parameters

executionId

string

workerId

string

reason

string

previousStatus?

string

previousWorkerId?

string

Returns

Promise<void>

---

releaseExecution()

releaseExecution: (executionId, workerId) => Promise<void>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:49

Parameters

executionId

string

workerId

string

Returns

Promise<void>

---

releaseRecoveryLock()

releaseRecoveryLock: (lockId) => Promise<void>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:76

Parameters

lockId

number

Returns

Promise<void>

---

tryAcquireRecoveryLock()

tryAcquireRecoveryLock: (lockId) => Promise<boolean>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:75

Parameters

lockId

number

Returns

Promise<boolean>

---

updateExecutionStatus()

updateExecutionStatus: (params) => Promise<boolean>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:36

Parameters

params

UpdateExecutionStatusParams

Returns

Promise<boolean>

---

updateFailureInfo()

updateFailureInfo: (executionId, failureCount, reason) => Promise<boolean>

Defined in: packages/chaingraph-executor/server/stores/interfaces/IExecutionStore.ts:56

Parameters

executionId

string

failureCount

number

reason

string

Returns

Promise<boolean>