Skip to content

Commit c008be0

Browse files
DOCSP-33422 Add Stable API Explain Content (#5831) (#6182)
* DOCSP-33422 Add Stable API Explain Content * * * * * * * * * XR Comments * XR * * * Update source/reference/command/explain.txt --------- Co-authored-by: Nick Villahermosa <[email protected]>
1 parent 0824cd7 commit c008be0

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
MongoDB does not guarantee any specific output format from the
2+
:dbcommand:`explain` command, even when using the Stable API.

source/reference/command/explain.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,20 @@ For write operations, the :dbcommand:`explain` command returns
137137
information about the write operation that would be performed but does
138138
not actually modify the database.
139139

140+
Stable API
141+
~~~~~~~~~~
142+
143+
The :ref:`Stable API <stable-api>` V1 supports the following
144+
verbosity modes for the ``explain`` command:
145+
146+
- :ref:`allPlansExecution <ex-allPlansExecution>`
147+
- :ref:`executionStats <ex-executionStats>`
148+
- :ref:`queryPlanner<ex-queryPlanner>`
149+
150+
.. warning::
151+
152+
.. include:: /includes/fact-stable-api-explain.rst
153+
140154
Restrictions
141155
~~~~~~~~~~~~
142156

@@ -174,8 +188,8 @@ verbosity mode to return the query planning information for a
174188

175189
.. _ex-executionStats:
176190

177-
``executionStats`` Mode
178-
~~~~~~~~~~~~~~~~~~~~~~~~
191+
``executionStats`` Mode
192+
~~~~~~~~~~~~~~~~~~~~~~~
179193

180194
The following :dbcommand:`explain` operation runs in ``"executionStats"``
181195
verbosity mode to return the query planning and execution information

source/reference/stable-api-changelog.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,7 @@ The following table describes:
126126

127127
.. [#stable-api-explain]
128128

129-
MongoDB does not guarantee that the output of the
130-
:dbcommand:`explain` command will conform to the same format in
131-
future API versions.
129+
.. include:: /includes/fact-stable-api-explain.rst
132130

133131
Aggregation Stages and Operators
134132
--------------------------------

0 commit comments

Comments
 (0)