Skip to content

DOCSP-31193: v5.7 updates #707

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

Merged
merged 8 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .backportrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
// the branches available to backport to
"targetBranchChoices": [
"master",
"v5.7",
"v5.6",
"v5.5",
"v5.4",
Expand Down
4 changes: 2 additions & 2 deletions config/redirects
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
define: prefix docs/drivers/node
define: base https://www.mongodb.com/${prefix}
define: versions v3.6 v3.7 v4.0 v4.1 v4.2 v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v4.12 v4.13 v4.14 v4.15 v5.0 v5.1 v5.2 v5.3 v5.4 v5.5 v5.6 master
define: versions v3.6 v3.7 v4.0 v4.1 v4.2 v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v4.12 v4.13 v4.14 v4.15 v5.0 v5.1 v5.2 v5.3 v5.4 v5.5 v5.6 v5.7 master

symlink: current -> master

Expand All @@ -20,4 +20,4 @@ raw: ${prefix}/stable -> ${base}/current/
[v4.3-master]: ${prefix}/${version}/fundamentals/utf8-validation/ -> ${base}/${version}/fundamentals/bson/utf8-validation/
[*-v4.2]: ${prefix}/${version}/fundamentals/utf8-validation/ -> ${base}/${version}/

[*-v5.5]: ${prefix}/${version}/fundamentals/run-command/ -> ${base}/${version}/usage-examples/command/
[*-v5.5]: ${prefix}/${version}/fundamentals/run-command/ -> ${base}/${version}/usage-examples/command/
2 changes: 1 addition & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ toc_landing_pages = [
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

[constants]
version = "5.6"
version = "5.7"
api = "https://mongodb.github.io/node-mongodb-native/{+version+}"
driver-long = "MongoDB Node.js driver"
driver-short = "Node.js driver"
Expand Down
10 changes: 7 additions & 3 deletions source/fundamentals/crud/compound-operations.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _node-crud-compound-operations:

===================
Compound Operations
===================
Expand Down Expand Up @@ -26,6 +28,8 @@ more difficult. When your application has to handle potential errors at
any stage of the process, it can become brittle and difficult
to test.

.. _node-compound-operations-builtin:

Built-in Methods
----------------

Expand All @@ -41,7 +45,7 @@ configurable :ref:`sort <node-fundamentals-sort>` and
:ref:`projection <node-fundamentals-project>` options.

.. note:: includeResultMetadata Option

Starting in version 5.7, you can set the ``includeResultMetadata``
setting in the ``options`` object to specify the return type for each
of these methods. The setting defaults to ``true``, which means the
Expand All @@ -50,7 +54,7 @@ configurable :ref:`sort <node-fundamentals-sort>` and
modified document.

Suppose a collection contains the following document:

.. code-block:: json

{ _id: 1, x: "on" }
Expand All @@ -60,7 +64,7 @@ configurable :ref:`sort <node-fundamentals-sort>` and
``false``:

.. code-block:: js

// returns { _id: 1, x: 'on' }
await coll.findOneAndDelete({ x: "on" }, { includeResultMetadata: false });

Expand Down
12 changes: 12 additions & 0 deletions source/includes/mongodb-compatibility-table-node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@
- MongoDB 3.0
- MongoDB 2.6

* - 5.7
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓
-
-
-
-

* - 5.6
- ✓
- ✓
Expand Down
39 changes: 39 additions & 0 deletions source/whats-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ What's New

Learn what's new in:

* :ref:`Version 5.7 <version-5.7>`
* :ref:`Version 5.6 <version-5.6>`
* :ref:`Version 5.5 <version-5.5>`
* :ref:`Version 5.4 <version-5.4>`
Expand All @@ -38,6 +39,44 @@ Learn what's new in:
* :ref:`Version 3.7 <version-3.7>`
* :ref:`Version 3.6 <version-3.6>`

.. _version-5.7:

What's New in 5.7
-----------------

The {+driver-short+} v5.7 release includes the following features:

.. important:: Deprecation Notice

- The following Write Concern options are deprecated:

- ``wtimeout``
- ``j``
- ``fsync``

To specify the write concern behavior, use the ``wtimeoutMS`` and
``journal`` options instead. To learn more about these options, see the
:ref:`<node-connection-options>` page.

- SSL options and other transport encryption options are deprecated.
To learn more about the deprecated options and which options to use
instead, see the Legacy SSL options deprecated section in the
v5.7.0 Release Highlights linked at the end of this section.

- A new option for ``findOneAnd...`` compound methods. The ``includeResultMetaData``
option allows you to specify whether to include information about the
operation result. See the
:ref:`Compound Operations Built-in Methods <node-compound-operations-builtin>`
section for more information.

- Support for change stream split events which enables processing change
stream documents that exceed the 16MB maximum BSON size limit.

- A new API for managing Atlas Search indexes.

To learn more about this release, see the
`v5.7.0 Release Highlights <https://github.com/mongodb/node-mongodb-native/releases/tag/v5.7.0>`__.

.. _version-5.6:

What's New in 5.6
Expand Down