DurableKv

Interface exported by @botmesh/core.

Defined in: durability/kv.ts:68

Versioned document store with two sorted indexes per table.

Contract (checked by runDurableKvConformance):

• insert writes only when id is absent and returns the new version, else undefined;
• replace writes only when the stored version equals version and returns the new version, else undefined (missing document or concurrent write);
• remove deletes only when the stored version equals version;
• range returns ids whose index score is <= max, ascending by score, at most limit. It may return ids whose document changed since (callers re-read); it must not miss a document whose committed score is <= max beyond limit.

Methods

start()?

start?(): Promise<void>;

Defined in: durability/kv.ts:69

Returns

Promise<void>

---

stop()?

stop?(): Promise<void>;

Defined in: durability/kv.ts:70

Returns

Promise<void>

---

get()

get(table, id): Promise<DurableKvEntry | undefined>;

Defined in: durability/kv.ts:71

Parameters

Parameter	Type
table	string
id	string

Returns

Promise<DurableKvEntry | undefined>

---

insert()

insert(
   table, 
   id, 
   value, 
   index
): Promise<string | undefined>;

Defined in: durability/kv.ts:72

Parameters

Parameter	Type
table	string
id	string
value	string
index	DurableKvIndex

Returns

Promise<string | undefined>

---

replace()

replace(
   table, 
   id, 
   version, 
   value, 
   index
): Promise<string | undefined>;

Defined in: durability/kv.ts:73

Parameters

Parameter	Type
table	string
id	string
version	string
value	string
index	DurableKvIndex

Returns

Promise<string | undefined>

---

remove()

remove(
   table, 
   id, 
   version
): Promise<boolean>;

Defined in: durability/kv.ts:74

Parameters

Parameter	Type
table	string
id	string
version	string

Returns

Promise<boolean>

---

range()

range(
   table, 
   index, 
   max, 
   limit
): Promise<string[]>;

Defined in: durability/kv.ts:75

Parameters

Parameter	Type
table	string
index	keyof DurableKvIndex
max	number
limit	number

Returns

Promise<string[]>