Skip to main content

DatabaseQueue

Struct DatabaseQueue 

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

A queue backed by database rows.

Implementations§

Source§

impl DatabaseQueue

Source

pub fn new(db: Database) -> Self

A database queue over db.

Source

pub fn with_reservation(self, reservation: Duration) -> Self

How long a worker’s claim on a job lasts.

Must exceed the worker’s job timeout, or a job could be reclaimed and run twice while the first attempt is still going.

Source

pub fn migrations() -> Migrator

The migrations this driver needs.

Source

pub async fn reclaim_expired(&self) -> Result<u64>

Release every job whose reservation has lapsed, so a job held by a worker that died becomes available again. Returns how many.

Source

pub async fn failed_jobs(&self, limit: u64) -> Result<Vec<FailedJobRow>>

Every failed job, newest first.

Source

pub async fn retry_failed(&self, id: &str) -> Result<bool>

Put a failed job back on its queue for another run.

Trait Implementations§

Source§

impl Debug for DatabaseQueue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Queue for DatabaseQueue

Source§

fn name(&self) -> &str

A label for diagnostics — "database", "memory", "sync".
Source§

fn push<'a>(&'a self, job: QueuedJob) -> BoxFuture<'a, Result<String>>

Enqueue a job.
Source§

fn reserve<'a>( &'a self, queue: &'a str, ) -> BoxFuture<'a, Result<Option<QueuedJob>>>

Reserve the next available job on queue, or None if there is none.
Source§

fn acknowledge<'a>(&'a self, job: &'a QueuedJob) -> BoxFuture<'a, Result<()>>

Remove a finished job.
Source§

fn release<'a>( &'a self, job: &'a QueuedJob, delay: Duration, ) -> BoxFuture<'a, Result<()>>

Return a job to the queue for another attempt, available after delay.
Source§

fn fail<'a>( &'a self, job: &'a QueuedJob, error: &'a str, ) -> BoxFuture<'a, Result<()>>

Move a job to the failed store after its last attempt.
Source§

fn size<'a>(&'a self, queue: &'a str) -> BoxFuture<'a, Result<u64>>

How many jobs are waiting on queue.
Source§

fn clear<'a>(&'a self, queue: &'a str) -> BoxFuture<'a, Result<u64>>

Discard everything on queue. Returns how many were removed.

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<T> Event for T
where T: Send + Sync + 'static,

Source§

fn event_name() -> &'static str
where Self: Sized,

A human-readable name, used by wildcard listeners and log output. Always the Rust type path; see the trait docs.
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, 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<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