Skip to main content

Store

Struct Store 

Source
pub struct Store { /* private fields */ }
Expand description

A PostgreSQL-backed snapshot store with configurable policy.

This implementation stores snapshots in a dedicated PostgreSQL table (es_snapshots), using the same database as the event store for consistency.

§Schema

The store uses the following table schema (created by migrate()):

CREATE TABLE IF NOT EXISTS es_snapshots (
    aggregate_kind TEXT NOT NULL,
    aggregate_id   UUID NOT NULL,
    position       BIGINT NOT NULL,
    data           JSONB NOT NULL,
    created_at     TIMESTAMPTZ NOT NULL DEFAULT now(),
    PRIMARY KEY (aggregate_kind, aggregate_id)
)

§Example

use sourcery_postgres::{Store as EventStore};
use sourcery_postgres::snapshot::Store as SnapshotStore;
use sourcery_core::Repository;

let pool = PgPool::connect("postgres://...").await?;
let event_store = EventStore::new(pool.clone());
let snapshot_store = SnapshotStore::every(pool, 100);

// Run migrations
event_store.migrate().await?;
snapshot_store.migrate().await?;

let repo = Repository::new(event_store).with_snapshots(snapshot_store);

Implementations§

Source§

impl Store

Source

pub const fn always(pool: PgPool) -> Self

Create a snapshot store that saves after every command.

Best for aggregates with expensive replay or many events. See the policy guidelines in SnapshotPolicy for choosing an appropriate cadence.

Source

pub const fn every(pool: PgPool, n: u64) -> Self

Create a snapshot store that saves every N events.

Recommended for most use cases. Start with n = 50-100 and tune based on your aggregate’s replay cost.

Source

pub const fn never(pool: PgPool) -> Self

Create a snapshot store that never saves (load-only).

Use for read replicas, short-lived aggregates, or when managing snapshots externally.

Source

pub async fn migrate(&self) -> Result<(), Error>

Apply the snapshot schema (idempotent).

This uses CREATE TABLE IF NOT EXISTS style DDL so it can be run on startup alongside the event store migrations.

§Errors

Returns a sqlx::Error if the schema creation query fails.

Trait Implementations§

Source§

impl Clone for Store

Source§

fn clone(&self) -> Store

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Store

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl SnapshotStore<Uuid> for Store

Source§

type Error = Error

Error type for snapshot operations.
Source§

type Position = i64

Position type for tracking snapshot positions. Read more
Source§

async fn load<T>( &self, kind: &str, id: &Uuid, ) -> Result<Option<Snapshot<Self::Position, T>>, Self::Error>

Load the most recent snapshot for an aggregate. Read more
Source§

async fn offer_snapshot<CE, T, Create>( &self, kind: &str, id: &Uuid, events_since_last_snapshot: u64, create_snapshot: Create, ) -> Result<SnapshotOffer, OfferSnapshotError<Self::Error, CE>>
where CE: Error + Send + Sync + 'static, T: Serialize, Create: FnOnce() -> Result<Snapshot<Self::Position, T>, CE>,

Whether to store a snapshot, with lazy snapshot creation. Read more

Auto Trait Implementations§

§

impl Freeze for Store

§

impl !RefUnwindSafe for Store

§

impl Send for Store

§

impl Sync for Store

§

impl Unpin for Store

§

impl !UnwindSafe for Store

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more