[DOCS-11201] Docs for SERVER-32173: Add deprecation warning to "snapshot" option on queries Created: 12/Jan/18  Updated: 29/Oct/23  Resolved: 17/May/18

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 3.7.1, 3.6.1

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

Issue Links:
Documented
documents SERVER-32173 Add deprecation warning to "snapshot"... Closed
Related
Participants:
Days since reply: 5 years, 35 weeks, 6 days ago
Epic Link: DOCS: 4.0 Server

 Description   

Documentation Request Summary:

This change causes the server to log the following warning message:

The snapshot option is deprecated. See http://dochub.mongodb.org/core/snapshot-deprecation

This dochub link currently points to https://docs.mongodb.com/manual/release-notes/3.6-compatibility/#general-compatibility-changes. It should be changed to point specifically to a note about snapshot's deprecation.

As part of this note, we should explain how users should migrate their application off the deprecated option. Those users who are on MMAPv1 should instead issue a hint on the _id index. Users on other storage engines should issue a $natural hint. Under the hood, snapshot was simply implemented as one of these two hints, which results in a plan that will never return the same document twice. Therefore, issuing a hint directly should achieve the same effect.

This option is being deprecated because it never offered true snapshot isolation.

Engineering Ticket Description:

The old snapshot option is being deprecated, need to add warning to the logs.



 Comments   
Comment by Githook User [ 08/Jun/18 ]

Author:

{'username': 'kay-kim', 'name': 'kay', 'email': 'kay.kim@10gen.com'}

Message: DOCS-11201: refer to txn - tweak on 3.6-compat
Branch: v3.6
https://github.com/mongodb/docs/commit/21c5f7533187f5feec46336fe2ab91f77dc44633

Comment by Githook User [ 08/Jun/18 ]

Author:

{'username': 'kay-kim', 'name': 'kay', 'email': 'kay.kim@10gen.com'}

Message: DOCS-11201: refer to txn - tweak on 3.6-compat
Branch: master
https://github.com/mongodb/docs/commit/6a14dce1fce36b845a77c50df5057f7d9da99f0b

Comment by Githook User [ 08/Jun/18 ]

Author:

{'username': 'kay-kim', 'name': 'kay', 'email': 'kay.kim@10gen.com'}

Message: DOCS-11201: refer to txn as alternative to removed isolated operator
Branch: master
https://github.com/mongodb/docs/commit/cbff742862561b0ef9df0946d608429c90662490

Comment by Githook User [ 17/May/18 ]

Author:

{'email': 'kay.kim@10gen.com', 'username': 'kay-kim', 'name': 'kay'}

Message: DOCS-11201: add blurb for deprecation of snapshot for non-mmapv1 engine
Branch: master
https://github.com/mongodb/docs/commit/55c0051de363397603ee5e75e9d798286f30d4e5

Comment by Githook User [ 17/May/18 ]

Author:

{'email': 'kay.kim@10gen.com', 'username': 'kay-kim', 'name': 'kay'}

Message: DOCS-11201: add blurb for deprecation of snapshot for non-mmapv1 engine
Branch: v3.6
https://github.com/mongodb/docs/commit/ace95c928f0b5b9020063b4dde00a5744cc5c37c

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