pglite-server

KO | EN

gitlite — search

#python #hacktoberfest #ai #go #android #machine-learning #deep-learning #linux #macos #nodejs #windows #awesome #kubernetes #openai

(★ 86)

Wire Protocol Server for PGlite. A spare-time attempt to understand Postgres Wire Protocol and expose a TCP server, that can be used to redirect all client requests to PGlite instance.

pglite-server Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Wire Protocol Server for PGlite

> [!TIP]
> If you are looking for more versatile and feature-rich solution, check [`pg-gateway`](https://github.com/supabase-community/pg-gateway) from [Supabase](https://supabase.com/) instead.

A spare-time attempt to understand Postgres Wire Protocol and expose a TCP server,
that can be used to redirect all client requests to [PGlite](https://github.com/electric-sql/pglite) instance.

This can be used to connect to a running instance via `pgsql` or in the future,
run a https://postgrest.org/ on top of said `PGlite` instance and automatically create a temporary, in-memory API endpoints.

- https://www.postgresql.org/docs/current/protocol.html
- https://www.postgresql.org/docs/current/protocol-message-formats.html

It intercepts `SSLRequest` and `StartupMessage` messages to fake authentication flow and redirects all remaining packets directly to `PGlite` instance.

## Usage

```sh
npm install pglite-server
```

```ts
import { PGlite } from "@electric-sql/pglite";
import { createServer } from "pglite-server";

const db = new PGlite();
await db.waitReady;

await db.exec(`
  create table if not exists test (id serial primary key, name text);
  insert into test (name) values ('foo'), ('bar'), ('baz');
`);

const PORT = 5432;
const pgServer = createServer(db);

pgServer.listen(PORT, () => {
  console.log(`Server bound to port ${PORT}`);
});
```

```
$ psql -h localhost -p 5432 -U postgres
postgres=> select * from test;
postgres=> \q
```

or without `db.exec` used above

```
$ psql -h localhost -p 5432 -U postgres
postgres=> create table if not exists test (id serial primary key, name text);
postgres=> insert into test (name) values ('foo'), ('bar'), ('baz');
postgres=> select * from test;
postgres=> \q
```

### Using with `pg` client

See `test/main.ts` for more detailed example, but here's a quick excerpt:

```ts
import { PGlite } from "@electric-sql/pglite";
import { Client } from "pg";
import { createServer } from "pglite-server";

const PORT = 5432;
const db = new PGlite();
await db.waitReady;
await db.exec(`
  create table if not exists test (id serial primary key, name text);
  insert into test (name) values ('foo'), ('bar'), ('baz');
`);

const pgServer = createServer(db);

pgServer.listen(PORT, async () => {
  const client = new Client({
    host: "localhost",
    port: PORT,
    database: "postgres",
    user: "postgres",
  });
  await client.connect();
  const res = await client.query("select * from test");
  console.log(res.rows);
});
```

### Options

If you want to see all debug output of the network communication, set `logLevel` to `Debug`:

```ts
import { createServer, LogLevel } from "pglite-server";

const pgServer = createServer(db, {
  logLevel: LogLevel.Debug,
});

pgServer.listen();
```

## Developing

This repo uses https://bun.sh/ because I don't want to spend time fighting with Node and TypeScript tooling.

Make sure that it's available before running tests, or write your own ts-loader config, ts-node, or whatever people use these days.

```sh
bun run test
bun run build
```

## Debugging

Debugging network traffic with `tshark` - https://zignar.net/2022/09/24/using-tshark-to-monitor-pg-traffic/

```sh
brew install wireshark
```

```sh
tshark -i lo -f 'tcp port 5432' -d tcp.port==5432,pgsql -T fields -e pgsql.length -e pgsql.type -e pgsql.query
```

## Publishing

```
npm version <patch|minor|major>
git push
bun run build
npm publish
```

pglite-server

pglite-server Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pglite-server

pglite-server Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README