Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

pg-boss

Package Overview
Dependencies
Maintainers
1
Versions
205
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pg-boss

Queueing jobs in Node.js using PostgreSQL like a boss

  • 1.0.0-beta2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
43K
decreased by-30.63%
Maintainers
1
Weekly downloads
 
Created
Source

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

npm version Build Status Coverage Status Dependencies Node Version PostgreSql Version

const PgBoss = require('pg-boss');
const 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 (singleton jobs and rate limiting)
  • Configurable worker concurrency
  • 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

Keywords

FAQs

Package last updated on 09 Mar 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc