graphile_worker 0.13.3

High performance Rust/PostgreSQL job queue (also suitable for getting jobs generated by PostgreSQL triggers/functions out into a different work queue)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

#![doc = include_str!("../README.md")]

//! # Graphile Worker RS
//!
//! A PostgreSQL-backed job queue implementation for Rust applications. This crate is a Rust port
//! of the Node.js [Graphile Worker](https://github.com/graphile/worker) library.
//!
//! ## Architecture Overview
//!
//! Graphile Worker uses PostgreSQL as its backend for job storage and coordination.
//! The system consists of several key components:
//!
//! - **Worker**: Processes jobs from the queue using the specified concurrency.
//! - **WorkerUtils**: Utility functions for job management (adding, removing, rescheduling, etc.).
//! - **TaskHandler**: Trait that defines how specific job types are processed.
//! - **Job Specification**: Configures job parameters like priority, retry behavior, and scheduling.
//! - **Migrations**: Automatic schema management for the database tables.
//!
//! ## Database Schema
//!
//! Graphile Worker manages its own database schema (default: `graphile_worker`).
//! It automatically handles migrations and uses the following tables:
//!
//! - `_private_jobs`: Stores job data, state, and execution metadata
//! - `_private_tasks`: Tracks registered task types
//! - `_private_job_queues`: Manages job queue names for serialized job execution
//! - `_private_workers`: Tracks active worker instances
//!
//! ## Module Structure
//!
//! The crate is organized into the following modules:

/// Configuration and initialization of worker instances
pub mod builder;

/// Error types used throughout the crate
pub mod errors;

/// Dead worker recovery
pub mod recovery;

/// Core worker implementation for running the job queue
pub mod runner;

mod shutdown;

mod recovery_tasks;

/// LocalQueue for batch-fetching jobs to improve throughput
pub mod local_queue;

/// Batchers for batching job completions and failures to reduce SQL round trips
pub(crate) mod batcher;

pub(crate) mod background_tasks;

/// SQL query implementations for interacting with the database
pub mod sql;

/// Job stream management for processing jobs
pub mod streams;

pub mod context_ext;
pub mod cron;
mod tracing;
/// Utility functions for job management
pub mod worker_utils;

pub use cron::{Cron, CronBuilder};
pub use graphile_worker_crontab_parser::parse_crontab;
pub use graphile_worker_crontab_types::JobKeyMode as CronJobKeyMode;
pub use graphile_worker_crontab_types::{
    Crontab, CrontabField, CrontabFill, CrontabTimer, CrontabTimerError, CrontabValue,
};
pub use graphile_worker_ctx::*;
pub use graphile_worker_database::*;
pub use graphile_worker_job::*;
pub use graphile_worker_job_spec::*;
pub use graphile_worker_lifecycle_hooks::*;
pub use graphile_worker_shutdown_signal::ShutdownSignal;
pub use graphile_worker_task_handler::*;

pub use builder::{CronInput, WorkerBuildError, WorkerOptions};
pub use context_ext::WorkerContextExt;
pub use local_queue::{
    LocalQueue, LocalQueueConfig, LocalQueueError, LocalQueueMode, LocalQueueSignalSender,
    RefetchDelayConfig,
};
pub use recovery::{
    ActiveWorkerRow, SweepStaleWorkersOptions, SweepStaleWorkersResult, WorkerRecoveryConfig,
    INFRASTRUCTURE_RESILIENT_FLAG,
};
pub use runner::Worker;
pub use shutdown::WorkerShutdownConfig;
pub use sql::add_job::types::RawJobSpec;
pub use worker_utils::WorkerUtils;