Adaptador Postgres

Cómo funciona​

El adaptador Postgres se basa en los comandos NOTIFY y LISTEN.

Cada paquete que se envía a múltiples clientes (ej. io.to("room1").emit() o socket.broadcast.emit()) es:

• enviado a todos los clientes coincidentes conectados al servidor actual
• si el paquete contiene datos binarios o supera el límite de 8000 bytes, el paquete es:
  • codificado con msgpack e insertado en una tabla auxiliar
  • el ID de fila se envía dentro de un comando NOTIFY
  • este ID de fila es recibido por los otros servidores Socket.IO del clúster, que consultan la tabla, decodifican el paquete y luego lo transmiten a su propio conjunto de clientes conectados
• de lo contrario, el paquete simplemente se envía dentro de un comando NOTIFY y es recibido por los otros servidores Socket.IO del clúster

El código fuente de este adaptador se puede encontrar aquí.

Características soportadas​

Instalación​

npm install @socket.io/postgres-adapter pg

Para usuarios de TypeScript, también podrías necesitar @types/pg.

Uso​

Independiente​

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

const io =newServer();

const pool =newpg.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("Error de Postgres", err);
});

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

Opciones​

Preguntas frecuentes​

¿Todavía necesito habilitar sesiones sticky al usar el adaptador Postgres?​

Sí. No hacerlo resultará en respuestas HTTP 400 (estás llegando a un servidor que no conoce la sesión Socket.IO).

Más información se puede encontrar aquí.

¿Qué pasa cuando el servidor Postgres está caído?​

En caso de que la conexión al servidor Postgres se corte, los paquetes solo se enviarán a los clientes que están conectados al servidor actual.

Últimas versiones​

Changelog completo

Emitter​

El emitter Postgres permite enviar paquetes a los clientes conectados desde otro proceso Node.js:

Instalación​

npm install @socket.io/postgres-emitter pg

Uso​

import{Emitter}from"@socket.io/postgres-emitter";
import{Pool}from"pg";

const pool =newPool({
user:"postgres",
password:"changeit",
});

const emitter =newEmitter(pool);

setInterval(()=>{
 emitter.emit("ping",newDate());
},1000);

Por favor consulta la hoja de referencia aquí.

Últimas versiones​

Changelog completo