Expand description
Awa — Postgres-native background job queue for Rust and Python.
This is the facade crate that re-exports the main types from awa-model, awa-macros, and awa-worker for ergonomic usage.
Re-exports§
pub use awa_model as model;pub use awa_worker as worker;
Modules§
- admin
- bridge
- Transactional enqueue for non-sqlx Postgres stacks.
- insert
- migrations
- storage
Structs§
- Callback
Config - Configuration for CEL callback expressions.
- Callback
Guard - Proof that this job registered an external callback in the database.
- Client
- The Awa worker client — manages dispatchers, heartbeat, and maintenance.
- Client
Builder - Builder for the Awa worker client.
- DlqMetadata
- DlqRow
- Health
Check - Health check result.
- Insert
Opts - Options for inserting a job.
- Insert
Params - Parameters for bulk insert.
- JobContext
- Context passed to worker handlers during job execution.
- JobKind
Descriptor - JobRow
- A row from the
awa.jobstable. - List
DlqFilter - Periodic
Job - A periodic job schedule definition.
- Periodic
JobBuilder - Builder for
PeriodicJob. - Progress
State - Mutable progress buffer shared between handler and heartbeat service.
- Queue
Config - Configuration for a single queue.
- Queue
Descriptor - Code-declared, operator-facing descriptor for a queue.
- Queue
Health - Per-queue health.
- Rate
Limit - Rate limit configuration for a queue.
- Retention
Policy - Per-queue or global retention policy for completed and failed/cancelled jobs.
- Retry
From DlqOpts - Storage
Status - Unique
Opts - Uniqueness constraint options.
Enums§
- AwaError
- Build
Error - Errors returned when building a worker client.
- Default
Action - What
resolve_callbackshould do if no CEL conditions match or no expressions are configured. - JobError
- Error type for job handlers — any error is retryable unless it’s terminal.
- JobEvent
- Typed lifecycle event for a specific job argument type.
- JobResult
- Result of executing a job handler.
- JobState
- Job states in the lifecycle state machine.
- Queue
Capacity - Capacity information for a queue, mode-dependent.
- Resolve
Outcome - Outcome of
resolve_callback. - Storage
Capability - Untyped
JobEvent - Untyped lifecycle event keyed only by job kind.
Traits§
Functions§
- insert
- Insert a job with default options.
- insert_
many - Insert multiple jobs in a single statement.
- insert_
many_ copy - Insert many jobs using COPY for high throughput.
- insert_
many_ copy_ from_ pool - Convenience wrapper that acquires a connection from the pool.
- insert_
with - Insert a job with custom options.
Type Aliases§
Derive Macros§
- JobArgs
- Derive macro for job argument types.