Skip to content

DOCS-6620 : getMORE maxTimeMS should specify awaitData behavior #2444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

DOCS-6620 : getMORE maxTimeMS should specify awaitData behavior #2444

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1845d2d
DOCS-6620 : getMORE maxTimeMS should specify awaitData behavior
ravindk89 Dec 7, 2015
da776b7
Update apiargs-dbcommand-getMore-field.yaml
ravindk89 Dec 8, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion source/includes/apiargs-dbcommand-getMore-field.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,12 @@ position: 4
name: maxTimeMS
type: positive integer
description: |
The timeout duration in milliseconds.
The time period in milliseconds the :dbcommand:`getMore()` operation will
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose "The maximum time period", otherwise it sounds like the command will block waiting for new data. In fact the command returns early if new data arrives before maxTimeMS.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed - thanks for catching that.

block waiting for new data to be inserted into the capped collection.

Requires that the cursor on which this :dbcommand:`getMore()` is acting is
an ``awaitData`` cursor.
See the ``awaitData`` parameter for :dbcommand:`find()`.
optional: true
arg_name: field
interface: dbcommand
Expand Down