Crate pgboss

Queue jobs with Rust and PostgreSQL like a boss.

Inspired by, compatible with and partially ported from pg-boss Node.js package.

Heavily influenced by decisions and approaches in faktory-rs crate.

use std::time::Duration;
use serde_json::json;
use pgboss::{Client, Job, JobState};

// Create a client first.
let c = Client::builder().schema("desired_schema_name").connect().await.unwrap();

// Then create a queue.
c.create_standard_queue("qname").await.unwrap();  // NB! queue should be created before pushing jobs
c.create_standard_queue("qname_dlq").await.unwrap();

// Build a job and ...
let job = Job::builder()
    .queue_name("qname")                           // which queue this job should be sent to
    .data(json!({"key": "value"}))                 // arbitrary json, your job's payload
    .priority(10)                                  // will be consumer prior to those with lower priorities
    .retry_limit(1)                                // only retry this job once
    .dead_letter("qname_dlq")                      // send to this queue when retry limit exceeded
    .retry_delay(Duration::from_secs(60 * 5))      // do not retry immediately after failure
    .expire_in(Duration::from_secs(60 * 5))        // only give the worker 5 minutes to complete the job
    .retain_for(Duration::from_secs(60 * 60 * 24)) // do not archive for at least 1 day
    .delay_for(Duration::from_secs(5))             // make it visible to consumers after 5 seconds
    .singleton_for(Duration::from_secs(7))         // only allow one job for at least 7 seconds
    .singleton_key("buzz")                         // allow more than one job if their key is different from this
    .build();

// ... enqueue it.
let _id = c.send_job(&job).await.expect("no error");

// Consume from the queue.
let fetched_job = c
    .fetch_job("qname")
    .await
    .expect("no error")
    .expect("a job");

assert_eq!(fetched_job.data, job.data);
assert_eq!(fetched_job.state, JobState::Active);

c.complete_job("qname", fetched_job.id, json!({"result": "success!"})).await.expect("no error");

Structs

Client

PgBoss client.

ClientBuilder

Builder for Client.

Job

A job to be sent to the server.

JobBuilder

A builder for a job.

JobDetails

A job fetched from the server.

MaintenanceStats

Results of maintenance round.

Queue

Queue configuration.

QueueBuilder

Convenience builder for Queue

QueueDetails

Job queue info.

Enums

Error

Enumerates all errors that this crate may return.

JobState

Job’s state.

QueuePolicy

Policy to apply to the jobs in this queue.