Skip to content

Commit 7ab0c52

Browse files
DOCS-16285-slotBasedPlan-internal-only-note (#5617)
* DOCS-16285-slotBasedPlan-internal-only-note * Adding internal use note * Update source/reference/explain-results.txt Per feedback Co-authored-by: Jeff Allen <jeffrey.allen@10gen.com> * Adding additional clarification to SBE per feedback review. * Update source/reference/sbe.txt Formatting and wording suggestions. Co-authored-by: Jeff Allen <jeffrey.allen@10gen.com> * Removing section after tech review conversation. Does not sufficiently meet the goal of the original ticket. --------- Co-authored-by: Jeff Allen <jeffrey.allen@10gen.com>
1 parent 53c4d33 commit 7ab0c52

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

source/reference/explain-results.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ representative. Your output may differ significantly.
364364
.. data:: explain.queryPlanner.winningPlan.slotBasedPlan
365365

366366
Document with information about the slot based query execution plan
367-
tree and stages.
367+
tree and stages. **For internal use by MongoDB.**
368368

369369
.. versionadded:: 5.1
370370

source/reference/sbe.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,9 @@ There are a few ways to determine whether the classic engine or the
6565
Check Query Explain Results
6666
~~~~~~~~~~~~~~~~~~~~~~~~~~~
6767

68-
The :ref:`explain results <explain-results>` for a query differ based on
68+
The explain results for a query differ based on
6969
which query engine was used. For example, explain results for queries
70-
executed using the {+sbe-short+} include the
71-
:data:`explain.queryPlanner.winningPlan.slotBasedPlan` field.
70+
executed using the {+sbe-short+} include the ``explain.queryPlanner.winningPlan.slotBasedPlan`` field.
7271

7372
For more information about the differences in explain results between
7473
query engines, see :ref:`explain-output-structure`.

0 commit comments

Comments
 (0)