rulvar API reference

---

rulvar API reference / @rulvar/store-sqlite / SqliteStore

Class: SqliteStore

Defined in: packages/store-sqlite/src/store.ts:51

@rulvar/store-sqlite: SqliteStore implementing JournalStore and LeasableStore with fencing epochs over the builtin node:sqlite driver; the reference implementation for community stores (M5-T02). Requires a Node.js with node:sqlite available (unflagged in the 22.13+/23.4+ lines).

Implements

• JournalStore
• LeasableStore

Constructors

Constructor

new SqliteStore(options): SqliteStore;

Defined in: packages/store-sqlite/src/store.ts:56

Parameters

Parameter	Type
options	SqliteStoreOptions

Returns

SqliteStore

Methods

acquire()

acquire(runId, owner): Promise<Lease>;

Defined in: packages/store-sqlite/src/store.ts:179

Parameters

Parameter	Type
runId	string
owner	string

Returns

Promise<Lease>

Implementation of

LeasableStore.acquire

---

append()

append(
   runId, 
   e, 
lease?): Promise<void>;

Defined in: packages/store-sqlite/src/store.ts:114

Parameters

Parameter	Type
runId	string
e	JournalEntry
lease?	Lease

Returns

Promise<void>

Implementation of

LeasableStore.append

---

close()

close(): void;

Defined in: packages/store-sqlite/src/store.ts:87

Returns

void

---

delete()

delete(runId): Promise<void>;

Defined in: packages/store-sqlite/src/store.ts:164

Parameters

Parameter	Type
runId	string

Returns

Promise<void>

Implementation of

LeasableStore.delete

---

listRuns()

listRuns(f?): Promise<RunMeta[]>;

Defined in: packages/store-sqlite/src/store.ts:144

Parameters

Parameter	Type
f?	RunFilter

Returns

Promise<RunMeta[]>

Implementation of

LeasableStore.listRuns

---

load()

load(runId): Promise<JournalEntry[]>;

Defined in: packages/store-sqlite/src/store.ts:126

Parameters

Parameter	Type
runId	string

Returns

Promise<JournalEntry[]>

Implementation of

LeasableStore.load

---

putMeta()

putMeta(m): Promise<void>;

Defined in: packages/store-sqlite/src/store.ts:134

Parameters

Parameter	Type
m	RunMeta

Returns

Promise<void>

Implementation of

LeasableStore.putMeta

---

release()

release(l): Promise<void>;

Defined in: packages/store-sqlite/src/store.ts:224

Parameters

Parameter	Type
l	Lease

Returns

Promise<void>

Implementation of

LeasableStore.release

---

renew()

renew(l): Promise<void>;

Defined in: packages/store-sqlite/src/store.ts:216

Parameters

Parameter	Type
l	Lease

Returns

Promise<void>

Implementation of

LeasableStore.renew