diff --git a/source/upgrade.txt b/source/upgrade.txt index 5e8069a7..05be1daa 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -70,12 +70,13 @@ The breaking changes in this section are categorized by the major version releases that introduced them. When upgrading driver versions, address all the breaking changes between your current version and the planned upgrade version. For example, if you are upgrading the driver -from v3.x to v5.x, address all breaking changes listed under v4.x and -v5.x. +from v3.x to v5.x, address all breaking changes listed under v4.0 and +v5.0. .. _node-breaking-changes-v6.x: +.. _node-breaking-changes-v6.0: -Version 6.x Breaking Changes +Version 6.0 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Version 6.0 of the {+driver-short+} requires Node.js v16.20.1 or later. @@ -84,7 +85,7 @@ Version 6.x Breaking Changes - The driver removes support for the ``collStats`` operation. Use the :manual:`$collStats ` aggregation operator instead. -- The driver deprecates all the ``ssl``-prefixed options and the +- The driver removes all the deprecated ``ssl``-prefixed options and the ``tlsCertificateFile`` option in the ``MongoClientOptions`` type. Create a ``SecureContext`` object or set the ``tls``-prefixed options in your ``MongoClientOptions`` instance instead. @@ -138,13 +139,13 @@ Version 6.x Breaking Changes - Raised the optional ``zstd`` dependency minimum version to 1.1.0. .. _node-breaking-changes-v5.x: +.. _node-breaking-changes-v5.0: -Version 5.x Breaking Changes +Version 5.0 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Driver versions 5.x are not compatible with Node.js - v12 or earlier. If you want to use this version of the driver, you must - use Node.js v14.20.1 or greater. +- The driver is no longer compatible with Node.js v12 or earlier. If you want to use + this version of the driver, you must use Node.js v14.20.1 or greater. - The driver removes support for callbacks in favor of a promise-based API. The following list provides some strategies for callback users to adopt this @@ -192,13 +193,13 @@ Version 5.x Breaking Changes - ``AsyncIterator`` interface removed in favor of ``AsyncGenerator`` .. _node-breaking-changes-v4.x: +.. _node-breaking-changes-v4.0: -Version 4.x Breaking Changes +Version 4.0 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Driver versions 4.x are not compatible with Node.js - v12.8 or earlier. If you want to use this version of the driver, You must - use Node.js v12.9 or greater. +- The driver is no longer compatible with Node.js v12.8 or earlier. If you + want to use this version of the driver, you must use Node.js v12.9 or greater. - ``Cursor`` types no longer extend ``Readable`` directly. diff --git a/source/whats-new.txt b/source/whats-new.txt index 656ce98b..d8c322bc 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -244,7 +244,7 @@ What's New in 6.0 .. warning:: Breaking Changes in v6.0 This driver version introduces breaking changes. For a list of these changes, see - the :ref:`Version 6.x Breaking Changes section ` in the + the :ref:`Version 6.0 Breaking Changes section ` in the Upgrade guide. The {+driver-short+} v6.0 release includes the following features: @@ -538,7 +538,7 @@ What's New in 5.0 .. warning:: Breaking Changes in v5.0 This driver version introduces breaking changes. For a list of these changes, see - the :ref:`Version 5.x Breaking Changes section ` in the + the :ref:`Version 5.0 Breaking Changes section ` in the Upgrade guide. New features of the 5.0 {+driver-short+} release include: @@ -912,7 +912,7 @@ What's New in 4.0 .. warning:: Breaking Changes in v4.0 This driver version introduces breaking changes. For a list of these changes, see - the :ref:`Version 4.x Breaking Changes section ` in + the :ref:`Version 4.0 Breaking Changes section ` in the Upgrade guide. New features of the 4.0 Node.js driver release include: