Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/core / / CheckpointStore

Interface: CheckpointStore

Defined in: packages/core/src/contracts/checkpoint-store.ts:86

Pluggable checkpoint storage interface. The default implementation lives in @graphorin/store-sqlite.

Stable

Methods

deleteThread()

deleteThread(threadId): Promise<void>;

Defined in: packages/core/src/contracts/checkpoint-store.ts:110

Parameters

Parameter	Type
threadId	string

Returns

Promise<void>

---

getTuple()

getTuple(
   threadId, 
   namespace, 
   checkpointId?): Promise<
  | CheckpointTuple
| null>;

Defined in: packages/core/src/contracts/checkpoint-store.ts:102

Parameters

Parameter	Type
threadId	string
namespace	string
checkpointId?	string

Returns

Promise< | CheckpointTuple | null>

---

list()

list(
   threadId, 
   namespace, 
opts?): AsyncIterable<CheckpointTuple>;

Defined in: packages/core/src/contracts/checkpoint-store.ts:108

Parameters

Parameter	Type
threadId	string
namespace	string
opts?	ListOptions

Returns

AsyncIterable&lt;CheckpointTuple&gt;

---

put()

put(
   threadId, 
   namespace, 
   checkpoint, 
metadata): Promise<string>;

Defined in: packages/core/src/contracts/checkpoint-store.ts:87

Parameters

Parameter	Type
threadId	string
namespace	string
checkpoint	Checkpoint
metadata	CheckpointMetadata

Returns

Promise&lt;string&gt;

---

putWrites()

putWrites(
   threadId, 
   namespace, 
   checkpointId, 
   writes, 
taskId): Promise<void>;

Defined in: packages/core/src/contracts/checkpoint-store.ts:94

Parameters

Parameter	Type
threadId	string
namespace	string
checkpointId	string
writes	readonly PendingWrite[]
taskId	string

Returns

Promise&lt;void&gt;