pgmq-js

Postgres Message Queue (PGMQ) JavaScript Client Library, supports Transaction, supports Route routing to implement the Exchange functionality of the MQ queue.

以下所有命令行操作都在 git-bash 窗口中执行

Install global deps for development

npm i -g c8 lerna madge rollup tsx zx

Tested with

• PGMQ v1.5.0

Packages

Package	Version
pgmq-js
@mwcp/pgmq

Installation

npm i @waiting/pgmq-js
// or for midway.js
npm i @mwcp/pgmq

Prepare

Start a Postgres instance with the PGMQ extension installed:

docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pg17-pgmq:latest

Create the pgmq extension and necessary tables

export cwd=`pwd`
.scripts/ci/ci-init-db.sh

Supported API

• Sending Messages
  • send
  • send_batch
• Reading Messages
  • read
  • read_with_poll
  • pop
• Deleting/Archiving Messages
  • delete (single)
  • delete (batch)
  • purge_queue
  • archive (single)
  • archive (batch)
• Queue Management
  • create
  • create_partitioned see Partition
  • create_unlogged
  • detach_archive
  • drop_queue
• Utilities
  • set_vt
  • list_queues
  • metrics
  • metrics_all
• Partition
  • create_partitioned
  • show_partitions
  • run_maintenance

License

MIT

Languages

• English
• 中文