Nutritious Pomegranate Muffins
    Have ideas to improve npm?Join in the discussion! »

    pg-boss
    TypeScript icon, indicating that this package has built-in type declarations

    5.2.3 • Public • Published

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

    PostgreSql Version npm version Build Status Coverage Status

    async function readme() {
      const PgBoss = require('pg-boss');
      const boss = new PgBoss('postgres://user:pass@host/database');
    
      boss.on('error', error => console.error(error));
    
      await boss.start();
    
      const queue = 'some-queue';
    
      let jobId = await boss.publish(queue, { param1: 'foo' })
    
      console.log(`created job in queue ${queue}: ${jobId}`);
    
      await boss.subscribe(queue, someAsyncJobHandler);
    }
    
    async function someAsyncJobHandler(job) {
      console.log(`job ${job.id} received with data:`);
      console.log(JSON.stringify(job.data));
    
      await doSomethingAsyncWithThis(job.data);
    }

    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 SKIP LOCKED, a feature introduced in PostgreSQL 9.5 written specifically for message queues, in order to resolve record locking challenges inherent with relational databases. This brings the safety of guaranteed atomic commits of a relational database to your asynchronous job processing.

    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.

    Features

    • Backpressure-compatible subscriptions for monitoring queues on an interval (with configurable concurrency)
    • Distributed cron-based job scheduling with database clock synchronization
    • Job deferral, retries (with exponential backoff), throttling, rate limiting, debouncing
    • Job completion subscriptions for orchestrations/sagas
    • Direct publish, fetch and completion APIs for custom integrations
    • Batching API for chunked job fetching
    • Direct table access for bulk loads via COPY or INSERT
    • Multi-master compatible when running multiple instances (for example, in a Kubernetes ReplicaSet)
    • Automatic provisioning of required storage into a dedicated schema
    • Automatic maintenance operations to manage table growth

    Requirements

    • Node 10 or higher
    • PostgreSQL 9.5 or higher

    Installation

    # npm
    npm install pg-boss
    
    # yarn
    yarn add pg-boss

    Documentation

    Install

    npm i pg-boss

    DownloadsWeekly Downloads

    6,333

    Version

    5.2.3

    License

    MIT

    Unpacked Size

    110 kB

    Total Files

    16

    Last publish

    Collaborators

    • avatar