Skip to main content

PostgresBackend

Struct PostgresBackend 

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

PostgreSQL backend for asyncq.

Uses a connection pool (sqlx::PgPool) for concurrent job processing. Call migrate() once at startup to create the asyncq_jobs table.

Implementations§

Source§

impl PostgresBackend

Source

pub async fn new(database_url: &str) -> Result<Self>

Connect to PostgreSQL at database_url with default pool settings.

Source

pub fn from_pool(pool: PgPool) -> Self

Build from an existing sqlx::PgPool (e.g. shared with your web app).

Source

pub fn pool_ref(&self) -> &PgPool

Access the underlying connection pool (e.g. for cleanup in tests).

Source

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

Create the asyncq_jobs table and indexes. Safe to call on every startup (idempotent).

Concurrent callers (e.g. parallel test setup) are safe: if two callers race on CREATE TABLE, the losing transaction gets a unique_violation (Postgres error 23505) from the internal pg_type catalog. The schema exists either way, so that specific error is treated as success.

Source

pub async fn enqueue_in_tx( &self, kind: &str, queue: &str, payload: Vec<u8>, max_attempts: u32, scheduled_at: DateTime<Utc>, tx: &mut Transaction<'_, Postgres>, ) -> Result<JobId>

Enqueue a job inside an existing transaction (transactional outbox pattern).

The job is only visible to workers after tx.commit(). If the transaction rolls back, the job disappears — no orphaned notifications.

Trait Implementations§

Source§

impl Backend for PostgresBackend

Source§

fn enqueue<'life0, 'async_trait>( &'life0 self, record: JobRecord, ) -> Pin<Box<dyn Future<Output = Result<JobId>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Persist a job record for future processing.
Source§

fn claim<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, queues: &'life1 [&'life2 str], timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<Option<JobRecord>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Claim the next available job from any of the given queues. Read more
Source§

fn ack<'life0, 'async_trait>( &'life0 self, id: JobId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Mark a job as successfully completed.
Source§

fn nack<'life0, 'life1, 'async_trait>( &'life0 self, id: JobId, error: &'life1 str, retry_at: Option<DateTime<Utc>>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mark a job as failed. Read more
Source§

fn heartbeat<'life0, 'async_trait>( &'life0 self, id: JobId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Update the heartbeat timestamp for a running job. Read more
Source§

fn reap_stuck<'life0, 'async_trait>( &'life0 self, older_than: Duration, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Reset jobs that have been running longer than older_than back to pending. Read more
Source§

fn stats<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<QueueStats>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Statistics for a single queue.
Source§

fn dead_jobs<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 str, limit: i64, offset: i64, ) -> Pin<Box<dyn Future<Output = Result<Vec<JobRecord>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Paginated list of dead-lettered jobs for a queue.
Source§

fn retry_dead<'life0, 'async_trait>( &'life0 self, id: JobId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Requeue a single dead-lettered job for another delivery attempt.
Source§

fn retry_all_dead<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Requeue all dead-lettered jobs for a queue. Read more
Source§

impl Clone for PostgresBackend

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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