Skip to content

Commit 63c5b7b

Browse files
author
Chris Cho
authored
DOCSP-31193: v5.7 updates (#707)
* DOCSP-31193: v5.7 updates
1 parent e48edb6 commit 63c5b7b

File tree

6 files changed

+62
-6
lines changed

6 files changed

+62
-6
lines changed

.backportrc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
// the branches available to backport to
66
"targetBranchChoices": [
77
"master",
8+
"v5.7",
89
"v5.6",
910
"v5.5",
1011
"v5.4",

config/redirects

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
define: prefix docs/drivers/node
22
define: base https://www.mongodb.com/${prefix}
3-
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
3+
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
44

55
symlink: current -> master
66

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

23-
[*-v5.5]: ${prefix}/${version}/fundamentals/run-command/ -> ${base}/${version}/usage-examples/command/
23+
[*-v5.5]: ${prefix}/${version}/fundamentals/run-command/ -> ${base}/${version}/usage-examples/command/

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ toc_landing_pages = [
1818
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
1919

2020
[constants]
21-
version = "5.6"
21+
version = "5.7"
2222
api = "https://mongodb.github.io/node-mongodb-native/{+version+}"
2323
driver-long = "MongoDB Node.js driver"
2424
driver-short = "Node.js driver"

source/fundamentals/crud/compound-operations.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _node-crud-compound-operations:
2+
13
===================
24
Compound Operations
35
===================
@@ -26,6 +28,8 @@ more difficult. When your application has to handle potential errors at
2628
any stage of the process, it can become brittle and difficult
2729
to test.
2830

31+
.. _node-compound-operations-builtin:
32+
2933
Built-in Methods
3034
----------------
3135

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

4347
.. note:: includeResultMetadata Option
44-
48+
4549
Starting in version 5.7, you can set the ``includeResultMetadata``
4650
setting in the ``options`` object to specify the return type for each
4751
of these methods. The setting defaults to ``true``, which means the
@@ -50,7 +54,7 @@ configurable :ref:`sort <node-fundamentals-sort>` and
5054
modified document.
5155

5256
Suppose a collection contains the following document:
53-
57+
5458
.. code-block:: json
5559

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

6266
.. code-block:: js
63-
67+
6468
// returns { _id: 1, x: 'on' }
6569
await coll.findOneAndDelete({ x: "on" }, { includeResultMetadata: false });
6670

source/includes/mongodb-compatibility-table-node.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@
1515
- MongoDB 3.0
1616
- MongoDB 2.6
1717

18+
* - 5.7
19+
- ✓
20+
- ✓
21+
- ✓
22+
- ✓
23+
- ✓
24+
- ✓
25+
-
26+
-
27+
-
28+
-
29+
1830
* - 5.6
1931
- ✓
2032
- ✓

source/whats-new.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ What's New
1212

1313
Learn what's new in:
1414

15+
* :ref:`Version 5.7 <version-5.7>`
1516
* :ref:`Version 5.6 <version-5.6>`
1617
* :ref:`Version 5.5 <version-5.5>`
1718
* :ref:`Version 5.4 <version-5.4>`
@@ -38,6 +39,44 @@ Learn what's new in:
3839
* :ref:`Version 3.7 <version-3.7>`
3940
* :ref:`Version 3.6 <version-3.6>`
4041

42+
.. _version-5.7:
43+
44+
What's New in 5.7
45+
-----------------
46+
47+
The {+driver-short+} v5.7 release includes the following features:
48+
49+
.. important:: Deprecation Notice
50+
51+
- The following Write Concern options are deprecated:
52+
53+
- ``wtimeout``
54+
- ``j``
55+
- ``fsync``
56+
57+
To specify the write concern behavior, use the ``wtimeoutMS`` and
58+
``journal`` options instead. To learn more about these options, see the
59+
:ref:`<node-connection-options>` page.
60+
61+
- SSL options and other transport encryption options are deprecated.
62+
To learn more about the deprecated options and which options to use
63+
instead, see the Legacy SSL options deprecated section in the
64+
v5.7.0 Release Highlights linked at the end of this section.
65+
66+
- A new option for ``findOneAnd...`` compound methods. The ``includeResultMetaData``
67+
option allows you to specify whether to include information about the
68+
operation result. See the
69+
:ref:`Compound Operations Built-in Methods <node-compound-operations-builtin>`
70+
section for more information.
71+
72+
- Support for change stream split events which enables processing change
73+
stream documents that exceed the 16MB maximum BSON size limit.
74+
75+
- A new API for managing Atlas Search indexes.
76+
77+
To learn more about this release, see the
78+
`v5.7.0 Release Highlights <https://github.com/mongodb/node-mongodb-native/releases/tag/v5.7.0>`__.
79+
4180
.. _version-5.6:
4281

4382
What's New in 5.6

0 commit comments

Comments
 (0)