pg-cursor

What is pg-cursor?

The pg-cursor npm package provides a way to handle large result sets in PostgreSQL by using server-side cursors. This allows you to fetch rows in smaller chunks, which can be more efficient and less memory-intensive than fetching all rows at once.

What are pg-cursor's main functionalities?

Creating a Cursor

This feature allows you to create a cursor for a given SQL query. The cursor can then be used to fetch rows in smaller chunks.

const { Client } = require('pg');
const Cursor = require('pg-cursor');

const client = new Client();
await client.connect();

const cursor = client.query(new Cursor('SELECT * FROM large_table'));

Fetching Rows

This feature allows you to fetch a specified number of rows from the cursor. This can be done repeatedly to fetch all rows in manageable chunks.

cursor.read(100, (err, rows) => {
  if (err) throw err;
  console.log(rows);
});

Closing the Cursor

This feature allows you to close the cursor when you are done fetching rows. This is important for freeing up resources on the server.

cursor.close((err) => {
  if (err) throw err;
  client.end();
});

Other packages similar to pg-cursor

pg-query-stream

The pg-query-stream package provides a way to stream rows from a PostgreSQL query. It is similar to pg-cursor in that it allows you to handle large result sets efficiently. However, pg-query-stream uses a readable stream interface, which can be more convenient for some use cases.

pg-promise

The pg-promise package is a PostgreSQL interface for Node.js that supports promises. It includes a feature for streaming rows from a query, similar to pg-cursor. However, pg-promise offers a broader range of features for working with PostgreSQL, including transaction management and query formatting.

README

node-pg-cursor

Use a PostgreSQL result cursor from node with an easy to use API.

install

$ npm install pg-cursor

note: this depends on either npm install pg or npm install pg.js, but you must be using the pure JavaScript client. This will not work with the native bindings.

:star: Documentation :star:

license

The MIT License (MIT)

Copyright (c) 2013 Brian M. Carlson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.