Skip to content

Commit e1fc075

Browse files
author
Chris Cho
authored
DOCSP-24606: add info about v4.8 server breaking change and upgrading (#294)
* DOCSP-24606: add info about v4.8 server breaking change and upgrading
1 parent f16f52e commit e1fc075

File tree

3 files changed

+43
-30
lines changed

3 files changed

+43
-30
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ driver = "java"
1919
driver-long = "MongoDB Java Driver"
2020
version = "4.8"
2121
full-version = "{+version+}.0-beta0"
22+
mdb-server = "MongoDB server"
2223

2324
package-name-org = "mongodb-org"
2425
api = "https://mongodb.github.io/mongo-java-driver/{+version+}"

source/upgrade.txt

Lines changed: 40 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,46 +21,22 @@ application to upgrade your driver to a new version.
2121

2222
Before you upgrade, perform the following actions:
2323

24-
- Ensure the new version is compatible with the MongoDB server versions
24+
- Ensure the new version is compatible with the {+mdb-server} versions
2525
your application connects to and the Java Runtime Environment (JRE) your
2626
application runs on. See the :ref:`Java Compatibility <java-compatibility-tables>`
2727
page for this information.
2828
- Address any breaking changes between the current version of the driver
2929
your application is using and your planned upgrade version in the
30-
section on :ref:`Breaking Changes <java-breaking-changes>` below.
30+
:ref:`Breaking Changes <java-breaking-changes>` section. To learn
31+
more about the {+mdb-server+} release compatibility changes, see the
32+
:ref:`<java-server-release-changes>` section.
3133

3234
.. tip::
3335

3436
To minimize the amount of changes your application may require when
3537
upgrading driver versions in the future, use the
3638
:ref:`{+stable-api+} <stable-api-java>`.
3739

38-
.. _java-server-release-changes:
39-
40-
Server Release Compatibility Changes
41-
------------------------------------
42-
43-
A server release compatibility change is a modification
44-
to the {+driver-long+} that discontinues support for a set of
45-
MongoDB server versions.
46-
47-
To learn more about end-of-life MongoDB products,
48-
see the `Legacy Support Policy <https://www.mongodb.com/support-policy/legacy>`__.
49-
50-
.. _java-server-release-change-v4.8:
51-
52-
Version 4.8 Server Release Support Changes
53-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54-
55-
- The v4.8 driver drops support for MongoDB v3.4 and earlier.
56-
To use the v4.8 driver, your MongoDB server must be v3.6 or later. To learn
57-
how to upgrade your MongoDB server to v3.6, follow the link corresponding
58-
to your MongoDB configuration:
59-
60-
- :ref:`<3.6-upgrade-replica-set>`
61-
- :ref:`<3.6-upgrade-standalone>`
62-
- :ref:`<3.6-upgrade-sharded-cluster>`
63-
6440
.. _java-breaking-changes:
6541

6642
Breaking Changes
@@ -76,6 +52,14 @@ changes between the current and upgrade versions. For example, if you
7652
are upgrading the driver from v4.0 to v4.5, address all breaking changes from
7753
the version after v4.0 including any listed under v4.5.
7854

55+
.. _java-breaking-changes-v4.8:
56+
57+
Version 4.8 Breaking Changes
58+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59+
60+
- The driver ends support for connecting to {+mdb-server+} versions v3.4 and
61+
earlier. To learn more about this change, see the :ref:`<java-server-release-change-v4.8>`
62+
section.
7963

8064
.. _java-breaking-changes-v4.7:
8165

@@ -148,3 +132,31 @@ Version 4.0 Breaking Changes
148132
any classes that link to the driver against this version or later to ensure
149133
that they continue to work.
150134

135+
.. _java-server-release-changes:
136+
137+
Server Release Compatibility Changes
138+
------------------------------------
139+
140+
A server release compatibility change is a modification
141+
to the {+driver-long+} that discontinues support for a set of
142+
{+mdb-server+} versions.
143+
144+
The driver discontinues support for a {+mdb-server+} version after it reaches
145+
end-of-life (EOL).
146+
147+
To learn more about the MongoDB support for EOL products,
148+
see the `Legacy Support Policy <https://www.mongodb.com/support-policy/legacy>`__.
149+
150+
.. _java-server-release-change-v4.8:
151+
152+
Version 4.8 Server Release Support Changes
153+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154+
155+
- The v4.8 driver drops support for {+mdb-server+} v3.4 and earlier.
156+
To use the v4.8 driver, your {+mdb-server+} must be v3.6 or later. To learn
157+
how to upgrade your {+mdb-server+} to v3.6, follow the link that corresponds
158+
to your MongoDB deployment configuration:
159+
160+
- :ref:`<3.6-upgrade-replica-set>`
161+
- :ref:`<3.6-upgrade-standalone>`
162+
- :ref:`<3.6-upgrade-sharded-cluster>`

source/whats-new.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ What's New in 4.8
3232
-------------------
3333

3434
The 4.8 driver ends support for MongoDB v3.4 and earlier. To learn
35-
how to upgrade your driver to v4.8, see
36-
:ref:`<java-server-release-change-v4.8>`.
35+
more about breaking changes in this driver version and how to address
36+
them, see :ref:`<java-server-release-change-v4.8>`.
3737

3838
.. _version-4.7.1:
3939
.. _version-4.7:

0 commit comments

Comments
 (0)