# bun-boss

> An experimental Bun-first job queue on PostgreSQL, embedded PGlite, and embedded SQLite (a fork of pg-boss). Exactly-once delivery via SKIP LOCKED, with cron scheduling, workers, queues, and job flows.

The full documentation concatenated into a single file is available at https://raw.githubusercontent.com/khromov/bun-boss/main/docs/llms-full.txt.

## Docs

- [Introduction](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/introduction.md): bun-boss is a job queue that runs on Postgres, PGlite, or SQLite, operated by 1 or more Bun instances.
- [Database install](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/install.md): bun-boss will automatically create a dedicated schema (`pgboss` is the default name) in the target database.
- [Database Backends](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/database-backends.md): bun-boss runs on stock single-node PostgreSQL by default.
- [Constructor](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/constructor.md): Passing a string argument to the constructor implies a PostgreSQL connection string, passed to [Bun's SQL client](https://bun.com/docs/api/sql) as its connection URL.
- [Jobs](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/jobs.md): Creates a new job and returns the job id.
- [Workers](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/workers.md): Adds a new polling worker for a queue and executes the provided callback function when jobs are found.
- [Queues](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/queues.md): Creates a queue.
- [Scheduling](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/scheduling.md): Jobs may be created automatically based on a cron expression.
- [Operations](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/ops.md): Returns the same BunBoss instance used during invocation
- [Events](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/events.md): Each bun-boss instance is an EventEmitter, and contains the following events.
- [Database Adapters](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/adapters.md): bun-boss operations such as `send()`, `insert()`, `fetch()`, and `complete()` accept a `db` option that lets you run them inside an existing database transaction.
- [Testing](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/testing.md): bun-boss includes built-in spy support to help write fast, deterministic tests without polling or arbitrary delays.
- [Utility functions](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/api/utils.md): The following function is exported from the package and is not required during normal operations, but is intended to assist in schema creation if run-time privileges do not allow schema changes.
- [Job table](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/sql/job-table.md): If you need to interact with bun-boss outside of Bun, such as other clients or even using triggers within PostgreSQL itself, most functionality is supported when working directly against the internal 
- [Queue functions](https://raw.githubusercontent.com/khromov/bun-boss/main/docs/sql/queue-functions.md): Queues can be created or deleted from SQL functions.