Skip to content

M
mongo-php-library
Commit 403cce2e authored by Katherine Walker's avatar Katherine Walker Committed by GitHub
Browse files
Options

Merge pull request #421 from kvwalker/PHPLIB-288 

PHPLIB-288 Document how to specify singleBatch option with Find
parents 2a60a815 fa1585ae
Show whitespace changes
Inline Side-by-side
Showing with 7 additions and 0 deletions
docs/includes/apiargs-MongoDBCollection-method-find-option.yaml
View file @ 403cce2e
...@@ -35,6 +35,13 @@ type: integer ...@@ -35,6 +35,13 @@ type: integer
description: | description: |
The maximum number of documents to return. If unspecified, then defaults to no The maximum number of documents to return. If unspecified, then defaults to no
limit. A limit of ``0`` is equivalent to setting no limit. limit. A limit of ``0`` is equivalent to setting no limit.
A negative limit is similar to a positive limit but closes the cursor after
returning a single batch of results. As such, with a negative limit, if the
limited result set does not fit into a single batch, the number of documents
received will be less than the specified limit. By passing a negative limit, the
client indicates to the server that it will not ask for a subsequent batch via
getMore.
interface: phpmethod interface: phpmethod
operation: ~ operation: ~
optional: true optional: true
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment