[DRIVERS-682] Update change stream docs example for resume token access Created: 19/Jun/19  Updated: 22/Feb/23  Resolved: 22/Feb/23

Status: Closed
Project: Drivers
Component/s: Docs
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Jeremy Mikola Assignee: Unassigned
Resolution: Done Votes: 0
Labels: docs
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on CDRIVER-3207 Update change stream docs example for... Closed
depends on CSHARP-2651 Update change stream docs example for... Closed
depends on CXX-1794 Update change stream docs example for... Closed
depends on GODRIVER-1164 Update change stream docs example for... Closed
depends on JAVA-3337 Update change stream docs example for... Closed
depends on MOTOR-355 Update change stream docs example for... Closed
depends on NODE-2028 Update change stream docs example for... Closed
depends on PHPLIB-450 Update change stream docs example for... Closed
depends on PYTHON-1885 Update change stream docs example for... Closed
depends on RUBY-1856 Update change stream docs example for... Closed
Related
related to DOCS-12942 Update makefile to version changestre... Closed
is related to DRIVERS-595 Support postBatchResumeToken in chang... Closed
is related to DRIVERS-436 Add pipeline stage to ChangeStreams e... Closed
is related to DRIVERS-634 Clarify resume token used in resuming... Closed
Driver Compliance:
Key Status/Resolution FixVersion
PHPLIB-450 Fixed 1.5.0
CXX-1794 Fixed 3.5.0
MOTOR-355 Fixed 2.1
CSHARP-2651 Fixed 2.10.0
NODE-2028 Fixed 3.3.0
PYTHON-1885 Fixed 3.9
PERL-1112 Fixed 2.2.0
GODRIVER-1164 Fixed 1.1.0
JAVA-3337 Fixed 3.11.0
RUBY-1856 Fixed 2.10.0.rc0
CDRIVER-3207 Fixed 1.15.0
SWIFT-546 Won't Do

 Description   

The spec change in DRIVERS-595 requires that drivers provide an API for exposing the current resume token, which may come from a change document or a postBatchResumeToken field. DRIVERS-634 builds upon that issue and adds more clarity around which value should be returned (and used for resuming).

In DRIVERS-436, drivers added an example for accessing the resume token (example #3), which is published within https://docs.mongodb.com/manual/changeStreams/#resume-a-change-stream. This example should be updated to use whatever new API was introduced for 4.2 drivers in DRIVERS-595.



 Comments   
Comment by Kay Kim (Inactive) [ 20/Jun/19 ]

Thanks jmikola.

Comment by Jeremy Mikola [ 19/Jun/19 ]

ian.whalen: For purposes of triaging, I believe this should be considered a 4.2 ticket.

Comment by Jeremy Mikola [ 19/Jun/19 ]

kay.kim: You (or someone on docs) may want to track this ticket, as you were the original reporter of DRIVERS-436.

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