Skip to main content

PostgresResultBackend

Struct PostgresResultBackend 

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

PostgreSQL-backed result storage.

Results are stored in the kojin_results table as JSONB with a configurable TTL (default 24 hours). Group state is tracked in kojin_groups.

Important: call migrate() before first use to create the required tables and indexes.

Implementations§

Source§

impl PostgresResultBackend

Source

pub fn new(pool: PgPool) -> Self

Create a new PostgreSQL result backend from an existing connection pool.

The default result TTL is 24 hours; override with with_ttl. You must call migrate() before storing results.

Source

pub async fn connect(url: &str) -> TaskResult<Self>

Connect to PostgreSQL by URL and create the backend.

This is a convenience wrapper around PgPool::connect + new.

Source

pub fn with_ttl(self, ttl: Duration) -> Self

Override the result TTL (time-to-live).

Expired results are not automatically deleted; they are filtered out at read time. Run periodic cleanup queries against kojin_results.expires_at if storage reclamation is needed. Defaults to 24 hours if not called.

Source

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

Run migrations to create the required tables (kojin_results, kojin_groups) and indexes. Safe to call multiple times — all statements use IF NOT EXISTS.

Trait Implementations§

Source§

impl ResultBackend for PostgresResultBackend

Source§

fn store<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id: &'life1 TaskId, result: &'life2 Value, ) -> Pin<Box<dyn Future<Output = TaskResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Store a task result.
Source§

fn get<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 TaskId, ) -> Pin<Box<dyn Future<Output = TaskResult<Option<Value>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a stored result.
Source§

fn wait<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 TaskId, timeout: Duration, ) -> Pin<Box<dyn Future<Output = TaskResult<Value>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Wait for a result to be available, with timeout.
Source§

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 TaskId, ) -> Pin<Box<dyn Future<Output = TaskResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a stored result.
Source§

fn init_group<'life0, 'life1, 'async_trait>( &'life0 self, group_id: &'life1 str, total: u32, ) -> Pin<Box<dyn Future<Output = TaskResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Initialize a group with the expected total count.
Source§

fn complete_group_member<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, group_id: &'life1 str, task_id: &'life2 TaskId, result: &'life3 Value, ) -> Pin<Box<dyn Future<Output = TaskResult<u32>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Mark a group member as complete and return the number of completed members.
Source§

fn get_group_results<'life0, 'life1, 'async_trait>( &'life0 self, group_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = TaskResult<Vec<Value>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all results for a group.

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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