Skip to main content

Module admin

Module admin 

Source

Structs§

CallbackConfig
Configuration for CEL callback expressions.
CallbackDump
JobDump
JobDumpSummary
JobKindDescriptor
JobKindOverview
JobTimelineEvent
ListJobsFilter
List jobs with optional filters.
NamedJobKindDescriptor
NamedQueueDescriptor
QueueDescriptor
Code-declared, operator-facing descriptor for a queue.
QueueOverview
QueueRuntimeConfigSnapshot
Per-queue configuration published by a worker runtime instance.
QueueRuntimeSnapshot
Runtime state for one queue on one worker instance.
QueueRuntimeSummary
Queue-centric runtime/config summary aggregated across worker instances.
RateLimitSnapshot
Snapshot of a per-queue rate limit configuration.
RetryFailedOutcome
Result of a bulk failed-job retry (retry_failed_by_kind / retry_failed_by_queue).
RunDump
RuntimeInstance
A worker runtime instance as exposed through the admin API.
RuntimeOverview
Cluster-wide runtime overview.
RuntimeSnapshotInput
Data written by a worker runtime into the observability snapshot table.
StateTimeseriesBucket
A bucketed count of jobs by state over time.

Enums§

CallbackPollResult
Result of a single poll iteration inside wait_for_callback.
DefaultAction
What resolve_callback should do if no CEL conditions match or no expressions are configured.
QueueRuntimeMode
Runtime concurrency mode for a queue.
ResolveOutcome
Outcome of resolve_callback.
RunDumpSource
StorageCapability
TransitionRole
Operator-selected execution role used during a 0.5.x → 0.6 storage transition. Persisted on awa.runtime_instances so the SQL gate for enter_mixed_transition can require a runtime that will actually execute queue-storage work after routing flips, rather than only inspecting the more permissive storage_capability snapshot (auto-role runtimes report queue_storage while in canonical/prepared but downgrade to canonical_drain_only post-flip).

Functions§

bulk_cancel
Cancel multiple jobs by ID. Only cancels non-terminal jobs.
bulk_retry
Retry multiple jobs by ID. Only retries failed, cancelled, or waiting_external jobs.
cancel
Cancel a single non-terminal job.
cancel_by_unique_key
Cancel a job by its unique key components.
cancel_by_unique_key_tx
Transaction-participating variant of cancel_by_unique_key.
cancel_callback
Cancel (clear) a registered callback for a running job.
cancel_tx
Transaction-participating variant of cancel.
check_callback_state
Check the current state of a job during callback wait.
cleanup_runtime_snapshots
Opportunistically delete long-stale runtime snapshot rows.
cleanup_stale_descriptors
Delete descriptor rows whose last_seen_at is older than max_age.
complete_external
Complete a waiting job via external callback.
complete_external_in_tx
Transaction-aware variant of complete_external (ADR-029). Callers that want to dispatch follow-up specs in the same transaction as the callback completion should drive this directly and own the tx.commit(). See crate::admin::resolve_callback_in_tx for the policy-evaluating counterpart.
discard_failed
Discard (delete) all failed jobs of a given kind.
distinct_kinds
Return all distinct job kinds.
distinct_queues
Return all distinct queue names.
drain_queue
Drain a queue: cancel all non-running, non-terminal jobs.
dump_job
Build a read-only inspection snapshot for one job.
dump_run
Build a read-only inspection snapshot for one attempt.
enter_callback_wait
Transition a running job to waiting_external for the given callback.
fail_external
Fail a waiting job via external callback.
fail_external_in_tx
Transaction-aware variant of fail_external (ADR-029).
flush_dirty_admin_metadata
Drain ALL dirty keys until the backlog is empty.
get_job
Get a single job by ID.
get_job_with_source
Fetch a job plus optional DLQ metadata for admin surfaces that need to distinguish a DLQ row from a normal live or terminal row.
heartbeat_callback
Reset the callback timeout for a long-running external operation.
job_kind_descriptors_for_names
job_kind_overview
job_kind_overviews
Get job-kind overviews for all known kinds.
list_jobs
List jobs matching the given filter.
list_runtime_instances
List all runtime instances ordered with leader/live instances first.
pause_queue
Pause a queue. Affects all workers immediately.
queue_descriptors_for_names
queue_overview
Get one queue overview by name.
queue_overviews
Get queue overviews for all known queues.
queue_runtime_summary
Queue runtime/config summary aggregated across worker snapshots.
recompute_dirty_admin_metadata
Drain one batch of dirty keys and recompute exact cached rows. Returns the number of dirty keys processed in this batch.
refresh_admin_metadata
Full reconciliation of admin metadata counters from base tables.
register_callback
Register a callback for a running job, writing the callback_id and timeout to the database immediately.
register_callback_with_config
Register a callback with optional CEL expressions.
resolve_callback
Resolve a callback by evaluating CEL expressions against the payload.
resolve_callback_in_tx
Transaction-aware variant of resolve_callback (ADR-029).
resume_external
Complete a waiting job and resume the handler with the callback payload.
resume_external_in_tx
Transaction-aware variant of resume_external (ADR-029). Resume is not currently an ADR-029 outcome — the handler keeps running and will emit its own completion event later — so callers that just need payload delivery generally use resume_external. This _in_tx shape exists for symmetry with the other callback transitions and so applications can compose the resume UPDATE with their own transaction-local writes.
resume_queue
Resume a paused queue.
retry
Retry a single failed, cancelled, or waiting_external job.
retry_external
Retry a waiting job via external callback.
retry_external_in_tx
Transaction-aware variant of retry_external (ADR-029).
retry_failed_by_kind
Retry all failed jobs of a given kind.
retry_failed_by_queue
Retry all failed jobs in a given queue.
runtime_overview
Cluster runtime overview with instance list.
state_counts
Count jobs grouped by state.
state_timeseries
Return time-bucketed state counts over the last N minutes.
sync_job_kind_descriptors
Upsert job-kind descriptors declared by the worker runtime. Batched the same way as sync_queue_descriptors.
sync_queue_descriptors
Upsert queue descriptors declared by the worker runtime.
take_callback_payload
Extract the _awa_callback_result key from metadata and clean it up.
upsert_runtime_snapshot
Upsert a runtime observability snapshot for one worker instance.