[GODRIVER-2686] Simplify "readconcern" API Created: 11/Dec/22  Updated: 28/Oct/23  Resolved: 17/Apr/23

Status: Closed
Project: Go Driver
Component/s: None
Affects Version/s: None
Fix Version/s: 1.12.0

Type: Improvement Priority: Unknown
Reporter: Matt Dale Assignee: Matt Dale
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by GODRIVER-2696 Allow only 0 or 1 options structs in ... Investigating
Related
is related to GODRIVER-964 make option type construction consist... Closed
Epic Link: Go Driver 2.0 Prep
Quarter: FY24Q1
Documentation Changes: Not Needed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

The readconcern package unnecessarily uses the "functional options" pattern which is not used on any other public API. We should remove the functional options pattern and just export all fields in the ReadConcern struct so users can set them directly.

Also, some exported values or functions do not need to be exported:

  • ReadConcern.MarshalBSONValue - There is no known use case for this outside of the Go driver.

Definition of done:

  • Export all fields in the ReadConcern struct.
  • Deprecate the ReadConcern.GetLevel getter.
  • Deprecate Option type and all Option functions.
  • Deprecate WriteConcern.MarshalBSONValue

Note that all deprecated code will be removed or unexported in Go Driver 2.0.



 Comments   
Comment by Githook User [ 17/Apr/23 ]

Author:

{'name': 'Matt Dale', 'email': '9760375+matthewdale@users.noreply.github.com', 'username': 'matthewdale'}

Message: GODRIVER-2686 Simplify the readconcern API. (#1231)
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/a06fc6628e2b9cea970a1773dabb26dbc6980ea5

Comment by Matt Dale [ 13/Apr/23 ]

PR: https://github.com/mongodb/mongo-go-driver/pull/1231

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