Arbiter.Core.HighLevel

Constraints for queue operations (requires table name lookup from registry).

Constraints for job operations (table name stored in job).

The constraint that lets the migration collect a registry's declared policies of both kinds.

Insert a job. Returns the job inserted or replaced. Nothing when an IgnoreDuplicate key already exists, or a ReplaceDuplicate key names a job that is in flight (claimed under a live lease), force-cancel-flagged, has a different parent, or has children (DLQ children count).

Insert multiple jobs in one round-trip. Returns the jobs inserted or replaced. An ignored duplicate is left out. Use insertJobTree for parent-child relationships.

insertJobsBatch returning the rows affected, dedup replacements included.

Claim visible jobs, at most one per group, and fewer than the limit once the groups run out. Stamps the anonymous claimant. A concurrency policy caps this path as it caps any other claim. A row whose payload fails to decode moves to the DLQ.

claimNextVisibleJobs under a given worker id. A row whose payload fails to decode moves to the DLQ.

claimNextVisibleJobs claiming up to batchSize jobs from each group, still in per-group order. Stamps the anonymous claimant. A row whose payload fails to decode moves to the DLQ.

Ack a completed job, deleting it or suspending it when its children are still running. Returns 1, or 0 for a job that is gone or reclaimed.

ackJob over a batch from one queue in one statement, returning the ids acked. Gone or reclaimed jobs are absent.

Park a failed job for its retry backoff. Returns 0 for a job another worker holds or a suspended job.

Soft-nack a job. It is reprocessed once its visibility timeout lapses. No failure is recorded and no attempt is consumed. Returns 0 for a job another worker holds, a suspended job, or a released claim.

nackJob that reprocesses the job after a delay instead of at the lease's end.

nackJob over a batch from one queue in one statement, returning the ids nacked. Jobs another worker holds, suspended jobs and released claims are absent.

nackJobsBatch that reprocesses the jobs after a delay instead of at the lease's end.

Extend a job's visibility timeout by hand, for a long-running job. Matches the claim token only. It also extends a job the caller released (nack, retry). Returns 0 for a job that is gone, reclaimed or suspended.

Extend the visibility timeout of a batch from one queue. Each row must still match its holder. A row whose row lock or group lock is busy is skipped.

Result of setting visibility timeout for a single job in a batch.

Add tokens to a key's bucket, clamped to [0, max], and wake any of its throttled jobs. A key without a bucket gets a full bucket and the amount has no effect. Without a policy the bucket stays unchanged and the wake still runs. Returns the number of jobs woken.

Delete reclaimable idle (full) buckets. Returns the number pruned. The worker pool reaper runs this. A full bucket re-seeds at full on next use.

Reset every bucket for a prefix to full and wake its throttled jobs. Returns the number of buckets reset. A manual (0-refill) policy plus a cron calling this at the boundary is a fixed window.

List every rate-limit policy with its params, bucket stats, and a live count of currently-throttled jobs per prefix across the registry's queues.

One prefix's rate-limit policy with its params, bucket stats, and live throttled count. Nothing when the prefix has no policy.

Whether a rate-limit policy exists for a prefix.

List a prefix's buckets with fill levels, emptiest first.

Set or clear a policy's override params and wake the prefix's throttled jobs. Returns rows affected (0 if absent).

Override a policy with this shape, until it is cleared. Returns rows affected.

Drop a policy's overrides. Its declared params apply again. Returns rows affected.

List every concurrency policy with its default/override limit and live key and in-flight aggregates.

One prefix's concurrency policy with its default/override limit and live aggregates. Nothing when the prefix has no policy.

Whether a concurrency policy exists for a prefix.

List a prefix's keys with effective cap and in-flight fill fraction, fullest first.

Apply a concurrency policy's override-limit patch on its policy row, retuning every key under the prefix live. Lowering it never preempts in-flight jobs. Returns rows affected.

Override the policy's limit with its cpLimit, until it is cleared. Returns rows affected.

Drop a concurrency policy's override. Its declared limit applies again. Returns rows affected.

Delete drained concurrency rows with no live job. Returns the number pruned.

Recompute the concurrency counts from live jobs, repairing any trigger drift. Returns the rows repaired.

Rebuild the concurrency counts when a crash truncated the UNLOGGED table. Returns the rows repaired.

Reconcile then prune. Skipped when no concurrency key exists. Returns the rows repaired plus the rows pruned.

A narrowing predicate on a job listing. Filters combine with AND.

Sortable columns on the main jobs table.

Sortable columns on the DLQ table. DlqId is the DLQ primary key and DlqJobId the original job id.

Sortable columns on the archive table. ArchiveId is the archive primary key and ArchiveJobId the original job id.

Sort direction.

List filtered jobs, newest first.

Count filtered jobs.

List filtered DLQ jobs, most recently failed first.

Count filtered DLQ jobs.

List filtered archived jobs, most recently completed first.

Count filtered archived jobs.

Move a job to the DLQ. Returns 0 for a job another worker holds.

Move a batch of jobs to the DLQ, skipping any another worker holds. Returns the number moved.

List DLQ jobs, most recently failed first.

Retry the whole DLQ tree that holds a DLQ row, with a fresh attempt count. The dedup key is left behind. Returns the restored job for that row. Nothing when the row is gone or the root's parent no longer exists.

retryFromDLQ with a replacement payload. The columns the payload derives are derived again from it.

retryFromDLQ over several DLQ rows, each tree in its own transaction. A row restored with an earlier row's tree is skipped. Returns the number of rows whose retry restored a tree.

retryFromDLQBatch over every DLQ row the filters match when it starts, oldest first. No filters retries the whole DLQ.

Whether a DLQ row with the given DLQ primary key exists.

Delete a DLQ job. Returns 0 when the row is already gone.

Delete DLQ jobs by DLQ primary key. Returns the number deleted.

List archived jobs, most recently completed first.

Fetch a single archived job by its original job id.

List archived jobs in a group, most recently completed first, with pagination.

Delete one archived job by its archive primary key. Returns rows deleted.

Delete archived jobs by archive primary key. Returns rows deleted.

Re-enqueue an archived job as a fresh standalone job, keeping the archive row. Returns the new job, or Nothing if the archive row no longer exists.

reEnqueueFromArchive with a replacement payload. The columns the payload derives are derived again from it.

List jobs, newest first.

Fetch a job by id.

Whether a job with the given id exists in this payload's queue table.

A page of a group's jobs, newest first.

List a parent's children, newest first.

Delete a job by id. Returns 0 for a job with children. cancelJobCascade deletes those.

Delete jobs by id. A job with children is skipped. Returns the number deleted.

Cascade-cancel a job subtree. Flags still-live claimed jobs, deletes the rest, and NOTIFYs the queue's cancel channel for every claimed job affected. Returns the number flagged or deleted.

Make a delayed or retrying job immediately visible. Refuses an in-flight or suspended job.

Set when a job next becomes visible. Refuses an in-flight, suspended, force-cancel-flagged or exhausted job.

Per-status breakdown of a queue. The per-status counts partition the queue and sum to totalJobs.

A landing-overview row: a queue's stats, pause flag and worker counts.

One open group, read from the queue's groups summary.

A queue's per-status counts and backlog ages.

Count every job in the queue.

Count a group's jobs.

Count a parent's children.

Count the queue's DLQ jobs.

Child counts as (total, suspended) per parent id, over a batch. Parents with none are absent.

Count a parent's children in the DLQ.

DLQ child counts per parent id, over a batch. Parents with none are absent.

Suspend every unsuspended visible job in a parent's subtree, lapsed leases included. Jobs with a future visibility (delayed, backoff, throttled, leased) are skipped. Returns the number suspended.

Resume the suspended jobs in a parent's subtree. A finalizer with children still in the queue stays suspended. Returns the number resumed.

Delete a job and every descendant under it. Returns the number deleted.

Suspend a job, making it unclaimable. Refuses an in-flight job.

Resume a suspended job. Refuses a finalizer with children still in the main queue.

Upsert a child's result, encoded as the queue's declared result type and keyed by (parent_id, child_id). A second write replaces the first. Its foreign key cascades. Acking the parent clears it. Returns 0 for a result that stores nothing.

insertResult with a raw JSON value, as an upsert, bypassing the queue's declared result type. A value Arbiter.Worker.childResults cannot decode surfaces there as a Left.

A parent's child results, keyed by child id.

The last errors of a parent's children in the DLQ, keyed by child id. Children with no recorded error are left out.

Read all child data for a rollup finalizer. Returns (childId->result, childId->error, parentStateSnapshot, dlqRowId->error).

Merge DLQ errors, child results and the snapshot, left-biased in that order.

Snapshot results into parent_state before DLQ move.