Socket.IO Postgres adapter

The @socket.io/postgres-adapter package allows broadcasting packets between multiple Socket.IO servers.

Supported features:

• broadcasting
• utility methods
  • socketsJoin
  • socketsLeave
  • disconnectSockets
  • fetchSockets
  • serverSideEmit

Related packages:

• Postgres emitter: https://github.com/socketio/socket.io-postgres-emitter/
• Redis adapter: https://github.com/socketio/socket.io-redis-adapter/
• Redis emitter: https://github.com/socketio/socket.io-redis-emitter/
• MongoDB adapter: https://github.com/socketio/socket.io-mongo-adapter/
• MongoDB emitter: https://github.com/socketio/socket.io-mongo-emitter/

Table of contents

• Installation
• Usage
• License

Installation

npm install @socket.io/postgres-adapter

Usage

const { Server } = require("socket.io");
const { createAdapter } = require("@socket.io/postgres-adapter");
const { Pool } = require("pg");

const io = new Server();

const pool = new Pool({
  user: "postgres",
  host: "localhost",
  database: "postgres",
  password: "changeit",
  port: 5432,
});

pool.query(`
  CREATE TABLE IF NOT EXISTS socket_io_attachments (
      id          bigserial UNIQUE,
      created_at  timestamptz DEFAULT NOW(),
      payload     bytea
  );
`);

pool.on("error", (err) => {
  console.error("Postgres error", err);
});

io.adapter(createAdapter(pool));
io.listen(3000);

License

MIT