Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-6620

Docs for getMore command maxTimeMS field should specify awaitData behavior

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Done
    • Icon: Major - P3 Major - P3
    • 01112017-cleanup
    • None
    • Server
    • None

    Description

      The reference page for the getMore command in 3.2 includes the following documentation for the maxTimeMS field:

      maxTimeMS | positive integer | Optional. The timeout duration in milliseconds.

      This is accurate, but incomplete. The maxTimeMS field is only legal for getMore on awaitData cursors. An error will be returned to the user if maxTimeMS is attached to a getMore command on a non-capped, non-tailable, or non-awaitData cursor. Furthermore, the timeout is not used to throw an error if the operation exceeds its allotted time; instead, the timeout is the amount of time for which the getMore operation will block waiting for new data to be inserted into the capped collection.

      Attachments

        Activity

          People

            ravind.kumar Ravind Kumar (Inactive)
            david.storch@mongodb.com David Storch
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              8 years, 10 weeks, 1 day ago