Skip to content

Commit 4314945

Browse files
committed
Merge pull request #145 from brandonculver/clearer-reader-docs
Clarifies some road bumps in the documentation.
2 parents 258cf20 + 6efeb1e commit 4314945

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ To query large tables you should use a _reader_:
194194
195195
* `reader = connection.reader(sql, args)`: creates a reader
196196
* `reader.nextRow(callback)`: returns the next row through the callback
197-
* `reader.nextRows(count, callback)` returns the next `count` rows through the callback. `count` is optional and `nextRows` uses the prefetch row count when `count` is omitted.
197+
* `reader.nextRows(count, callback)` returns the next `count` rows through the callback. `count` is optional and `nextRows` uses the prefetch row count when `count` is omitted. Also, you much check for `row.length` since the reader will continue returning empty arrays once it exceeds the end of the data set provided by the query.
198198
* `connection.setPrefetchRowCount(count)`: configures the prefetch row count for the connection. Prefetching can have a dramatic impact on performance but uses more memory.
199199
200200
Example:
@@ -258,6 +258,7 @@ doInsert(statement, users, function(err) {
258258
259259
# Limitations/Caveats
260260
261+
* Ensure you always close your connection at the end of use to avoid random false oracle errors.
261262
* Currently no native support for connection pooling (forthcoming; use generic-pool for now.)
262263
* Currently no support for column type "Timestamp With Timezone" (Issue #67)
263264
* While the Oracle TIMESTAMP type provides fractional seconds up to 9 digits (nanoseconds), this will be rounded

0 commit comments

Comments
 (0)