Skip to content

Commit 221b269

Browse files
DOCSP-33422 Add Stable API Explain Content (#5831)
* DOCSP-33422 Add Stable API Explain Content * * * * * * * * * XR Comments * XR * * * Update source/reference/command/explain.txt Co-authored-by: Nick Villahermosa <nick.villahermosa@mongodb.com> --------- Co-authored-by: Nick Villahermosa <nick.villahermosa@mongodb.com>
1 parent 9571769 commit 221b269

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
@@ -148,6 +148,20 @@ For write operations, the :dbcommand:`explain` command returns
148148
information about the write operation that would be performed but does
149149
not actually modify the database.
150150

151+
Stable API
152+
~~~~~~~~~~
153+
154+
The :ref:`Stable API <stable-api>` V1 supports the following
155+
verbosity modes for the ``explain`` command:
156+
157+
- :ref:`allPlansExecution <ex-allPlansExecution>`
158+
- :ref:`executionStats <ex-executionStats>`
159+
- :ref:`queryPlanner<ex-queryPlanner>`
160+
161+
.. warning::
162+
163+
.. include:: /includes/fact-stable-api-explain.rst
164+
151165
Restrictions
152166
~~~~~~~~~~~~
153167

@@ -185,8 +199,8 @@ verbosity mode to return the query planning information for a
185199

186200
.. _ex-executionStats:
187201

188-
``executionStats`` Mode
189-
~~~~~~~~~~~~~~~~~~~~~~~~
202+
``executionStats`` Mode
203+
~~~~~~~~~~~~~~~~~~~~~~~
190204

191205
The following :dbcommand:`explain` operation runs in ``"executionStats"``
192206
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)