Struct PostgresStore 

pub struct PostgresStore { /* private fields */ }

An EffectStore in a PostgreSQL database.

Cheap to clone; clones share the connection pool.

Implementations

impl PostgresStore

pub async fn connect(url: &str) -> Result<Self, StoreError>

Connects to url and applies migrations.

Errors

StoreError::Backend if connecting or migrating fails.

pub async fn connect_with(options: PgConnectOptions) -> Result<Self, StoreError>

Connects with options (e.g. a search_path for a schema) and applies migrations.

Errors

StoreError::Backend if connecting or migrating fails.

pub async fn from_pool(pool: PgPool) -> Result<Self, StoreError>

Uses an existing pool and applies migrations. Concurrent callers are safe: migrations run under an advisory lock.

Errors

StoreError::Backend if migrating fails.

pub fn with_clock_source(self, clock: ClockSource) -> Self

Chooses whose clock to trust; see ClockSource.

pub fn pool(&self) -> &PgPool

The underlying pool.

Trait Implementations

impl Clone for PostgresStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresStore

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

Formats the value using the given formatter.

impl EffectStore for PostgresStore

async fn insert_or_get( &self, new: NewEffect, ) -> Result<InsertOutcome, StoreError>

Inserts a new effect, or returns the existing record with the same EffectKey untouched.

async fn get(&self, id: EffectId) -> Result<Option<EffectRecord>, StoreError>

Loads a record by id.

async fn get_by_key( &self, key: &EffectKey, ) -> Result<Option<EffectRecord>, StoreError>

Loads a record by its logical identity.

async fn acquire_lease( &self, id: EffectId, owner: &WorkerId, now: SystemTime, ttl: Duration, ) -> Result<Lease, StoreError>

Takes the execution lease, via EffectRecord::acquire_lease.

async fn renew_lease( &self, lease: &Lease, now: SystemTime, ttl: Duration, ) -> Result<Lease, StoreError>

Extends a held lease, via EffectRecord::renew_lease.

async fn release_lease(&self, lease: &Lease) -> Result<(), StoreError>

Gives up a lease, via EffectRecord::release_lease. Releasing a lease that was already lost is not an error.

async fn transition( &self, request: TransitionRequest, ) -> Result<EffectRecord, StoreError>

Applies a status transition, via EffectRecord::apply, and appends its audit event in the same atomic unit. Returns the updated record.

async fn list(&self, query: ListQuery) -> Result<Vec<EffectRecord>, StoreError>

Lists records matching query, ordered by id (creation time).

async fn events(&self, id: EffectId) -> Result<Vec<EffectEvent>, StoreError>

The audit events of one effect, ordered by sequence.

async fn prune(&self, query: PruneQuery) -> Result<u64, StoreError>

Deletes up to query.limit records matching query, lowest id first, together with their audit events, and returns how many it deleted. Each record is checked and deleted atomically, so a record that a worker leases or changes concurrently is either deleted before that change or not at all.