[CDRIVER-4036] Document new API added for snapshot reads Created: 23/Jun/21  Updated: 15/Jul/21  Resolved: 15/Jul/21

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.19.0

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

Epic Link: Snapshot reads on Secondaries

 Description   

Summary

New API will be added when allowing snapshot reads on secondaries through sessions in the C driver (CDRIVER-4034). That API should be documented under libmongoc/doc.

Motivation

Who is the affected end user?

Users of the at_cluster_time fields on read_concern and the snapshot flag on client sessions.

How does this affect the end user?

Users will be confused about how to use the new API.

How likely is it that this problem or use case will occur?

Likely if a user wants to use the new API.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

No functional impact outside of documentation.



 Comments   
Comment by Githook User [ 15/Jul/21 ]

Author:

{'name': 'Benjamin Rewis', 'email': '32186188+benjirewis@users.noreply.github.com', 'username': 'benjirewis'}

Message: CDRIVER-4036 document new API added for snapshot reads (#826)
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/454a01422ee61d2add82f054aa3799750b7947e2

Comment by Benji Rewis (Inactive) [ 14/Jul/21 ]

https://github.com/mongodb/mongo-c-driver/pull/826

Generated at Wed Feb 07 21:19:45 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.