Skip to content

Commit 456948c

Browse files
authored
DOCSP-27170: aws sdk is an optional dependency (#490)
* DOCSP-27170: aws sdk is an optional dependency * DB PR fixes 1
1 parent eed5658 commit 456948c

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

source/whats-new.txt

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,30 @@ What's New in 5.0
4141

4242
New features of the 5.0 {+driver-short+} release include:
4343

44-
- Removal of ``Collection.insert()``, ``Collection.update()``, and
45-
``Collection.remove()`` helper methods.
44+
- Optional installation of ``@aws-sdk/credential-providers`` as a dependency.
4645

46+
- The driver no longer includes AWS SDK modules by default. Use the
47+
following ``npm`` command to install the SDK:
48+
49+
.. code-block:: bash
50+
51+
npm install --save @aws-sdk/[email protected]
52+
53+
If you install the SDK, ``npm`` notifies you if the version of the SDK you
54+
installed is incompatible with the driver. Once you install the
55+
dependency successfully, the driver uses the AWS SDK itself to
56+
manage credentials from the environment.
57+
58+
.. important:: Breaking Change: Removal of CRUD Helper Methods
59+
60+
This release removes support for the ``Collection.insert()``, ``Collection.update()``, and
61+
``Collection.remove()`` helper methods. The following list provides
62+
instructions on how to replace the functionality of the removed methods:
63+
64+
- Migrate from ``Collection.insert()`` to ``insertOne()`` or ``insertMany()``
65+
- Migrate from ``Collection.update()`` to ``updateOne()`` or ``updateMany()``
66+
- Migrate from ``Collection.remove()`` to ``deleteOne()`` or ``deleteMany()``
67+
4768
.. _version-4.13:
4869

4970
What's New in 4.13

0 commit comments

Comments
 (0)