Skip to content

Commit 54b8752

Browse files
committed
Update changelog for pg-query-stream
Document the conversion to typescript as a semver major change. Closes brianc#2412.
1 parent fa4549a commit 54b8752

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ For richer information consult the commit log on github with referenced pull req
44

55
We do not include break-fix version release in this file.
66

7+
### pg-query-stream@4.0.0
8+
9+
- Library has been [converted](https://github.com/brianc/node-postgres/pull/2376) to Typescript. The behavior is identical, but there could be subtle breaking changes due to class names changing or other small inconsistencies introduced by the conversion.
10+
711
### pg@8.5.0
812

913
- Fix bug forwarding [ssl key](https://github.com/brianc/node-postgres/pull/2394).

packages/pg-query-stream/README.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# pg-query-stream
22

3-
[![Build Status](https://travis-ci.org/brianc/node-pg-query-stream.svg)](https://travis-ci.org/brianc/node-pg-query-stream)
4-
53
Receive result rows from [pg](https://github.com/brianc/node-postgres) as a readable (object) stream.
64

7-
85
## installation
96

107
```bash
@@ -14,7 +11,6 @@ $ npm install pg-query-stream --save
1411

1512
_requires pg>=2.8.1_
1613

17-
1814
## use
1915

2016
```js
@@ -24,7 +20,7 @@ const JSONStream = require('JSONStream')
2420

2521
//pipe 1,000,000 rows to stdout without blowing up your memory usage
2622
pg.connect((err, client, done) => {
27-
if (err) throw err;
23+
if (err) throw err
2824
const query = new QueryStream('SELECT * FROM generate_series(0, $1) num', [1000000])
2925
const stream = client.query(query)
3026
//release the client when the stream is finished
@@ -35,13 +31,13 @@ pg.connect((err, client, done) => {
3531

3632
The stream uses a cursor on the server so it efficiently keeps only a low number of rows in memory.
3733

38-
This is especially useful when doing [ETL](http://en.wikipedia.org/wiki/Extract,_transform,_load) on a huge table. Using manual `limit` and `offset` queries to fake out async itteration through your data is cumbersome, and _way way way_ slower than using a cursor.
34+
This is especially useful when doing [ETL](http://en.wikipedia.org/wiki/Extract,_transform,_load) on a huge table. Using manual `limit` and `offset` queries to fake out async itteration through your data is cumbersome, and _way way way_ slower than using a cursor.
3935

4036
_note: this module only works with the JavaScript client, and does not work with the native bindings. libpq doesn't expose the protocol at a level where a cursor can be manipulated directly_
4137

4238
## contribution
4339

44-
I'm very open to contribution! Open a pull request with your code or idea and we'll talk about it. If it's not way insane we'll merge it in too: isn't open source awesome?
40+
I'm very open to contribution! Open a pull request with your code or idea and we'll talk about it. If it's not way insane we'll merge it in too: isn't open source awesome?
4541

4642
## license
4743

0 commit comments

Comments
 (0)