Skip to content

Commit 4ad3420

Browse files
authored
DOCSP-49813-Clarify-impact-scope-of-notablescan (#12257)
* DOCSP-49813-Clarify-impact-scope-of-notablescan * External review feedback
1 parent 6819773 commit 4ad3420

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

content/manual/upcoming/source/reference/parameters.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1379,18 +1379,19 @@ General Parameters
13791379

13801380
|mongod-only|
13811381

1382-
Specify whether **all** queries must use indexes. If ``1``, MongoDB
1383-
will not execute queries that require a collection scan and will return an
1384-
error.
1382+
Prevents running some collection scans when an index could be used, whether
1383+
present or not. If ``true``, MongoDB will not execute queries that require
1384+
a collection scan and will return an error. Exclusions include queries
1385+
without filters and queries against capped collections, such as the oplog.
13851386

1386-
Consider the following example which sets :parameter:`notablescan` to ``1``
1387+
Consider the following example which sets :parameter:`notablescan` to ``true``
13871388
or true:
13881389

13891390
.. code-block:: javascript
13901391

1391-
db.adminCommand( { setParameter: 1, notablescan: 1 } )
1392+
db.adminCommand( { setParameter: 1, notablescan: true } )
13921393

1393-
Setting :parameter:`notablescan` to ``1`` can be useful for testing
1394+
Setting :parameter:`notablescan` to ``true`` can be useful for testing
13941395
application queries, for example, to identify queries that scan an
13951396
entire collection and cannot use an index.
13961397

0 commit comments

Comments
 (0)