Waddler stream

This guide assumes familiarity with:

Quick start with Waddler - read here
Waddler SQL template - read here
Waddler Extensions - read here

Note

Stream is not implemented in postgres.js, xata-http, pglite, neon-http, bun-sql

All other drivers have support for a stream feature

.stream() lets you stream query result rows one by one:

IMPORTANT

To enable streaming in node-postgres and other PostgreSQL drivers, you need to install pg-query-stream and the query-stream extension that provides streaming support. You can read more about extensions here

npm

yarn

pnpm

bun

npm i pg-query-stream

yarn add pg-query-stream

pnpm add pg-query-stream

bun add pg-query-stream

import { queryStream } from 'waddler/extensions/pg-query-stream';

const sql = waddler(process.env.DATABASE_URL!, { extensions: [queryStream()] })

for await

generator

const result = sql`select * from users`.stream();

for await (const row of result) {
  console.log(row);
}

{
  id: 1,
	name: "Alex",
}
{
  id: 2,
	name: "Oleksii",
}

const generator = sql`select * from users`.stream();

let result = await generator.next();
while (!result.done) {
  console.log(result.value);

  result = await generator.next();
}

{
  id: 1,
	name: "Alex",
}
{
  id: 2,
	name: "Oleksii",
}