-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCSP-43092 Upgrade versions #50
Merged
stephmarie17
merged 4 commits into
mongodb:standardization
from
stephmarie17:docsp-43092-upgrade-versions
Sep 26, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
.. _c-upgrade: | ||
|
||
======================= | ||
Upgrade Driver Versions | ||
======================= | ||
|
||
.. contents:: On this page | ||
:local: | ||
:backlinks: none | ||
:depth: 2 | ||
:class: singlecol | ||
|
||
.. facet:: | ||
:name: genre | ||
:values: reference | ||
|
||
.. meta:: | ||
:keywords: compatibility, backwards compatibility | ||
|
||
Overview | ||
-------- | ||
|
||
This page describes the changes you must make to your application | ||
when you upgrade to a new version of the {+driver-short+}. | ||
|
||
Before you upgrade, perform the following actions: | ||
|
||
.. TODO: Link to platform support page | ||
- Ensure the new {+driver-short+} version is compatible with the {+mdb-server+} versions | ||
your application connects to and the platform your application runs on. For version | ||
compatibility information, see the :ref:`{+driver-short+} Compatibility <c-compatibility>` | ||
page. | ||
- Address any breaking changes between the current driver version | ||
your application uses and your planned upgrade version in the | ||
:ref:`Breaking Changes <c-breaking-changes>` section. To learn more about | ||
{+mdb-server+} release compatibility changes, see the | ||
:ref:`Server Release Compatibility Changes <c-server-release-compatability-changes>` section. | ||
|
||
.. TODO: Add a tip to use the stable API and link to corresponding page. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [note for reviewer] Wasn't sure where this page would live in the updated docs structure so left as a todo for now. |
||
|
||
.. _c-breaking-changes: | ||
|
||
Breaking Changes | ||
---------------- | ||
|
||
.. note:: | ||
|
||
The {+driver-short+} follows :wikipedia:`semantic versioning. <Software_versioning#Schemes>` | ||
The driver may break build systems or package compatibility in any release. Patch releases | ||
may revert accidental API breaking changes. | ||
|
||
A breaking change is a change of a convention or a behavior starting in a specific | ||
version of the driver. This type of change may prevent your application from working | ||
properly if not addressed before upgrading the driver. | ||
|
||
The breaking changes in this section are categorized by the driver version that introduced | ||
them. When upgrading driver versions, address all the breaking changes between the current | ||
and upgrade versions. | ||
|
||
.. example:: Upgrading from Version 1.26 | ||
|
||
If you're upgrading the {+driver-short+} from version 1.26 to version 1.27, | ||
address all breaking changes listed for versions 1.27.0 to 1.27.6, if any. | ||
|
||
.. _c-version-1.24.0-breaking-changes: | ||
|
||
Version 1.24.0 Breaking Changes | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
The 1.24.0 release of ``libmongoc``, one of the libraries constituting the C driver, introduces | ||
the following backward-breaking change: | ||
|
||
- Requires {+mdb-server+} version 7.0 and later to use Queryable Encryption. | ||
|
||
.. _c-server-release-compatability-changes: | ||
|
||
Server Release Compatibility Changes | ||
------------------------------------- | ||
|
||
A server release compatibility change is a modification | ||
to the driver that discontinues support for a set of | ||
{+mdb-server+} versions. | ||
|
||
The driver discontinues support for a {+mdb-server+} version after it reaches | ||
end-of-life (EOL). | ||
|
||
To learn more about MongoDB support for EOL products, | ||
see the `Legacy Support Policy. <https://www.mongodb.com/support-policy/legacy>`__ | ||
|
||
.. _c-version-1.28.0-release-support-changes: | ||
|
||
Version 1.28.0 Release Support Changes | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
- This driver version drops support for {+mdb-server+} versions 3.6 and earlier. To use any driver | ||
from versions 1.28.0 and later, your {+mdb-server+} must be version 4.0 or later. This driver version | ||
supports {+mdb-server+} 8.0 features. To learn how to upgrade your {+mdb-server+} | ||
deployment, see :manual:`Release Notes </release-notes>` in the {+mdb-server+} manual. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[note for reviewer] Wasn't sure where this page would live in the updated docs structure so left as a todo for now.