[DOCS-11616] Docs for SERVER-34313: Change resume token format to be encoded as a string Created: 16/Apr/18  Updated: 29/Oct/23  Resolved: 19/Jul/18

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

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-34313 Change resume token format to be enco... Closed
Related
related to DOCS-11561 Docs for SERVER-33818: Add 'startAtOp... Closed
Participants:
Days since reply: 5 years, 29 weeks, 6 days ago
Epic Link: DOCS: 4.0 Server

 Description   

Documentation Request Summary:

If users want to know which resume token is more recent, or want to sort based on the resume token in general, they can now do so by using the _id._data value in each document.

edit: also - for the upgrade downgrade scenarios:

  • A user which opens a change stream on version 3.6 will be able to use a resume token from that stream on a 4.0 server in either feature compatibility version (FCV) 3.6 or FCV 4.0.
  • A user which opens a change stream on a 4.0 binary which is in FCV 3.6 will get the old format for resume tokens, so will continue to be able to use them to resume on a 3.6 binary should they downgrade.
  • Once the FCV is set to 4.0, change streams which are already open will continue using the old format, but any new change streams will use the new string format, and so will not be able to be used for resuming on a 3.6 binary.

Scope of changes:

  • db.collection.watch() – _id field type change and upgrade/downgrade implications
  • changeStreams - _id field type change and upgrade/downgrade implications
  • Downgrade Considerations
  • release notes
  • db.watch() just mention type in the _id field description
  • Mongo.watch() just mention type in the _id field description

Impact to other docs outside of this product:

MVP:

Resources:

Engineering Ticket Description:

This will enable clients to sort on the value, without the interesting and surprising sorting semantics of the BinData type.



 Comments   
Comment by Githook User [ 19/Jul/18 ]

Author:

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

Message: DOCS-11616: resume token type and fcv
Branch: master
https://github.com/mongodb/docs/commit/345079e76fd8859a1a4cb3720af034ec8c68ab70

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