Skip to content

Commit 6a93bc8

Browse files
authored
DOCSP-49813-Clarify-impact-scope-of-notablescan (#12257) (#12353)
* DOCSP-49813-Clarify-impact-scope-of-notablescan * External review feedback
1 parent 91b46dc commit 6a93bc8

File tree

3 files changed

+21
-18
lines changed

3 files changed

+21
-18
lines changed

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

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

13611361
|mongod-only|
13621362

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

1367-
Consider the following example which sets :parameter:`notablescan` to ``1``
1368+
Consider the following example which sets :parameter:`notablescan` to ``true``
13681369
or true:
13691370

13701371
.. code-block:: javascript
13711372

1372-
db.adminCommand( { setParameter: 1, notablescan: 1 } )
1373+
db.adminCommand( { setParameter: 1, notablescan: true } )
13731374

1374-
Setting :parameter:`notablescan` to ``1`` can be useful for testing
1375+
Setting :parameter:`notablescan` to ``true`` can be useful for testing
13751376
application queries, for example, to identify queries that scan an
13761377
entire collection and cannot use an index.
13771378

content/manual/v6.0/source/reference/parameters.txt

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

12191219
|mongod-only|
12201220

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

1225-
Consider the following example which sets :parameter:`notablescan` to ``1``
1226+
Consider the following example which sets :parameter:`notablescan` to ``true``
12261227
or true:
12271228

12281229
.. code-block:: javascript
12291230

1230-
db.adminCommand( { setParameter: 1, notablescan: 1 } )
1231+
db.adminCommand( { setParameter: 1, notablescan: true } )
12311232

1232-
Setting :parameter:`notablescan` to ``1`` can be useful for testing
1233+
Setting :parameter:`notablescan` to ``true`` can be useful for testing
12331234
application queries, for example, to identify queries that scan an
12341235
entire collection and cannot use an index.
12351236

content/manual/v7.0/source/reference/parameters.txt

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

13121312
|mongod-only|
13131313

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

1318-
Consider the following example which sets :parameter:`notablescan` to ``1``
1319+
Consider the following example which sets :parameter:`notablescan` to ``true``
13191320
or true:
13201321

13211322
.. code-block:: javascript
13221323

1323-
db.adminCommand( { setParameter: 1, notablescan: 1 } )
1324+
db.adminCommand( { setParameter: 1, notablescan: true } )
13241325

1325-
Setting :parameter:`notablescan` to ``1`` can be useful for testing
1326+
Setting :parameter:`notablescan` to ``true`` can be useful for testing
13261327
application queries, for example, to identify queries that scan an
13271328
entire collection and cannot use an index.
13281329

0 commit comments

Comments
 (0)