GODRIVER-2979 Rename SingleResult DecodeBytes to Raw #1395
Conversation
prestonvasquez
requested review from
blink1073
and removed request for
a team
prestonvasquez
had a problem deploying
to
api-report
GitHub Actions
Failure
prestonvasquez
had a problem deploying
to
api-report
GitHub Actions
Failure
|
We should start a migration guide and add this as the first item. |
@blink1073 what are your thoughts on approaching this? We have a ticket for creating a migration guide, GODRIVER-2705, but there are still open questions. Using the deprecation grammar might be enough for now since it will let users know to switch off the deprecated SingleResult.DecodeTypes in favor of SingleResult.Raw . One approach is to use these grammars to search for "Deprecated" methods in v1.x docs and note their migration patterns in the release notes. Here are a few example release notes:
Rust Example: We could keep a running list of breaking changes on GODRIVER-2705 ? |
|
I like the idea of having the running list of deprecations in GODRIVER-2705, so that users can follow that ticket for updates. |
I've updated GODRIVER-2705 to note this deprecation. I am checking with @qingyang-hu on his thoughts extending this list with hist work on GODRIVER-2617 : https://jira.mongodb.org/browse/GODRIVER-2617?focusedCommentId=5732353&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-5732353 |
|
Update: we've decided to list *new* deprecations in GODRIVER-2705 as part of the 2.0 effort. |
Co-authored-by: Steven Silvester <[email protected]>
GODRIVER-2979
Summary
Deprecate SingleResult.DecodeBytes in Go Driver v1 and update it to call SingleResult.Raw.
Background & Motivation
The method SingleResult.DecodeBytes is a misnomer because it does not decode the result, but returns the raw bytes. It would be better to rename it SingleResult.Raw instead.