GODRIVER-3339 Separate Many and One for UpdateOptions and DeleteOptions.
#1819
Conversation
API Change Report./v2/mongo/optionsincompatible changesDelete: removed compatible changesDeleteMany: added |
qingyang-hu
force-pushed
the
godriver3339
branch
from
875fbb2
to
3b76520
Compare
qingyang-hu
added
priority-2-medium
| func createUpdateArguments(args bson.Raw) (*updateArguments, error) { | ||
| ua := &updateArguments{ | ||
| opts: options.Update(), | ||
| func createUpdateArguments[Options options.UpdateManyOptions | options.UpdateOneOptions]( |
There was a problem hiding this comment.
We should not try to generalize this function. Instead, we should maintain createUpdateOneArguments and createUpdateManyArguments. Using the combination of reflection and generics here is difficult to read.
| // A set of filters specifying to which array elements an update should apply. This option is only valid for MongoDB | ||
| // versions >= 3.6. For previous server versions, the driver will return an error if this option is used. The | ||
| // default value is nil, which means the update will apply to all array elements. |
There was a problem hiding this comment.
We don't expect users to interact with the ...Options structs directly in most cases. We should move the struct field comments to the corresponding setter methods. Leave a comment on each struct field that references the corresponding setter method, like
See UpdateManyOptionsBuilder.SetArrayFilters for documentation.
This recommendation applies for the new DeleteManyOptions also. Note that we will update the pattern for the rest of the options types with GODRIVER-3327.
| if doc.multi { | ||
| updateDoc = bsoncore.AppendBooleanElement(updateDoc, "multi", doc.multi) | ||
| } | ||
| if doc.sort != nil { |
There was a problem hiding this comment.
doc.sort is currently never set. Will that be used in the follow-up GODRIVER-3285 PRs?
| type updateOneArguments struct { | ||
| filter bson.Raw | ||
| update interface{} | ||
| opts *options.UpdateOneOptionsBuilder | ||
| } |
There was a problem hiding this comment.
You can avoid creating a new type here by separating filter and update from the options builder, allowing you to reuse updateArguments in both functions.
E.g. updated function signatures:
func createUpdateOneArguments(args bson.Raw) (*updateArguments, *options.UpdateOneOptionsBuilder, error)
func createUpdateManyArguments(args bson.Raw) (*updateArguments, *options.UpdateManyOptionsBuilder, error)
GODRIVER-3339
Summary
Background & Motivation
For DRIVERS-2822,
sortonly applies toUpdateOne. The server throws an error if asortexists inUpdateMany. Therefore, this PR proposes separating the options forUpdateOneandUpdateMany.Although there is no immediate requirement yet, the “DeleteOptions” struct is also considered to be divided for future changes as it is shared by both “DeleteOne” and “DeleteMany” now.