Skip to content
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-41078 - v6.8 #896

Merged
merged 8 commits into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
2 changes: 1 addition & 1 deletion 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 v4.16 v4.17 v5.0 v5.1 v5.2 v5.3 v5.4 v5.5 v5.6 v5.7 v5.8 v5.9 v6.0 v6.1 v6.2 v6.3 v6.4 v6.5 v6.6 v6.7 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 v4.16 v4.17 v5.0 v5.1 v5.2 v5.3 v5.4 v5.5 v5.6 v5.7 v5.8 v5.9 v6.0 v6.1 v6.2 v6.3 v6.4 v6.5 v6.6 v6.7 v6.8 master

symlink: current -> master

Expand Down
2 changes: 1 addition & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ toc_landing_pages = [
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

[constants]
version = "6.7"
version = "6.8"
api = "https://mongodb.github.io/node-mongodb-native/{+version+}"
driver-long = "MongoDB Node.js driver"
driver-short = "Node.js driver"
Expand Down
2 changes: 1 addition & 1 deletion source/includes/mongodb-compatibility-table-node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- MongoDB 3.0
- MongoDB 2.6

* - 6.0 to 6.7
* - 6.0 to 6.8
- ✓
- ✓
- ✓
Expand Down
64 changes: 64 additions & 0 deletions source/whats-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ What's New

Learn what's new in:

* :ref:`Version 6.8 <version-6.8>`
* :ref:`Version 6.7 <version-6.7>`
* :ref:`Version 6.6 <version-6.6>`
* :ref:`Version 6.5 <version-6.5>`
Expand Down Expand Up @@ -58,6 +59,69 @@ Learn what's new in:
* :ref:`Version 3.7 <version-3.7>`
* :ref:`Version 3.6 <version-3.6>`

.. _version-6.8:

What's New in 6.8
-----------------

The {+driver-short+} v6.7 release includes the following features:
mongoKart marked this conversation as resolved.
Show resolved Hide resolved

- Fixes a bug where a local KMS provider accepted a ``BSON Binary`` instance at
runtime, but the TypeScript compiler allowed only values of type ``Buffer`` and
``string``.

- The ``ReadConcernMajorityNotAvailableYet`` error is now a retryable read error.

- KMS providers can now be associated with a name, and multiple keys can be provided
for each KMS provider. This feature requires ``mongodb-client-encryption`` v6.0.1 or later.
mongoKart marked this conversation as resolved.
Show resolved Hide resolved
You can't use named KMS providers if your application uses the automatic
KMS provider refresh capability.

The following code example shows how to configure a ``ClientEncryption`` object with
multiple AWS keys:

.. code-block:: javascript
:copyable: true

const clientEncryption = new ClientEncryption(keyVaultClient, {
'aws:key1': {
accessKeyId: ...,
secretAccessKey: ...
},
'aws:key2': {
accessKeyId: ...,
secretAccessKey: ...
},

clientEncryption.createDataKey('aws:key-1', { ... });
jordan-smith721 marked this conversation as resolved.
Show resolved Hide resolved

- When you create a KMIP data key, you can now specify the ``delegated`` option. If this
option is set to ``true``, the KMIP provider performs encryption and decryption of
the data key locally, ensuring that the encryption key never leaves the KMIP server.
This feature requires ``mongodb-client-encryption`` v6.0.1 or later.

The following code example shows how to specify this option:

.. code-block:: javascript
:copyable: true

clientEncryption.createDataKey('kmip', { masterKey: { delegated: true } } );
jordan-smith721 marked this conversation as resolved.
Show resolved Hide resolved

- The driver now decodes BSON responses as the cursor iterates over them,
rather than decoding the entire BSON response when it is received.

- The Github release for the ``mongodb`` package now contains a detached signature file for
the NPM package (named ``mongodb-X.Y.Z.tgz.sig``). This change applies to every major
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these parenthesis are necessary

Suggested change
the NPM package (named ``mongodb-X.Y.Z.tgz.sig``). This change applies to every major
the NPM package ``mongodb-X.Y.Z.tgz.sig``. This change applies to every major

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think the file name refers to the signature file, not the NPM package. reworded anyway

mongoKart marked this conversation as resolved.
Show resolved Hide resolved
and patch release for versions 5 and 6 of the driver. To verify the package signature,
mongoKart marked this conversation as resolved.
Show resolved Hide resolved
follow the instructions in the Release Integrity section of the
`README.md <https://github.com/mongodb/node-mongodb-native/blob/v6.8.0/README.md#release-integrity>`__
file in the driver's GitHub repository.

To learn more about this release, see the
`v6.8.0 Release Notes
<https://github.com/mongodb/node-mongodb-native/releases/tag/v6.8.0>`__ on
GitHub.

.. _version-6.7:

What's New in 6.7
Expand Down
Loading