PG-SOCKET

Runs a socket.io server with events for changes from configured postgres database

Supported ENV Variables

Database Configuration (Required)

DB_DATABASE - Database Name
DB_HOST - Database Host
DB_PORT - Database Port
DB_USER - Database User
DB_PASSWORD - Database Password

or

DATABASE_URL - Postgres Connection String (ex: postgres://user:password@host:port/database?schema=public)

Optional Configs

WHITELISTED_TABLES - Comma Separated List of Tables to watch, if not set, all tables will be watched
BLACKLISTED_TABLES - Comma Separated List of Tables to ignore. Ignored in case WHITELISTED_TABLES is set
SOCKET_PORT - Port to run socket.io server on, defaults to 4000. Can be overridden by -p flag

Example Usage

CLI

1npx pg-socket #-p 4001

package.json

Additionally env-cmd can be used to load the environment variables

1yarn add -D pg-socket env-cmd

1{
2  "scripts": {
3    "pg:socket": "env-cmd --silent pg-socket"
4  }
5}

Docker

1docker run -p 4000:4000 -e DB_DATABASE=postgres -e DB_HOST=localhost -e DB_PORT=5432 -e DB_USER=postgres -e DB_PASSWORD=postgres -e WHITELISTED_TABLES=users,posts -e SOCKET_PORT=4000 -d pg-socket

Docker Compose

1version: "3"
2
3services:
4  app:
5    build:
6      context: .
7    image: my-app-backend-img
8    container_name: my-app-backend
9    restart: unless-stopped
10  redis:
11    image: redis
12    container_name: my-app-redis
13    restart: unless-stopped
14  pg-socket:
15    image: ashrhmn/pg-socket
16    container_name: my-app-pg-socket
17    restart: unless-stopped
18    # Set ENV Variables in .env file
19    env_file:
20      - .env
21    # Or set ENV Variables here
22    environment:
23      - DATABASE_URL=postgres://user:password@host:port/database?schema=public
24      - WHITELISTED_TABLES=users,items
25      - SOCKET_PORT=4000
26

Client Side Usage

Socket will emit events for each table that is watched. The event name will be the table name. The event payload will be empty.

Global watch event will be emitted on the all event. The payload will be the table name.

1// Client Side
2import { io } from "socket.io-client";
3
4export const socket = io(
5  process.env.NEXT_PUBLIC_SOCKET_URL
6);
7
8socket.on("products", ()=>{
9    // Do something
10});
11
12
13socket.on("all", (tableName)=>{
14  if(tableName === "products"){
15    // Do something
16  }
17});