Skip to content

Commit b67c0f5

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> * * --------- Co-authored-by: Nick Villahermosa <nick.villahermosa@mongodb.com>
1 parent 75d4d94 commit b67c0f5

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed
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

+16-2
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,20 @@ For write operations, the :dbcommand:`explain` command returns
140140
information about the write operation that would be performed but does
141141
not actually modify the database.
142142

143+
Stable API
144+
~~~~~~~~~~
145+
146+
The :ref:`Stable API <stable-api>` V1 supports the following
147+
verbosity modes for the ``explain`` command:
148+
149+
- :ref:`allPlansExecution <ex-allPlansExecution>`
150+
- :ref:`executionStats <ex-executionStats>`
151+
- :ref:`queryPlanner<ex-queryPlanner>`
152+
153+
.. warning::
154+
155+
.. include:: /includes/fact-stable-api-explain.rst
156+
143157
Restrictions
144158
~~~~~~~~~~~~
145159

@@ -177,8 +191,8 @@ verbosity mode to return the query planning information for a
177191

178192
.. _ex-executionStats:
179193

180-
``executionStats`` Mode
181-
~~~~~~~~~~~~~~~~~~~~~~~~
194+
``executionStats`` Mode
195+
~~~~~~~~~~~~~~~~~~~~~~~
182196

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

source/reference/stable-api-changelog.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,4 @@ 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

0 commit comments

Comments
 (0)