RFC - Provide true node streams

After investigating the pause / resume functionality for our existing Request objects, I looked into what it would take to turn them into bonafide streams instead of a semi-ducktyped stream.

Current issues

At the moment the Request class is quite complicated and has sprinklings of if (this.stream) throughout and I feel we could greatly simplify the core logic by moving to a “stream first” implementation where Requests could be promisified on demand.

The Requests from tedious are essentially streams, so this would allow us to interface with them in a more straightforward fashion.

The current stream implementation we have doesn’t work particularly well if you also want to make use of the promise functionality, so we need to clear up that usage a bit more too.

Changes required

• Request object extends stream.Readable
• Stream operates in object mode
• Add promise transformation method to Request

Impact

• Deprecation of row event and replaced with data event (generally conform to the Stream interface)
• Requests will not be promises by default

Challenges

• Error handling
• msnodesqlv8 doesn’t support resume/pause of requests

[jansivans]

Can you please add information to the docs that this is not a real stream and it is just some custom “request”? Because I thought it is the usual nodejs stream (it actually has the same methods like pause, resume and some events) and have wasted few days debugging my app.

[dhensby]

this was fixed in #1078