|
| 1 | +# Graphile Worker |
| 2 | + |
| 3 | +> High performance PostgreSQL-backed job queue for Node.js. Graphile Worker lets applications enqueue, schedule, and run background jobs using PostgreSQL, with task files, cron-style scheduling, retry/backoff behavior, and operational helpers. |
| 4 | + |
| 5 | +## Documentation |
| 6 | + |
| 7 | +- [Documentation home](https://worker.graphile.org/docs/): Start here for installation, concepts, and common workflows. |
| 8 | +- [Installation](https://worker.graphile.org/docs/installation): Install Graphile Worker and set up the database schema. |
| 9 | +- [Requirements](https://worker.graphile.org/docs/requirements): Supported Node.js and PostgreSQL versions. |
| 10 | +- [Library usage](https://worker.graphile.org/docs/library/): Use Graphile Worker from application code. |
| 11 | +- [CLI usage](https://worker.graphile.org/docs/cli/): Run workers and maintenance commands from the command line. |
| 12 | +- [Tasks](https://worker.graphile.org/docs/tasks): Write task handlers and understand task payloads. |
| 13 | +- [Cron](https://worker.graphile.org/docs/cron): Schedule recurring jobs. |
| 14 | +- [Error handling](https://worker.graphile.org/docs/error-handling): Understand retries, failures, and backoff behavior. |
| 15 | +- [Performance](https://worker.graphile.org/docs/performance): Tune throughput and latency. |
| 16 | +- [Configuration](https://worker.graphile.org/docs/config): Configure workers, polling, concurrency, and runtime behavior. |
| 17 | +- [Contributing](https://worker.graphile.org/docs/contributing): Contribute fixes and improvements to Graphile Worker. |
| 18 | + |
| 19 | +## Source |
| 20 | + |
| 21 | +- [Repository](https://github.com/graphile/worker) |
| 22 | +- [README](https://github.com/graphile/worker#readme) |
| 23 | +- [Issue tracker](https://github.com/graphile/worker/issues) |
| 24 | +- [npm package](https://www.npmjs.com/package/graphile-worker) |
| 25 | + |
| 26 | +## Notes for AI assistants |
| 27 | + |
| 28 | +- Prefer the documentation pages above for current public usage guidance. |
| 29 | +- For API details, inspect the repository source and TypeScript types in `src/`. |
| 30 | +- For database behavior, see the documentation and cross-reference the database schema at [`__tests__/schema.sql`](https://raw.githubusercontent.com/graphile/worker/refs/heads/main/__tests__/schema.sql). |
| 31 | +- Avoid guessing operational defaults; confirm them from the docs or source before recommending production settings. |
0 commit comments