GODRIVER-852 Add documentation warning against the use of duplicate key names #614
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iwysiu
reviewed
Mar 25, 2021
added 2 commits
March 25, 2021 10:40
iwysiu
approved these changes
Mar 25, 2021
divjotarora
reviewed
Mar 25, 2021
divjotarora
approved these changes
Mar 30, 2021
kevinAlbs
reviewed
Apr 1, 2021
mongo/collection.go
Outdated
| @@ -319,7 +319,9 @@ func (coll *Collection) insert(ctx context.Context, documents []interface{}, | |||
| // | |||
| // The document parameter must be the document to be inserted. It cannot be nil. If the document does not have an _id | |||
| // field when transformed into BSON, one will be added automatically to the marshalled document. The original document | |||
| // will not be modified. The _id can be retrieved from the InsertedID field of the returned InsertOneResult. | |||
| // will not be modified. The _id can be retrieved from the InsertedID field of the returned InsertOneResult. The document | |||
| // parameter should NOT contain duplicate key names, as that can result in undefined behavior from the server. | |||
There was a problem hiding this comment.
Would this apply to any CRUD function that results in a document getting inserted or replaced? (FindOneAndReplace, ReplaceOne, Replace). As well as the insert models for bulk write.
If that is right, then I think we'd want to document them all, or just document bson.D. My vote goes for just bson.D.
There was a problem hiding this comment.
Discussed offline: it seems like overkill to document every CRUD function that results in a document getting inserted or replaced. Instead, we've opted to only warn against duplicate keys on bson.D and in bson/doc.go. Let me know what you think...
There was a problem hiding this comment.
I prefer this for consistency.
kevinAlbs
approved these changes
Apr 16, 2021
iwysiu
approved these changes
Apr 16, 2021
benjirewis
added a commit
that referenced
this pull request
Apr 16, 2021
tsedgwick
pushed a commit
to mongodb-forks/mongo-go-driver
that referenced
this pull request
May 27, 2021
tsedgwick
pushed a commit
to mongodb-forks/mongo-go-driver
that referenced
this pull request
Jun 1, 2021
faem
pushed a commit
to kubedb/mongo-go-driver
that referenced
this pull request
Mar 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.