Waddler <> PostgreSQL

Waddler has native support for PostgreSQL connections with the node-postgres and postgres.js drivers.

There are a few differences between the node-postgres and postgres.js drivers that we discovered while using both and integrating them with the Waddler. For example:

• With node-postgres, you can install pg-native to boost the speed of node-postgres by approximately 10%.
• node-postgres supports providing type parsers on a per-query basis without globally patching things. For more details, see Types Docs.
• postgres.js uses prepared statements by default, which you may need to opt out of. This could be a potential issue in AWS environments, among others, so please keep that in mind.
• If there’s anything else you’d like to contribute, we’d be happy to receive your PRs here

node-postgres

Step 1 - Install packages

npm i waddler pg
npm i -D @types/pg

yarn add waddler pg
yarn add -D @types/pg

pnpm add waddler pg
pnpm add -D @types/pg

bun add waddler pg
bun add -D @types/pg

Step 2 - Initialize the driver and make a query

import 'dotenv/config';
import { waddler } from 'waddler/node-postgres';

const sql = waddler(process.env.DATABASE_URL!);
const result = await sql`select 1;`;

import 'dotenv/config';
import { waddler } from 'waddler/node-postgres';

// You can specify any property from the node-postgres connection options
const sql = waddler({ 
  connection: { 
    connectionString: process.env.DATABASE_URL!,
    ssl: true
  }
});
const result = await sql`select 1;`;

If you need to provide your existing driver:

// Make sure to install the 'pg' package 
import { waddler } from "waddler/node-postgres";
import pg from 'pg';

const { Pool } = pg;

const pool = new Pool({
  connectionString: process.env.DATABASE_URL,
});
const sql = waddler({ client: pool });
 
const result = await sql`select 1;`;

import 'dotenv/config';
import { waddler } from 'waddler/node-postgres';
import { queryStream } from 'waddler/extensions/pg-query-stream';
import pg from 'pg';

const { Pool } = pg;

const pool = new Pool({
  connectionString: process.env.DATABASE_URL!,
});

const sql = waddler({ client: pool, extensions: [queryStream()] });

const stream = sql`select 1;`.stream();
for await (const row of stream) {
  ...
}

postgres.js

Step 1 - Install packages

npm i waddler postgres

yarn add waddler postgres

pnpm add waddler postgres

bun add waddler postgres

Step 2 - Initialize the driver and make a query

import { waddler } from 'waddler/postgres-js';

const sql = waddler(process.env.DATABASE_URL);

const result = await sql`select 1;`;

import { waddler } from 'waddler/postgres-js';

// You can specify any property from the postgres-js connection options
const sql = waddler({ 
  connection: { 
    url: process.env.DATABASE_URL, 
    ssl: true 
  }
});

const result = await sql`select 1;`;

If you need to provide your existing driver:

// Make sure to install the 'postgres' package
import { waddler } from 'waddler/postgres-js';
import postgres from 'postgres';

const queryClient = postgres(process.env.DATABASE_URL);
const sql = waddler({ client: queryClient });

const result = await sql`select 1;`;