node package manager

pg-boss

Queueing jobs in Node.js using PostgreSQL like a boss.

PostgreSql Version npm version Build Status Coverage Status Dependencies

const PgBoss = require('pg-boss');
const boss = new PgBoss('postgres://user:pass@host/database');
 
boss.on('error', onError);
 
boss.start()
  .then(ready)
  .catch(onError);
 
function ready() {
  boss.publish('some-job', {param1: 'parameter1'})
    .then(jobId => console.log(`created some-job ${jobId}`))
    .catch(onError);
 
  boss.subscribe('some-job', someJobHandler)
    .then(() => console.log('subscribed to some-job'))
    .catch(onError);
}
 
function someJobHandler(job) {
  console.log(`received ${job.name} ${job.id}`);
  console.log(`data: ${JSON.stringify(job.data)}`);
 
  job.done()
    .then(() => console.log(`some-job ${job.id} completed`))
    .catch(onError);
}
 
function onError(error) {
  console.error(error);
}

pg-boss is a message queue (aka job queue, task queue) built in Node.js on top of PostgreSQL in order to provide guaranteed messaging and asynchronous execution to your Node apps.

Why would you consider using this queue over others? pg-boss was created to leverage recent additions in PostgreSQL 9.5 (specifically SKIP LOCKED and upserts) which significantly enhance its ability to act as a reliable, distributed message queue. I wrote this to remove a dependency on Redis (via the kue package), consolidating systems I have to support in production as well as upgrading to guaranteed message processing (hint: Redis persistence docs).

This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (querying and backups, for example).

Features

  • Guaranteed delivery and finalizing of jobs using a promise API
  • Delayed jobs
  • Job retries
  • Job throttling (singleton jobs and rate limiting)
  • Configurable job concurrency
  • Distributed and/or clustered workers
  • State-based subscriptions to support orchestrations/sagas
  • Ad-hoc job fetching and completion for external integrations (such as web APIs)
  • Automatic provisioning of required storage into a dedicated schema
  • Automatic monitoring for expired jobs
  • Automatic archiving for completed jobs

Requirements

  • Node 4 or higher
  • PostgreSQL 9.5 or higher

Installation

$ npm install pg-boss

Documentation