[DRIVERS-2050] Duplicate read preference specifications Created: 05/Jul/19  Updated: 31/Mar/22

Status: Backlog
Project: Drivers
Component/s: None
Fix Version/s: None

Type: Spec Change Priority: Major - P3
Reporter: Oleg Pudeyev (Inactive) Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Related
is related to DRIVERS-2114 Unclear whether read preference must ... Backlog
Driver Changes: Needed

 Description   

The specifications repo has a top level file called "driver read preference":

https://github.com/mongodb/specifications/blob/master/source/driver-read-preferences.rst

This is a rather extensive document, but there is also this section on read preference in server selection specification:

https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#read-preference

The two documents seem to cover the same functionality. The top level spec does not use rfc2119 language making it difficult to figure out what the actual requirements it imposes on drivers are. Sections like https://github.com/mongodb/specifications/blob/master/source/driver-read-preferences.rst#errors make me think the top level spec is the older of the two and potentially outdated.

It seems to me that the two specifications should be combined into a single document (or a section under server selection, if this makes more sense).



 Comments   
Comment by Jeremy Mikola [ 18/May/20 ]

https://github.com/mongodb/specifications/blob/master/source/driver-read-preferences.rst is marked as deprecated in favor of SDAM and Server Selection specs, so I think this issue can likely be amended to simply delete the old specification.

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