Struct PgOutboxStore 

pub struct PgOutboxStore { /* private fields */ }

PostgreSQL implementation of OutboxStore backed by sqlx::PgPool.

Cheap to clone (the pool and the cached SQL strings are reference-counted).

Implementations

impl PgOutboxStore

pub fn new( pool: PgPool, table_name: impl Into<String>, ) -> Result<Self, OutboxError>

Build a store for the given pool and table.

SQL statements are templated and cached at construction so each poll cycle re-uses the same strings.

Errors

Returns OutboxError::Internal if table_name is not a valid identifier matching ^[a-zA-Z_][a-zA-Z0-9_]*$.

pub fn pool(&self) -> &PgPool

Underlying pool.

pub fn table_name(&self) -> &str

Configured table name.

pub fn with_dead_letter( self, dlq_table: impl Into<String>, ) -> Result<Self, OutboxError>

Activate dead-letter persistence for this store.

When enabled, envelopes that exhaust max_attempts are atomically moved to dlq_table by OutboxStore::mark_dead_lettered.

Errors

Returns OutboxError::Internal if dlq_table is not a valid identifier.

Trait Implementations

impl Clone for PgOutboxStore

fn clone(&self) -> PgOutboxStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgOutboxStore

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

Formats the value using the given formatter.

impl OutboxStore for PgOutboxStore

type Client = PoolConnection<Postgres>

Pooled connection guard owned by the worker for one polling cycle.

type Tx<'tx> = Transaction<'tx, Postgres>

Transaction borrowed from a Self::Client.

fn acquire<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Client, OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Acquire a connection from the underlying pool.

fn begin<'a, 'life0, 'async_trait>( &'life0 self, client: &'a mut Self::Client, ) -> Pin<Box<dyn Future<Output = Result<Self::Tx<'a>, OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Open a transaction borrowing from the given connection.

fn poll<'a, 'life0, 'life1, 'async_trait>( &'life0 self, tx: &'life1 mut Self::Tx<'a>, batch_size: usize, max_attempts: u32, ) -> Pin<Box<dyn Future<Output = Result<Vec<OutboxEnvelope>, OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Poll a batch of pending envelopes, locking them via FOR UPDATE SKIP LOCKED.

fn mark_delivered<'a, 'life0, 'life1, 'async_trait>( &'life0 self, tx: &'life1 mut Self::Tx<'a>, event_id: Uuid, ) -> Pin<Box<dyn Future<Output = Result<(), OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mark an envelope as successfully delivered.

fn mark_failed<'a, 'life0, 'life1, 'life2, 'async_trait>( &'life0 self, tx: &'life1 mut Self::Tx<'a>, event_id: Uuid, error: &'life2 str, retry_in: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Mark an envelope as failed, recording the error and the backoff delay before the next retry.

fn commit<'a, 'life0, 'async_trait>( &'life0 self, tx: Self::Tx<'a>, ) -> Pin<Box<dyn Future<Output = Result<(), OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Commit the transaction.

fn mark_dead_lettered<'a, 'life0, 'life1, 'life2, 'async_trait>( &'life0 self, tx: &'life1 mut Self::Tx<'a>, event_id: Uuid, _error: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move an envelope that has exhausted its retry budget to the dead-letter store.

fn claim<'a, 'life0, 'life1, 'life2, 'async_trait>( &'life0 self, tx: &'life1 mut Self::Tx<'a>, event_ids: &'life2 [Uuid], lease_for: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), OutboxError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Claim a batch of envelopes: advance the soft lease and consume one retry slot.