Skip to content

Commit 243a61a

Browse files
nlarewkay-kim
authored andcommitted
DOCS-6280: Added saveState and restoreState fields in query explainer executionStats.
1 parent 612027d commit 243a61a

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

source/reference/explain-results.txt

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,8 @@ information:
182182
"advanced" : <int>,
183183
"needTime" : <int>,
184184
"needYield" : <int>,
185+
"saveState" : <int>,
186+
"restoreState" : <int>,
185187
"isEOF" : <boolean>,
186188
...
187189
"inputStage" : {
@@ -191,6 +193,8 @@ information:
191193
"executionTimeMillisEstimate" : <int>,
192194
"keysExamined" : <int>,
193195
"docsExamined" : <int>,
196+
"saveState" : <int>,
197+
"restoreState" : <int>,
194198
...
195199
"inputStage" : {
196200
...
@@ -274,8 +278,20 @@ information:
274278

275279
.. data:: explain.executionStats.executionStages.needYield
276280

277-
The number of times that the storage layer requested that the query
278-
system yield its locks.
281+
The number of times that the storage layer requested that the
282+
query stage suspend processing and yield its locks.
283+
284+
.. data:: explain.executionStats.executionStages.saveState
285+
286+
The number of times that the query stage suspended processing
287+
and saved its current execution state, for example in
288+
preparation for yielding its locks.
289+
290+
.. data:: explain.executionStats.executionStages.restoreState
291+
292+
The number of times that the query stage restored a saved
293+
execution state, for example after recovering locks that it had
294+
previously yielded.
279295

280296
.. data:: explain.executionStats.executionStages.isEOF
281297

0 commit comments

Comments
 (0)