Waddler <> CockroachDB

This guide assumes familiarity with:

node-postgres basics

Waddler has native support for CockroachDB connections with the node-postgres driver.

Step 1 - Install packages

npm

yarn

pnpm

bun

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

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

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

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

Step 2 - Initialize the driver and make a query

cockroach

cockroach with config

import 'dotenv/config';
import { waddler } from 'waddler/cockroach';

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

const result = await sql`select 1;`;

import 'dotenv/config';
import { waddler } from 'waddler/cockroach';

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

const result = await sql`select 1;`;

If you need to provide your existing driver:

with existing driver

with pg-query-stream extension

import 'dotenv/config';
// Make sure to install the 'pg' package 
import { waddler } from "waddler/cockroach";
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/cockroach';
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) {
  ...
}