Struct PgSnapshotter

pub struct PgSnapshotter { /* private fields */ }

PostgreSQL implementation for the Snapshotter trait.

The PgSnapshotter struct implements the Snapshotter trait for PostgreSQL databases. It allows for stroring and retrieving snapshots of StateQuery from PostgreSQL database.

Implementations

impl PgSnapshotter

pub async fn new(pool: PgPool, every: u64) -> Result<Self, Error>

Creates and initializes a new instance of PgSnapshotter with the specified PostgreSQL connection pool and snapshot frequency.

Arguments

• pool: A PostgreSQL connection pool (PgPool) representing the database connection.
• every: The frequency of snapshot creation, specified as the number of events between consecutive snapshots.

Returns

A new PgSnapshotter instance.

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

Creates a new instance of PgSnapshotter with the specified PostgreSQL connection pool and snapshot frequency.

This constructor does not initialize the database. If you need to initialize the database, use PgSnapshotter::new instead.

If you use this constructor, ensure that the database is already initialized. Refer to the SQL files in the snapshotter/sql folder for the necessary schema.

Arguments

• pool: A PostgreSQL connection pool (PgPool) representing the database connection.
• every: The frequency of snapshot creation, defined as the number of events between consecutive snapshots.

Returns

A new PgSnapshotter instance.

Trait Implementations

impl Clone for PgSnapshotter

fn clone(&self) -> PgSnapshotter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl StateSnapshotter<i64> for PgSnapshotter

fn load_snapshot<'life0, 'async_trait, S>( &'life0 self, default: StatePart<PgEventId, S>, ) -> Pin<Box<dyn Future<Output = StatePart<PgEventId, S>> + Send + 'async_trait>>

where S: Send + Sync + DeserializeOwned + StateQuery + 'static + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Loads a snapshot of a state part. If the snapshot is not present of invalid, it returns the provided default.

fn store_snapshot<'life0, 'life1, 'async_trait, S>( &'life0 self, state: &'life1 StatePart<PgEventId, S>, ) -> Pin<Box<dyn Future<Output = Result<(), BoxDynError>> + Send + 'async_trait>>

where S: Send + Sync + Serialize + StateQuery + 'static + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stores a snapshot of the provided state part.