Skip to main content

PostgresFlowTaskQueue

Struct PostgresFlowTaskQueue 

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

A3S ORM-backed PostgreSQL task queue for shared workers.

Pending and inflight tasks live in one table and are scoped by queue_name. Leasing uses an atomic FOR UPDATE SKIP LOCKED CTE, so multiple workers can lease concurrently without taking the same task. Heartbeats rotate fencing tokens; stale acknowledgements cannot delete a task owned by another worker.

Implementations§

Source§

impl PostgresFlowTaskQueue

Source

pub async fn connect(database_url: impl AsRef<str>) -> Result<Self>

Connects to PostgreSQL, migrates the schema, and uses the default queue.

Source

pub async fn connect_verified(database_url: impl AsRef<str>) -> Result<Self>

Connects to PostgreSQL, verifies a separately migrated schema, and uses the default queue without acquiring DDL authority.

Source

pub async fn connect_with_queue( database_url: impl AsRef<str>, queue_name: impl AsRef<str>, ) -> Result<Self>

Connect with the ORM’s bounded non-TLS pool and run Flow migrations.

Production hosts that require TLS or custom pool controls should create a configured PostgresExecutor and call Self::from_executor_with_queue.

Source

pub async fn connect_verified_with_queue( database_url: impl AsRef<str>, queue_name: impl AsRef<str>, ) -> Result<Self>

Connect with the ORM’s bounded non-TLS pool and verify a separately migrated Flow schema for the named queue.

Source

pub async fn from_executor(executor: PostgresExecutor) -> Result<Self>

Uses a configured executor, migrates the schema, and uses the default queue.

Source

pub async fn from_executor_verified(executor: PostgresExecutor) -> Result<Self>

Uses a configured executor, verifies the Flow schema without mutation, and uses the default queue.

Source

pub async fn from_executor_with_queue( executor: PostgresExecutor, queue_name: impl AsRef<str>, ) -> Result<Self>

Uses a configured executor and migrates the named queue schema.

Source

pub async fn from_executor_verified_with_queue( executor: PostgresExecutor, queue_name: impl AsRef<str>, ) -> Result<Self>

Uses a configured executor and verifies the complete Flow schema for a named queue without applying migrations.

Source

pub fn executor(&self) -> &PostgresExecutor

Returns the configured A3S ORM executor.

Source

pub fn queue_name(&self) -> &str

Returns the logical queue name used to scope rows.

Source

pub async fn inflight_len(&self) -> Result<usize>

Returns the number of currently leased tasks.

Source

pub async fn dead_letter_len(&self) -> Result<usize>

Returns the number of dead-lettered tasks.

Source

pub async fn dead_lettered_tasks(&self) -> Result<Vec<PostgresDeadLetteredTask>>

Loads dead-lettered tasks in durable insertion order.

Source

pub async fn requeue_inflight_older_than( &self, cutoff: DateTime<Utc>, ) -> Result<usize>

Returns leases at or before cutoff to pending dispatch.

Source

pub async fn dead_letter_inflight_older_than( &self, cutoff: DateTime<Utc>, reason: impl Into<String>, ) -> Result<usize>

Atomically moves leases at or before cutoff to the dead-letter table.

Trait Implementations§

Source§

impl Clone for PostgresFlowTaskQueue

Source§

fn clone(&self) -> PostgresFlowTaskQueue

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
Source§

impl Debug for PostgresFlowTaskQueue

Source§

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

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

impl FlowTaskQueue for PostgresFlowTaskQueue

Source§

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

Appends one task to pending dispatch.
Source§

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

Leases the next pending task without acknowledging it.
Source§

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

Refreshes an active lease and returns its replacement fencing token. Read more
Source§

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

Acknowledges the active lease identified by its latest fencing token. Read more
Source§

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

Returns inflight tasks to pending dispatch and reports the count.
Source§

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

Returns the number of tasks pending dispatch.
Source§

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

Leases and immediately acknowledges the next pending task.
Source§

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

Returns whether no tasks are pending dispatch.

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> 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> FlowTaskDispatcher for T
where T: FlowTaskQueue + ?Sized,

Source§

fn dispatch<'life0, 'async_trait>( &'life0 self, task: FlowTask, ) -> Pin<Box<dyn Future<Output = Result<(), FlowError>> + Send + 'async_trait>>
where 'life0: 'async_trait, T: 'async_trait,

Dispatches one Flow task to the configured execution route.
Source§

fn has_runtime_build_route( &self, required_build_id: Option<&RuntimeBuildId>, ) -> bool

Return whether this dispatcher has an explicit compatible route.
Source§

fn ensure_runtime_build_route( &self, required_build_id: Option<&RuntimeBuildId>, ) -> Result<()>

Fail before dispatch when no compatible route is registered.
Source§

fn dispatch_for_runtime_build<'life0, 'life1, 'async_trait>( &'life0 self, required_build_id: Option<&'life1 RuntimeBuildId>, task: FlowTask, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Dispatch to a route that explicitly serves required_build_id. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SqlComparable<Option<T>> for T

Source§

impl<T> SqlComparable<T> for T

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, <T as TryFrom<U>>::Error>

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