Skip to content

zhm/minipg

Repository files navigation

minipg Build Status

High performance libpq bindings. The main feature is single row mode to support massive result sets without consuming the entire result set into memory. node-postgres is the standard postgres library, but it requires the entire result set to be read into memory before processing it. There is also pg-cursor on top of it, which helps, but it relies on server-side cursors (portals) which aren't compatible in all scenarios where session-level postgres features don't work (e.g. a production system running pgbouncer connection pooling).

This is not a fully functional postgres client, but it could be one day. It's still in early development.

Installation

npm install minipg

Example

import { Client } from 'minipg';

const client = new Client().connect('dbname = postgres');

const sql = 'SELECT generate_series(1, 4000000000)';

// query an essentially infinite series of results
client.query(sql).each(function(err, finished, columns, row, index) {
  // `err` is a possible error message
  // `finished` indicates that the iteration is complete
  // `columns` an object containing the column definitions
  // `row` is the row object with the row data in it
  // `index` is the index of this row in the result set
  console.log(index);

  if (finished) {
    // the end was reached
    client.close();
  }
});

About

High performance libpq bindings for Nodejs using single-row mode

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published