github-migration
/
mongo-ruby-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

RUBY-437 

Document batchSize better
This commit is contained in:
Tyler Brock 2012-05-14 16:02:49 -04:00
parent 6663660d92
commit 8a49614c7e
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/mongo/collection.rb
View File

@ -184,7 +184,7 @@ module Mongo
# end of the query's execution.
# For details see http://www.mongodb.org/display/DOCS/How+to+do+Snapshotting+in+the+Mongo+Database
# @option opts [Boolean] :batch_size (100) the number of documents to returned by the database per
# GETMORE operation. A value of 0 will let the database server decide how many results to returns.
# GETMORE operation. A value of 0 will let the database server decide how many results to return.
# This option can be ignored for most use cases.
# @option opts [Boolean] :timeout (true) when +true+, the returned cursor will be subject to
# the normal cursor timeout behavior of the mongod process. When +false+, the returned cursor will

3
lib/mongo/cursor.rb
View File

@ -258,6 +258,9 @@ module Mongo
#
# Note that the batch size will take effect only on queries
# where the number to be returned is greater than 100.
#
# This can not override MongoDB's limit on the amount of data it will
# return to the client. Depending on server version this can be 4-16mb.
#
# @param [Integer] size either 0 or some integer greater than 1. If 0,
# the server will determine the batch size.