From c72b2c1926b0ea4006bcf22a07445a00483a1c1b Mon Sep 17 00:00:00 2001 From: kay Date: Fri, 15 Feb 2013 15:19:58 -0500 Subject: [PATCH] DOCS-1014 add cursor.objsLeftInBatch --- .../reference/method/cursor.objsLeftInBatch.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 source/reference/method/cursor.objsLeftInBatch.txt diff --git a/source/reference/method/cursor.objsLeftInBatch.txt b/source/reference/method/cursor.objsLeftInBatch.txt new file mode 100644 index 00000000000..ead431fd078 --- /dev/null +++ b/source/reference/method/cursor.objsLeftInBatch.txt @@ -0,0 +1,16 @@ +======================== +cursor.objsLeftInBatch() +======================== + +.. default-domain:: mongodb + +.. method:: cursor.objsLeftInBatch() + + The :method:`cursor.objsLeftInBatch()` returns the number of + documents remaining in the current batch. + + The MongoDB instance returns its response in batches. The retrieval + of all the documents from a cursor may require multiple batch + responses from the MongoDB instance. When there are no more + documents remaining in the current batch, the cursor will retrieve + another batch to get more documents.