[DOCS-13506] Investigate changes in SERVER-46567: Update shell methods Mongo.setReadPref and cursor.readPref to support hedging Created: 10/Mar/20  Updated: 13/Nov/23  Due: 20/Mar/20  Resolved: 18/Mar/20

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.4.0-rc0, 4.7.0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team 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-45439 Add support for per operation hedging... Closed
documents SERVER-46567 Update shell methods Mongo.setReadPre... Closed
Duplicate
is duplicated by DOCS-13363 Investigate changes in SERVER-45439: ... Closed
Related
related to DOCS-13363 Investigate changes in SERVER-45439: ... Closed
is related to DOCS-13369 Investigate changes in SERVER-45440: ... Closed
Participants:
Days since reply: 3 years, 47 weeks ago
Epic Link: DOCS: 4.4 Server Release Work

 Description   

Description

Downstream Change Summary

Mongo.setReadPref and Cursor.readPref now take in an additional argument hedgeOptions.

Description of Linked Ticket

Change Mongo.setReadPref(mode, tagSet) to Mongo.setReadPref(mode, tagSet, hedgeOptions) and cursor.readPref(mode, tagSet) to cursor.readPref(mode, tagSet, hedgeOptions), where hedgeOptions is an optional argument of the form {enabled: <bool>}.

Similar to the $readPreference subkey {hedge: {enabled: <bool>}}, passing {} is equivalent to passing

{enabled: true}

since 'enabled' defaults to true.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 18/Mar/20 ]

Author:

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

Message: DOCS-13506: forgot to save file
Branch: master
https://github.com/mongodb/docs/commit/34796fea9b6cbc4385f22c0bf7a02d92bf863d71

Comment by Githook User [ 18/Mar/20 ]

Author:

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

Message: DOCS-13506: 4.4 mongo shell readPref helper methods take hedge read params
Branch: master
https://github.com/mongodb/docs/commit/f73fb846c2dd2456de48e6b6bcad3801097da612

Comment by Kay Kim (Inactive) [ 17/Mar/20 ]

Because we currently don't document $readPreference for runCommand and for the shell, only document through cursor.readPref and Mongo.setReadPref() method.

 

Will revisit decision to document $readPreference option though – as the readPref doc need to be redone in the summer.

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