gem-hunter
Language: TypeScript
Queueing jobs in Postgres from Node.js like a boss
Queueing jobs in Postgres from Node.js like a boss.
async function readme() { const { PgBoss } = require('pg-boss'); const boss = new PgBoss('postgres://user:pass@host/database'); boss.on('error', console.error) await boss.start() const queue = 'readme-queue' await boss.createQueue(queue) const id = await boss.send(queue, { arg1: 'read me' }) console.log(`created job ${id} in queue ${queue}`) await boss.work(queue, async ([ job ]) => { console.log(`received job ${job.id} with data ${JSON.stringify(job.data)}`) }) } readme() .catch(err => { console.log(err) process.exit(1) })
pg-boss is a job queue built in Node.js on top of PostgreSQL in order to provide background processing and reliable asynchronous execution to Node.js applications.
pg-boss relies on Postgres's SKIP LOCKED, a feature built specifically for message queues to resolve record locking challenges inherent with relational databases. Concurrent workers claim jobs without blocking each other, and job processing gets the safety of guaranteed atomic commits.
This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (SQL, querying, and backups). It will be especially useful to those already relying on PostgreSQL that want to limit how many systems are required to monitor and support in their architecture.
pg-boss includes a command-line interface if needed for managing database migrations without writing code. This is useful for CI/CD pipelines, database setup scripts, or manual schema management.
See the CLI documentation for details.
A web-based dashboard is available in the @pg-boss/dashboard package for monitoring and managing jobs, queues and schedules.
See the dashboard documentation for details.
A HTTP proxy is available in the @pg-boss/proxy package if needed to support use cases such as platform compatibility and connection pooling or scalability.
See the proxy documentation for details.
pg-boss is MIT licensed and always will be. It is maintained by one person, and sponsorship is what pays for the maintenance, security response, and support behind it.
Become a sponsor, or see everyone who already does on the sponsors page.
To setup a development environment for this library:
git clone https://github.com/timgit/pg-boss.git npm install
To run the test suite, linter and code coverage:
npm run cover
The test suite will try and create a new database named pgboss. The config.json file has the default credentials to connect to postgres.
The Docker Compose file can be used to start a local postgres instance for testing:
docker compose up