Struct SqliteQueueBackend 

pub struct SqliteQueueBackend { /* private fields */ }

SQLite-backed queue backend.

Suitable for Mode 1 embedded boots and for Mode 2 when both binaries open the same path. For multi-host fleets prefer Postgres, Redis, or NATS.

Mode 2 examples: enqueue / worker.

Implementations

impl SqliteQueueBackend

pub async fn new( path: impl AsRef<Path>, ) -> Result<SqliteQueueBackend, BosonError>

Open a SQLite database at path (creates the file if missing).

See crate-level Mode 2 — Enqueue binary and Mode 2 — Worker binary.

Examples

use std::sync::Arc;

use boson_backend_sqlite::SqliteQueueBackend;
use boson_core::JsonExecutionContextFactory;
use boson_runtime::Boson;

let path = std::env::var("BOSON_SQLITE_PATH").unwrap_or_else(|_| "/tmp/boson.db".into());
let backend = SqliteQueueBackend::new(&path).await?;
let _boson = Boson::builder()
    .queue_backend(Arc::new(backend))
    .execution_context_factory(JsonExecutionContextFactory)
    .auto_registry()
    .build()?;

Errors

Returns an error when the database cannot be opened or schema bootstrap fails.

pub async fn connect(url: &str) -> Result<SqliteQueueBackend, BosonError>

Connect using a SQLite connection URL.

Errors

Returns an error when the pool cannot connect or schema bootstrap fails.

pub async fn from_pool( pool: Pool<Sqlite>, ) -> Result<SqliteQueueBackend, BosonError>

Wrap an existing pool (schema bootstrap runs).

Errors

Returns an error when schema bootstrap fails.

pub fn pool(&self) -> &Pool<Sqlite>

Underlying connection pool.

Panics

Panics if the inner pool is not SQLite (internal invariant violation).

Trait Implementations

impl Debug for SqliteQueueBackend

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

Formats the value using the given formatter.

impl QueueBackend for SqliteQueueBackend

fn upsert_job<'life0, 'life1, 'async_trait>( &'life0 self, job: &'life1 Job, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Persist or update a job row.

fn enqueue_with_policies<'life0, 'life1, 'async_trait>( &'life0 self, job: Job, task_config: &'life1 TaskConfig, ) -> Pin<Box<dyn Future<Output = Result<(String, JobEnqueueDisposition), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Insert job with idempotency semantics (see trait-level contract).

fn get_job<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Job>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Load one job by id.

fn list_jobs<'life0, 'async_trait>( &'life0 self, status_filter: Option<JobStatus>, offset: usize, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Job>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteQueueBackend: 'async_trait,

List jobs with optional status filter and pagination.

fn cancel_job_if_active<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Cancel a job if it is still active (queued or running).

fn try_claim_job<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Job>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Atomically claim a queued job for execution.

fn revert_job_to_queued<'life0, 'life1, 'async_trait>( &'life0 self, job_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Revert a job to queued (retry path).

fn distinct_pools_queued<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteQueueBackend: 'async_trait,

Distinct pool names with queued jobs.

fn list_queued_for_pool_sorted<'life0, 'life1, 'async_trait>( &'life0 self, pool: &'life1 str, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Job>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Queued jobs for one pool, sorted by priority then created time.

fn count_jobs<'life0, 'async_trait>( &'life0 self, status_filter: Option<JobStatus>, ) -> Pin<Box<dyn Future<Output = Result<u64, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteQueueBackend: 'async_trait,

Count jobs, optionally filtered by status.

fn count_jobs_for_task<'life0, 'life1, 'async_trait>( &'life0 self, task_name: &'life1 str, status: Option<JobStatus>, ) -> Pin<Box<dyn Future<Output = Result<u64, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Count jobs for one task, optionally filtered by status.

fn count_active_jobs_for_task<'life0, 'life1, 'async_trait>( &'life0 self, task_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<u32, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Count active (queued + running) jobs for rate-limit checks.

fn find_nonterminal_by_idempotency_key<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Find non-terminal job by idempotency key.

fn upsert_run<'life0, 'life1, 'async_trait>( &'life0 self, run: &'life1 Run, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Persist or update a run row.

fn get_run<'life0, 'life1, 'async_trait>( &'life0 self, run_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Run>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Load one run by id.

fn list_runs<'life0, 'life1, 'async_trait>( &'life0 self, job_id_filter: Option<&'life1 str>, offset: usize, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Run>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

List runs with optional job filter and pagination.

fn finish_run<'life0, 'life1, 'async_trait>( &'life0 self, run_id: &'life1 str, status: RunStatus, duration_ms: Option<i64>, error_message: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Mark a run terminal with outcome fields.

fn count_runs<'life0, 'life1, 'async_trait>( &'life0 self, job_id_filter: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<u64, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Count runs, optionally filtered by job id.

fn count_runs_since<'life0, 'async_trait>( &'life0 self, since: DateTime<Utc>, ) -> Pin<Box<dyn Future<Output = Result<u64, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteQueueBackend: 'async_trait,

Count runs with started_at >= since.

fn task_run_stats<'life0, 'life1, 'async_trait>( &'life0 self, task_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<TaskRunStats, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Aggregate run totals for one task.

fn get_task_config<'life0, 'life1, 'async_trait>( &'life0 self, task_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<TaskConfig>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Load task config by name.

fn upsert_task_config<'life0, 'life1, 'async_trait>( &'life0 self, config: &'life1 TaskConfig, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Persist task config.

fn try_claim_run_lease<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, job_id: &'life1 str, worker_id: &'life2 str, ttl_secs: i64, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteQueueBackend: 'async_trait,

Attempt to claim a run lease for job_id (stored as lease task id).

fn extend_lease<'life0, 'life1, 'async_trait>( &'life0 self, lease_id: &'life1 str, ttl_secs: i64, ) -> Pin<Box<dyn Future<Output = Result<(), BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Extend lease TTL for a held lease.

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

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteQueueBackend: 'async_trait,

Release a held lease.

fn expired_lease_job_pairs<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<(String, String)>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteQueueBackend: 'async_trait,

Expired leases as (lease_record_id, job_id).

fn pop_claim_from_pool<'life0, 'life1, 'async_trait>( &'life0 self, _pool: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Job>, BosonError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Atomically claim the highest-priority queued job from pool when supported.