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

1import { Server } from "socket.io";
2import { createAdapter } from "@socket.io/postgres-adapter";
3import pg from "pg";
4
5const io = new Server();
6
7const pool = new pg.Pool({
8  user: "postgres",
9  host: "localhost",
10  database: "postgres",
11  password: "changeit",
12  port: 5432,
13});
14
15pool.query(`
16  CREATE TABLE IF NOT EXISTS socket_io_attachments (
17      id          bigserial UNIQUE,
18      created_at  timestamptz DEFAULT NOW(),
19      payload     bytea
20  );
21`);
22
23pool.on("error", (err) => {
24  console.error("Postgres error", err);
25});
26
27io.adapter(createAdapter(pool));
28io.listen(3000);

License

MIT