Uploaded image for project: 'Swift Driver'
  1. Swift Driver
  2. SWIFT-853

Clarify requirements for when a cursor needs to be killed

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0.0
    • Component/s: None
    • Labels:
      None

      Description

      In the common case, users don't actually need to call kill on a cursor. They only need to if they partially exhaust it without encountering a (non-decoding) error. Let's clarify this in our documentation.

      Possibly it is worth mentioning this in methods that return cursors and change streams so users see it when reading those docs. Right now you would have to go to the cursor/change stream docs and read about the kill method to know when you need to call it.

        Attachments

          Activity

            People

            Assignee:
            patrick.freed Patrick Freed
            Reporter:
            kaitlin.mahar Kaitlin Mahar
            Participants:
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: