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
impl PostgresBackend
Sourcepub async fn new(database_url: &str) -> Result<Self>
pub async fn new(database_url: &str) -> Result<Self>
Connect to PostgreSQL at database_url with default pool settings.
Sourcepub fn from_pool(pool: PgPool) -> Self
pub fn from_pool(pool: PgPool) -> Self
Build from an existing sqlx::PgPool (e.g. shared with your web app).
Sourcepub fn pool_ref(&self) -> &PgPool
pub fn pool_ref(&self) -> &PgPool
Access the underlying connection pool (e.g. for cleanup in tests).
Sourcepub async fn migrate(&self) -> Result<()>
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.
Sourcepub 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>
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
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
older_than back to pending. Read moreSource§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,
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,
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,
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,
Auto Trait Implementations§
impl !RefUnwindSafe for PostgresBackend
impl !UnwindSafe for PostgresBackend
impl Freeze for PostgresBackend
impl Send for PostgresBackend
impl Sync for PostgresBackend
impl Unpin for PostgresBackend
impl UnsafeUnpin for PostgresBackend
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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