SqliteSnapshotStore
Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:35
SQLite-backed SnapshotStore — JSON payloads, single table, prune-on-save.
Works on Bun (bun:sqlite) and Node.js (better-sqlite3) via the
SqliteDriver abstraction. Construction is lazy (same pattern as
SqliteJournal): the DB is opened on the first save / load call.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SqliteSnapshotStore(
options?):SqliteSnapshotStore
Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:45
Parameters
Section titled “Parameters”options?
Section titled “options?”SqliteSnapshotStoreOptions = {}
Returns
Section titled “Returns”SqliteSnapshotStore
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:106
Best-effort teardown.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”delete()
Section titled “delete()”delete(
pid,toSeq):Promise<void>
Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:101
Delete snapshots up to and including toSeq. Useful for pruning.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”loadBefore()
Section titled “loadBefore()”loadBefore<
S>(pid,seq,_options?):Promise<Option<Snapshot<S>>>
Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:84
Load the newest snapshot with sequenceNr < seq, or None.
Type Parameters
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”string
number
_options?
Section titled “_options?”PersistenceOptions
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”loadLatest()
Section titled “loadLatest()”Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:67
Load the newest snapshot for pid, or None if none exist.
options.encryption is required when client-side encryption was
used at write time — the store has no other way to obtain the
master key. Stores that don’t encrypt ignore the field.
Type Parameters
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”string
_options?
Section titled “_options?”PersistenceOptions
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”save()
Section titled “save()”save<
S>(pid,seq,state,_options?):Promise<Snapshot<S>>
Defined in: src/persistence/snapshot-stores/SqliteSnapshotStore.ts:51
Persist a snapshot at seq — typically the seq of the latest event
applied. Optional options carry per-call preferences from the
caller (e.g. compression/encryption set on the actor). Stores that
cannot honour them silently ignore the field.
Type Parameters
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”string
number
S
_options?
Section titled “_options?”PersistenceOptions
Returns
Section titled “Returns”Promise<Snapshot<S>>