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

Document saveState and restoreState fields in explain.executionStats

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major - P3 Major - P3
    • Server_Docs_20231030
    • mongodb-3.0
    • manual
    • None

    Description

      The `saveState` and `restoreState` fields in MongoDB 3.0 explain.executionStats are not currently documented:
      http://docs.mongodb.org/manual/reference/explain-results/#explain.executionStats

      These are counters for the number of times a query stage yielded (saveState) and then resumed (restoreState). For example, a collection scan (COLLSCAN) stage might need to yield to fetch documents that aren't in memory yet. Queries also yield so they can be interleaved with other queries and safely stopped via $maxTimeMS or kill operations.

      Ref: https://github.com/mongodb/mongo/blob/v3.0/src/mongo/db/query/explain.cpp#L223

      Attachments

        Activity

          People

            nick.larew@mongodb.com Nicholas Larew
            stephen.steneker@mongodb.com Stennie Steneker (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              5 years, 4 weeks ago