[DOCS-11321] Docs for SERVER-32953: Log a deprecation warning when the maxScan find option is used. Created: 14/Feb/18  Updated: 04/Jun/18  Resolved: 04/Jun/18

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 3.7.3

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Allison Reinheimer Moore
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-32953 Log a deprecation warning when the ma... Closed
Duplicate
Participants:
Days since reply: 5 years, 37 weeks ago
Epic Link: DOCS: 4.0 Server

 Description   

Description

Summary: maxScan is now maxTimeMS

The maxScan option is intended to guard against runaway queries or unexpected bad query plans by limiting the number of keys that the IXSCAN query execution stage is willing to examine. However, this option has since been superseded by maxTimeMS. The maxTimeMS mechanism is more complete in that it applies to most commands, whereas maxScan is only available for find. Furthermore, maxScan can be easily be confused with limit. Limit is a logical component of the query language, whereas maxScan is better understood as a command directive in the vein of maxTimeMS, readConcern, writeConcern, readPreference, and so on.

When maxScan is used, we should occasionally log the following message:

Support for the maxScan option has been deprecated. Instead, use maxTimeMS. See http://dochub.mongodb.org/core/4.0-deprecate-maxScan.

Scope of changes (files that need work and how much)

  • make sure the 4.0 compatibility page includes a mention to this.

The following reference pages need to be updated to instruct the user to use maxTimeMS instead of maxScan.

Consider adding content (new page or to an existing page) to explain how to add a time limit to a query, as per this note:

Some users may also be interested in how to add a limit to a query; we've had users confuse maxScan and limit in the past.

Impact to other docs outside of this product

Resources (e.g. Scope Docs, Invision)

---------------------------------

Documentation Request Summary:

Users should be instructed to use maxTimeMS instead of maxScan. Some users may also be interested in how to add a limit to a query; we've had users confuse maxScan and limit in the past.



 Comments   
Comment by Allison Reinheimer Moore [ 30/May/18 ]

caleb.thompson I'm grabbing this ticket unless you have objections! Very thorough scoping

Generated at Thu Feb 08 08:02:34 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.