[DOCS-6280] Document saveState and restoreState fields in explain.executionStats Created: 27/Sep/15  Updated: 30/Oct/23  Resolved: 09/Oct/17

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: mongodb-3.0
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Major - P3
Reporter: Stennie Steneker (Inactive) Assignee: Nicholas Larew
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 5 years, 4 weeks ago

 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



 Comments   
Comment by Githook User [ 16/Jan/19 ]

Author:

{'username': 'nlarew', 'email': 'nick.larew@10gen.com', 'name': 'Nick Larew'}

Message: DOCS-6280: Added saveState and restoreState fields in query explainer executionStats.
Branch: v3.4
https://github.com/mongodb/docs/commit/afe55361f0a1f50564d8f7b5b35af46ffffa488d

Comment by Githook User [ 04/Dec/17 ]

Author:

{'username': 'nlarew', 'email': 'nick.larew@10gen.com', 'name': 'Nick Larew'}

Message: DOCS-6280: Added saveState and restoreState fields in query explainer executionStats.
Branch: master
https://github.com/mongodb/docs/commit/243a61a97d73be2d53b60cc057967ac47274b768

Comment by Kay Kim (Inactive) [ 30/May/17 ]

Notes:

  • See if they are there in the latest MongoDB 3.4
  • If so, checkout the master branch of the docs.
  • Update as appropriate.
  • Code review -> done
  • When done, and ready for pull request, in the pull request, just blurb that it needs to be backported to 3.2 and 3.0
Generated at Thu Feb 08 07:51:58 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.