Skip to content

Commit b8176fc

Browse files
dougwilsonseangarner
authored andcommitted
docs: add note about pausing results too long
closes mysqljs#1022 closes mysqljs#1023
1 parent 6df3bae commit b8176fc

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
@@ -773,6 +773,11 @@ Please note a few things about the example above:
773773
* You MUST NOT provide a callback to the `query()` method when streaming rows.
774774
* The `'result'` event will fire for both rows as well as OK packets
775775
confirming the success of a INSERT/UPDATE query.
776+
* It is very important not to leave the result paused too long, or you may
777+
encounter `Error: Connection lost: The server closed the connection.`
778+
The time limit for this is determined by the
779+
[net_write_timeout setting](https://dev.mysql.com/doc/refman/5.5/en/server-system-variables.html#sysvar_net_write_timeout)
780+
on your MySQL server.
776781

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

0 commit comments

Comments
 (0)