@socket.io/postgres-adapter

Socket.IO Postgres adapter

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

Table of contents

• Supported features
• Installation
• Usage
• License

Supported features

Feature	socket.io version	Support
Socket management	4.0.0	:white_check_mark: YES (since version 0.1.0)
Inter-server communication	4.1.0	:white_check_mark: YES (since version 0.1.0)
Broadcast with acknowledgements	4.5.0	:white_check_mark: YES (since version 0.3.0)
Connection state recovery	4.6.0	:x: NO

Installation

npm install @socket.io/postgres-adapter

Usage

import { Server } from "socket.io";
import { createAdapter } from "@socket.io/postgres-adapter";
import pg from "pg";

const io = new Server();

const pool = new pg.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

Changelog

0.4.0 (2024-07-17)

This release contains an important refactor of the adapter (this commit), as most of the logic has been moved in the ClusterAdapter class of the socket.io-adapter package.