Skip to content

Commit 9dd2f01

Browse files
authored
DOCS-16583 bounded clustered ixscan allowed in notablescan (#7066) (#7348)
* DOCS-16583 bounded clustered ixscan allowed in notablescan * DOCS-16583 bounded clustered ixscan allowed in notablescan * DOCS-16583 bounded clustered ixscan allowed in notablescan * DOCS-16583 bounded clustered ixscan allowed in notablescan * DOCS-16583 copy edit * DOCS-16583 tech edit * DOCS-16583 tech edit * DOCS-16583 tech edit * DOCS-16583 tech edit * DOCS-16583 build error
1 parent f90f698 commit 9dd2f01

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

source/reference/explain-results.txt

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -880,7 +880,6 @@ The other fields are:
880880

881881
Estimated time in milliseconds for the query execution.
882882

883-
884883
.. _explain-output-collection-scan:
885884

886885
Collection Scan
@@ -895,10 +894,23 @@ key pattern, direction of traversal, and index bounds.
895894

896895
Starting in MongoDB 5.3, if the query planner selects a :ref:`clustered
897896
index <db.createCollection.clusteredIndex>` for a :ref:`clustered
898-
collection <clustered-collections>`, the explain result includes a
897+
collection <clustered-collections>` and the query contains bounds that
898+
define the portion of the index to search, the explain result includes a
899899
``CLUSTERED_IXSCAN`` stage. The stage includes information about the
900900
clustered index key and index bounds.
901901

902+
If the query planner selects a :ref:`clustered index
903+
<db.createCollection.clusteredIndex>` for a :ref:`clustered collection
904+
<clustered-collections>` and the query *does not* contain bounds, the
905+
query performs an unbounded collection scan and the explain result
906+
includes a ``COLLSCAN`` stage.
907+
908+
.. note::
909+
910+
The :parameter:`notablescan` parameter does not allow unbounded
911+
queries that use a clustered index because the queries require a
912+
full collection scan.
913+
902914
For more information on execution statistics of collection scans, see
903915
:doc:`/tutorial/analyze-query-plan`.
904916

source/reference/parameters.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1371,6 +1371,13 @@ General Parameters
13711371

13721372
.. include:: /includes/fact-runtime-startup-parameter
13731373

1374+
.. note::
1375+
1376+
``notablescan`` does not allow unbounded queries that use a
1377+
clustered index because the queries require a full collection
1378+
scan. For more information, see :ref:`Collection Scans
1379+
<explain-output-collection-scan>`.
1380+
13741381
.. parameter:: ttlMonitorEnabled
13751382

13761383
|mongod-only|

0 commit comments

Comments
 (0)