PostgresSnapshotStore
Ce contenu n’est pas encore disponible dans votre langue.
Defined in: src/persistence/snapshot-stores/PostgresSnapshotStore.ts:11
SnapshotStore backed by PostgreSQL (pg). Behaviour lives in
RelationalSnapshotStore; this class supplies the Postgres dialect
(ON CONFLICT … DO UPDATE upsert, LIMIT-in-subquery prune) and the pool.
Extends
Section titled “Extends”RelationalSnapshotStore
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PostgresSnapshotStore(
options?):PostgresSnapshotStore
Defined in: src/persistence/snapshot-stores/PostgresSnapshotStore.ts:12
Parameters
Section titled “Parameters”options?
Section titled “options?”PostgresSnapshotStoreOptions = {}
Returns
Section titled “Returns”PostgresSnapshotStore
Overrides
Section titled “Overrides”RelationalSnapshotStore.constructor
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: src/persistence/LazyStore.ts:66
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”RelationalSnapshotStore.close
delete()
Section titled “delete()”delete(
persistenceId,toSeq):Promise<void>
Defined in: src/persistence/relational/RelationalSnapshotStore.ts:101
Delete snapshots up to and including toSeq. Useful for pruning.
Parameters
Section titled “Parameters”persistenceId
Section titled “persistenceId”string
number
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”RelationalSnapshotStore.delete
loadBefore()
Section titled “loadBefore()”loadBefore<
S>(persistenceId,seq,_options?):Promise<Option<Snapshot<S>>>
Defined in: src/persistence/relational/RelationalSnapshotStore.ts:94
Load the newest snapshot with sequenceNr < seq, or None.
Type Parameters
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”persistenceId
Section titled “persistenceId”string
number
_options?
Section titled “_options?”PersistenceOptions
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”RelationalSnapshotStore.loadBefore
loadLatest()
Section titled “loadLatest()”loadLatest<
S>(persistenceId,_options?):Promise<Option<Snapshot<S>>>
Defined in: src/persistence/relational/RelationalSnapshotStore.ts:87
Load the newest snapshot for persistenceId, 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”persistenceId
Section titled “persistenceId”string
_options?
Section titled “_options?”PersistenceOptions
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”RelationalSnapshotStore.loadLatest
save()
Section titled “save()”save<
S>(persistenceId,seq,state,_options?):Promise<Snapshot<S>>
Defined in: src/persistence/relational/RelationalSnapshotStore.ts:72
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”persistenceId
Section titled “persistenceId”string
number
S
_options?
Section titled “_options?”PersistenceOptions
Returns
Section titled “Returns”Promise<Snapshot<S>>
Inherited from
Section titled “Inherited from”RelationalSnapshotStore.save