Skip to content

Commit a9f16f7

Browse files
committed
docs: add note about pausing results too long
closes #1022 closes #1023
1 parent 9a88496 commit a9f16f7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Readme.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,11 @@ Please note a few things about the example above:
767767
* You MUST NOT provide a callback to the `query()` method when streaming rows.
768768
* The `'result'` event will fire for both rows as well as OK packets
769769
confirming the success of a INSERT/UPDATE query.
770+
* It is very important not to leave the result paused too long, or you may
771+
encounter `Error: Connection lost: The server closed the connection.`
772+
The time limit for this is determined by the
773+
[net_write_timeout setting](https://dev.mysql.com/doc/refman/5.5/en/server-system-variables.html#sysvar_net_write_timeout)
774+
on your MySQL server.
770775

771776
Additionally you may be interested to know that it is currently not possible to
772777
stream individual row columns, they will always be buffered up entirely. If you

0 commit comments

Comments
 (0)