[DOCS-15065] Rewrite "Perform Long-Running Queries" page to show intended use Created: 25/Jan/22 Updated: 30/Oct/23 Resolved: 31/Mar/23 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | Server_Docs_20231030 |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | A. Jesse Jiryu Davis | Assignee: | Jeffrey Allen |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Σ Remaining Estimate: | Not Specified | Remaining Estimate: | Not Specified |
| Σ Time Spent: | Not Specified | Time Spent: | Not Specified |
| Σ Original Estimate: | Not Specified | Original Estimate: | Not Specified |
| Issue Links: |
|
||||||||||||||||||||
| Sub-Tasks: |
|
||||||||||||||||||||
| Participants: | |||||||||||||||||||||
| Days since reply: | 1 year, 46 weeks, 6 days ago | ||||||||||||||||||||
| Epic Link: | DOCSP-11702 | ||||||||||||||||||||
| Story Points: | 5 | ||||||||||||||||||||
| Description |
|
This page: https://docs.mongodb.com/manual/tutorial/long-running-queries/ ... shows how we internally implement the driver-server protocol for snapshot reads using the "atClusterTime" parameter. That parameter shouldn't be documented. Instead, we should show users the session-based driver API for using snapshot reads. Here's a good example for Python: https://pymongo.readthedocs.io/en/stable/api/pymongo/client_session.html Snapshot reads are extremely similar to causal consistency. For causal, we don't document the internal parameter "afterClusterTime". Instead, we show examples with drivers: https://docs.mongodb.com/manual/core/read-isolation-consistency-recency/#examples We should do the same for snapshot reads: don't document "atClusterTime", show drivers examples instead. We can collect drivers examples using a ticket like DRIVERS-547. Also, I'd replace the term "snapshot time" with "read timestamp" on that page. E.g.,
|
| Comments |
| Comment by Jeremy Mikola [ 17/Mar/22 ] |
|
jeffrey.allen: I'm not sure if this is the correct place to report this, but I noticed a typo in https://docs-mongodbcom-staging.corp.mongodb.com/docs/docsworker-xlarge/DOCS-15065/tutorial/long-running-queries/. A bullet under the first example reads "Performs these actions for each database" but it should likely say "for each collection". |
| Comment by Jeffrey Allen [ 09/Feb/22 ] |
|
Reviews are complete. Moving to Blocked while we wait for driver examples in DRIVERS-2181. |
| Comment by Jeffrey Allen [ 04/Feb/22 ] |
|
Resuming work to add a second example to this page. |
| Comment by Jeffrey Allen [ 31/Jan/22 ] |
|
Moving to "Blocked" while we wait for driver examples. See DRIVERS-2181. |