Method: Mongo::Collection::View::Readable#batch_size

Defined in:
lib/mongo/collection/view/readable.rb

#batch_size(batch_size = nil) ⇒ Integer, View

Note:

Specifying 1 or a negative number is analogous to setting a limit.

The number of documents returned in each batch of results from MongoDB.

Examples:

Set the batch size.

view.batch_size(5)

Parameters:

  • batch_size (Integer) (defaults to: nil) —

    The size of each batch of results.

Returns:

  • (Integer, View) —

    Either the batch_size value or a new View.

Since:

  • 2.0.0



121
122
123
 
# File 'lib/mongo/collection/view/readable.rb', line 121

def batch_size(batch_size = nil)
  configure(:batch_size, batch_size)
end