cuulee / pg-boss Goto Github PK

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

var PgBoss = require('pg-boss');
var boss = new PgBoss('postgres://username:password@localhost/database');
        
boss.start()
    .then(ready)
    .catch(error => console.error(error));

function ready() {
    boss.publish('work', {message: 'stuff'})
        .then(jobId => console.log(`sent job ${jobId}`));

    boss.subscribe('work', (job, done) => {
        console.log(`received job ${job.name} (${job.id})`);
        console.log(JSON.stringify(job.data));

        done().then(() => console.log('Confirmed done'));
    });
}

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 enhances 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 and well as upgrading to guaranteed message processing. This will likely cater to anyone already familiar with the simplicity of relational database semantics and operations (querying and backups, for example) as well as a low budget solution to a very common problem.

##Features

• Guaranteed delivery and finalizing of jobs using a promise API
• Delayed jobs
• Job retries
• Job throttling (rate limiting)
• Distributed and/or clustered workers
• Automatic provisioning of required storage into a dedicated schema
• Automatic monitoring for expired jobs
• Automatic archiving for completed jobs

##Requirements

• Node 0.10 or higher
• PostgreSQL 9.5 or higher

##Installation $ npm install pg-boss

##Documentation

• API
• Configuration