# pg-readable

> High level shortcut to a readable query result stream for PostgreSQL

Latest version **0.2.1** (published 2014-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install pg-readable
pnpm add pg-readable
yarn add pg-readable
bun add pg-readable
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2014-06-25 |
| First published | 2014-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Brian M. Carlson |
| Maintainers | brianc |
| Keywords | pg, postgres, readable, stream |

## Links

- npm: https://www.npmjs.com/package/pg-readable
- Repository: https://github.com/brianc/node-pg-readable
- Issues: https://github.com/brianc/node-pg-readable/issues
- npm.io page: https://npm.io/package/pg-readable

## Dependencies (1)

- [pg-query-stream](https://npm.io/package/pg-query-stream.md) 0.6.0

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2014-06-25
- 0.2.0 — 2014-05-22
- 0.1.2 — 2014-04-11
- 0.1.1 — 2014-04-03
- 0.1.0 — 2014-04-03
- 0.0.2 — 2014-03-21
- 0.0.1 — 2014-02-26
- 0.0.0 — 2014-01-20

## README

node-pg-readable
================

Quick helper for streaming query results from postgres.  It will connect to postgres using node-postgres and [environment variables](http://www.postgresql.org/docs/9.3/static/libpq-envars.html)
After connecting, it will execute a streaming query, return the stream, and automatically close the connection to the server when the stream ends.


## install

```sh

$ npm install pg-readable

```

## use

```js
var readable = require('pg-readable')
var stream = readable('SELECT * FROM my_big_table')
stream.pipe(/* bla bla bla */)
```

## license

MIT

---
_Source: https://npm.io/package/pg-readable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._