dag-adapters-local / Exports / FileStoragePort

Class: FileStoragePort

Implements

• IStoragePort

Table of contents

Constructors

• constructor

Methods

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

Constructors

constructor

• new FileStoragePort(storageRootPath): FileStoragePort

Parameters

Name	Type
storageRootPath	string

Returns

FileStoragePort

Defined in

file-storage-port.ts:31

Methods

saveDefinition

▸ saveDefinition(definition): Promise<void>

Parameters

Name	Type
definition	IDagDefinition

Returns

Promise<void>

Implementation of

IStoragePort.saveDefinition

Defined in

file-storage-port.ts:70

---

getDefinition

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

Parameters

Name	Type
dagId	string
version	number

Returns

Promise<undefined | IDagDefinition>

Implementation of

IStoragePort.getDefinition

Defined in

file-storage-port.ts:75

---

listDefinitions

▸ listDefinitions(): Promise<IDagDefinition[]>

Returns

Promise<IDagDefinition[]>

Implementation of

IStoragePort.listDefinitions

Defined in

file-storage-port.ts:81

---

listDefinitionsByDagId

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

Parameters

Name	Type
dagId	string

Returns

Promise<IDagDefinition[]>

Implementation of

IStoragePort.listDefinitionsByDagId

Defined in

file-storage-port.ts:96

---

getLatestPublishedDefinition

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

Parameters

Name	Type
dagId	string

Returns

Promise<undefined | IDagDefinition>

Implementation of

IStoragePort.getLatestPublishedDefinition

Defined in

file-storage-port.ts:122

---

createDagRun

▸ createDagRun(dagRun): Promise<void>

Parameters

Name	Type
dagRun	IDagRun

Returns

Promise<void>

Implementation of

IStoragePort.createDagRun

Defined in

file-storage-port.ts:131

---

getDagRun

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

Parameters

Name	Type
dagRunId	string

Returns

Promise<undefined | IDagRun>

Implementation of

IStoragePort.getDagRun

Defined in

file-storage-port.ts:135

---

listDagRuns

▸ listDagRuns(): Promise<IDagRun[]>

Returns

Promise<IDagRun[]>

Implementation of

IStoragePort.listDagRuns

Defined in

file-storage-port.ts:139

---

getDagRunByRunKey

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

Parameters

Name	Type
runKey	string

Returns

Promise<undefined | IDagRun>

Implementation of

IStoragePort.getDagRunByRunKey

Defined in

file-storage-port.ts:143

---

updateDagRunStatus

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

Parameters

Name	Type
dagRunId	string
status	TDagRunStatus
endedAt?	string

Returns

Promise<void>

Implementation of

IStoragePort.updateDagRunStatus

Defined in

file-storage-port.ts:152

---

deleteDagRun

▸ deleteDagRun(dagRunId): Promise<void>

Parameters

Name	Type
dagRunId	string

Returns

Promise<void>

Implementation of

IStoragePort.deleteDagRun

Defined in

file-storage-port.ts:164

---

createTaskRun

▸ createTaskRun(taskRun): Promise<void>

Parameters

Name	Type
taskRun	ITaskRun

Returns

Promise<void>

Implementation of

IStoragePort.createTaskRun

Defined in

file-storage-port.ts:168

---

getTaskRun

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

Parameters

Name	Type
taskRunId	string

Returns

Promise<undefined | ITaskRun>

Implementation of

IStoragePort.getTaskRun

Defined in

file-storage-port.ts:172

---

listTaskRunsByDagRunId

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

Parameters

Name	Type
dagRunId	string

Returns

Promise<ITaskRun[]>

Implementation of

IStoragePort.listTaskRunsByDagRunId

Defined in

file-storage-port.ts:181

---

deleteTaskRunsByDagRunId

▸ deleteTaskRunsByDagRunId(dagRunId): Promise<void>

Parameters

Name	Type
dagRunId	string

Returns

Promise<void>

Implementation of

IStoragePort.deleteTaskRunsByDagRunId

Defined in

file-storage-port.ts:191

---

updateTaskRunStatus

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

Parameters

Name	Type
taskRunId	string
status	TTaskRunStatus
error?	IDagError

Returns

Promise<void>

Implementation of

IStoragePort.updateTaskRunStatus

Defined in

file-storage-port.ts:199

---

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>

Implementation of

IStoragePort.saveTaskRunSnapshots

Defined in

file-storage-port.ts:214

---

incrementTaskAttempt

▸ incrementTaskAttempt(taskRunId): Promise<void>

Parameters

Name	Type
taskRunId	string

Returns

Promise<void>

Implementation of

IStoragePort.incrementTaskAttempt

Defined in

file-storage-port.ts:236

---

deleteDefinition

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

Parameters

Name	Type
dagId	string
version	number

Returns

Promise<void>

Implementation of

IStoragePort.deleteDefinition

Defined in

file-storage-port.ts:249