DOCSP-51349: Upgrade guide #127
Conversation
✅ Deploy Preview for docs-kotlin-sync ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🔄 Deploy Preview for docs-kotlin-sync processing
|
source/reference/upgrade.txt
Outdated
| dependency versioning to match the versioning for the JVM drivers. Future versions of | ||
| ``mongodb-crypt`` will be released alongside the driver and will share the same version number. | ||
| You must upgrade your ``mongodb-crypt`` dependency to v5.2.0 when upgrading your driver for | ||
| this release. |
There was a problem hiding this comment.
Note to reviewer: additional breaking change from the Kotlin what's new page
source/reference/upgrade.txt
Outdated
| not include comma characters in the ``authMechanismProperties`` connection | ||
| string value. |
There was a problem hiding this comment.
Note to reviewer: additional breaking change from the Kotlin what's new page
source/reference/upgrade.txt
Outdated
| changes between the current and upgrade versions. For example, if you | ||
| are upgrading the driver from v5.0 to v5.5, address all breaking changes from | ||
| the version after v5.0 including any listed for v5.5. |
There was a problem hiding this comment.
| the version after v5.0 including any listed for v5.5. | |
| the versions after v5.0 including any listed for v5.5. |
source/reference/upgrade.txt
Outdated
| - Revises the `mongodb-crypt <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__ | ||
| dependency versioning to match the versioning for the JVM drivers. Future versions of | ||
| ``mongodb-crypt`` will be released alongside the driver and will share the same version number. |
There was a problem hiding this comment.
| ``mongodb-crypt`` will be released alongside the driver and will share the same version number. | |
| ``mongodb-crypt`` are released alongside the driver and share the same version number. |
source/reference/upgrade.txt
Outdated
| This driver version introduces the following breaking changes: | ||
|
|
||
| - When using the ``MONGODB-OIDC`` authentication mechanism, you must |
There was a problem hiding this comment.
| - When using the ``MONGODB-OIDC`` authentication mechanism, you must | |
| - When using the ``MONGODB-OIDC`` authentication mechanism, you must |
what happens if you do?
There was a problem hiding this comment.
The only info about the consequences I can find is in the DRIVERS ticket, which says the driver "will parse connection strings ambiguously." I think it just would result in unexpected behavior due to how it's parsed? not sure if that's worth mentioning here, but I added a suggestion to pass the value in the MongoClientSettings instead
| To view breaking changes for earlier driver versions, see the | ||
| :github:`Release Notes <mongodb/mongo-java-driver/releases>` in the | ||
| ``mongo-java-driver`` GitHub repository. |
There was a problem hiding this comment.
Should this be changed to the link for release notes in the mongo kotlin driver repo instead?
There was a problem hiding this comment.
The Kotlin driver folder is in the mongo-java-driver repo, i don't think there are specific Kotlin release notes (unless I'm missing something)
There was a problem hiding this comment.
i see, thanks for checking in on that!
source/reference/upgrade.txt
Outdated
| This driver version introduces the following breaking changes: | ||
|
|
||
| - When using the ``MONGODB-OIDC`` authentication mechanism, you must |
There was a problem hiding this comment.
| - When using the ``MONGODB-OIDC`` authentication mechanism, you must | |
| - When using the ``MONGODB-OIDC`` authentication mechanism, you cannot |
source/reference/upgrade.txt
Outdated
|
|
||
| You cannot use a 3.x version of the {+driver-short+} to connect to a | ||
| MongoDB deployment running {+mdb-server+} v8.1. Starting in {+mdb-server+} v8.1, |
There was a problem hiding this comment.
| MongoDB deployment running {+mdb-server+} v8.1. Starting in {+mdb-server+} v8.1, | |
| MongoDB deployment running {+mdb-server+} v8.1 or later. Starting in {+mdb-server+} v8.1, |
Pull Request Info
PR Reviewing Guidelines
Note to reviewer: The breaking changes are the same as the Java sync changes, with a couple additions from the Kotlin Sync What's New page. I added PR comments where I made these updates.
JIRA - https://jira.mongodb.org/browse/DOCSP-51349
Staging Links
Self-Review Checklist