dag-core / Exports / IStoragePort

Interface: IStoragePort

Primary persistence port for DAG definitions, runs, and task runs.

Table of contents

Methods

• saveDefinition
• getDefinition
• listDefinitions
• listDefinitionsByDagId
• getLatestPublishedDefinition
• createDagRun
• getDagRun
• listDagRuns
• getDagRunByRunKey
• updateDagRunStatus
• deleteDagRun
• createTaskRun
• getTaskRun
• listTaskRunsByDagRunId
• deleteTaskRunsByDagRunId
• updateTaskRunStatus
• saveTaskRunSnapshots
• incrementTaskAttempt
• deleteDefinition

Methods

saveDefinition

▸ saveDefinition(definition): Promise<void>

Parameters

Name	Type
definition	IDagDefinition

Returns

Promise<void>

Defined in

interfaces/ports.ts:82

---

getDefinition

▸ getDefinition(dagId, version): Promise<undefined | IDagDefinition>

Parameters

Name	Type
dagId	string
version	number

Returns

Promise<undefined | IDagDefinition>

Defined in

interfaces/ports.ts:83

---

listDefinitions

▸ listDefinitions(): Promise<IDagDefinition[]>

Returns

Promise<IDagDefinition[]>

Defined in

interfaces/ports.ts:84

---

listDefinitionsByDagId

▸ listDefinitionsByDagId(dagId): Promise<IDagDefinition[]>

Parameters

Name	Type
dagId	string

Returns

Promise<IDagDefinition[]>

Defined in

interfaces/ports.ts:85

---

getLatestPublishedDefinition

▸ getLatestPublishedDefinition(dagId): Promise<undefined | IDagDefinition>

Parameters

Name	Type
dagId	string

Returns

Promise<undefined | IDagDefinition>

Defined in

interfaces/ports.ts:86

---

createDagRun

▸ createDagRun(dagRun): Promise<void>

Parameters

Name	Type
dagRun	IDagRun

Returns

Promise<void>

Defined in

interfaces/ports.ts:88

---

getDagRun

▸ getDagRun(dagRunId): Promise<undefined | IDagRun>

Parameters

Name	Type
dagRunId	string

Returns

Promise<undefined | IDagRun>

Defined in

interfaces/ports.ts:89

---

listDagRuns

▸ listDagRuns(): Promise<IDagRun[]>

Returns

Promise<IDagRun[]>

Defined in

interfaces/ports.ts:90

---

getDagRunByRunKey

▸ getDagRunByRunKey(runKey): Promise<undefined | IDagRun>

Parameters

Name	Type
runKey	string

Returns

Promise<undefined | IDagRun>

Defined in

interfaces/ports.ts:91

---

updateDagRunStatus

▸ updateDagRunStatus(dagRunId, status, endedAt?): Promise<void>

Parameters

Name	Type
dagRunId	string
status	TDagRunStatus
endedAt?	string

Returns

Promise<void>

Defined in

interfaces/ports.ts:92

---

deleteDagRun

▸ deleteDagRun(dagRunId): Promise<void>

Parameters

Name	Type
dagRunId	string

Returns

Promise<void>

Defined in

interfaces/ports.ts:93

---

createTaskRun

▸ createTaskRun(taskRun): Promise<void>

Parameters

Name	Type
taskRun	ITaskRun

Returns

Promise<void>

Defined in

interfaces/ports.ts:95

---

getTaskRun

▸ getTaskRun(taskRunId): Promise<undefined | ITaskRun>

Parameters

Name	Type
taskRunId	string

Returns

Promise<undefined | ITaskRun>

Defined in

interfaces/ports.ts:96

---

listTaskRunsByDagRunId

▸ listTaskRunsByDagRunId(dagRunId): Promise<ITaskRun[]>

Parameters

Name	Type
dagRunId	string

Returns

Promise<ITaskRun[]>

Defined in

interfaces/ports.ts:97

---

deleteTaskRunsByDagRunId

▸ deleteTaskRunsByDagRunId(dagRunId): Promise<void>

Parameters

Name	Type
dagRunId	string

Returns

Promise<void>

Defined in

interfaces/ports.ts:98

---

updateTaskRunStatus

▸ updateTaskRunStatus(taskRunId, status, error?): Promise<void>

Parameters

Name	Type
taskRunId	string
status	TTaskRunStatus
error?	IDagError

Returns

Promise<void>

Defined in

interfaces/ports.ts:99

---

saveTaskRunSnapshots

▸ saveTaskRunSnapshots(taskRunId, inputSnapshot?, outputSnapshot?, estimatedCredits?, totalCredits?): Promise<void>

Parameters

Name	Type
taskRunId	string
inputSnapshot?	string
outputSnapshot?	string
estimatedCredits?	number
totalCredits?	number

Returns

Promise<void>

Defined in

interfaces/ports.ts:100

---

incrementTaskAttempt

▸ incrementTaskAttempt(taskRunId): Promise<void>

Parameters

Name	Type
taskRunId	string

Returns

Promise<void>

Defined in

interfaces/ports.ts:107

---

deleteDefinition

▸ deleteDefinition(dagId, version): Promise<void>

Parameters

Name	Type
dagId	string
version	number

Returns

Promise<void>

Defined in

interfaces/ports.ts:108