postgres-bridge

postgres/pg compatibility layer

Wraps postgres API in a pg compatible API.

Usage

import postgres from 'postgres';
import { createBridge } from 'postgres-bridge';

const PostgresBridge = createBridge(postgres);

// pg.Pool Configuration
const configuration = {
  host: 'localhost',
  user: 'database-user',
  max: 20,
  idleTimeoutMillis: 30000,
  connectionTimeoutMillis: 2000,
};

const pool = new PostgresBridge(configuration);

const connection = await pool.connect();

await pg.query('SELECT $1::text as name', ['foo']);

Motivation

postgres is leaner/faster implementation of PostgreSQL protocol in Node.js than pg. However, postgres API is very different from the more broadly adopted pg client. This package allows to adopt postgres without going through a painful migration. In particular, this compatibility layer has been designed to allow adoption of postgres using Slonik PostgreSQL client.

Scope

postgres-bridge is limited to the API that is consumed by Slonik PostgreSQL client, i.e. Using postgres-bridge you are able to use postgres with Slonik.

Supported features:

• pool.connect
• connection.query
• connect event
• notice event

Known incompatibilities:

• connection.processID not implemented
• pool._pulseQueue not implemented

Please submit PR if you require additional compatibility.

Development

Running postgres-bridge tests requires having a local PostgreSQL instance.

The easiest way to setup a temporary instance for testing is using Docker, e.g.

docker run --rm -it -e POSTGRES_HOST_AUTH_METHOD=trust -p 5432:5432 postgres