Skip to content

Commit 76669eb

Browse files
committed
docs: revisions based on Bailey's review
1 parent aac995c commit 76669eb

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

etc/notes/CHANGES_7.0.0.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The main focus of this release was usability improvements and a streamlined API.
2525
- [All encryption-related errors now subclass MongoError](#all-encryption-related-errors-now-subclass-mongoerror)
2626
- ['PoolRequstedRetry' error label renamed to 'PoolRequestedRetry'](#poolrequstedretry-error-label-renamed-to-poolrequestedretry)
2727
- [💥 Misc breaking improvements](#-misc-breaking-improvements)
28-
- [Change streams no longer whitelist `$changeStream` stage options](#change-streams-no-longer-whitelist-changestream-stage-options)
28+
- [Change streams no longer filter `$changeStream` stage options](#change-streams-no-longer-filter-changestream-stage-options)
2929
- [Cursors no longer provide a default `batchSize` of 1000 for `getMore`s](#cursors-no-longer-provide-a-default-batchsize-of-1000-for-getmores)
3030
- [Auto encryption options now include default filenames in TS](#auto-encryption-options-now-include-default-filenames-in-ts)
3131
- [☀️ Misc non-breaking improvements](#%EF%B8%8F-misc-non-breaking-improvements)
@@ -34,7 +34,7 @@ The main focus of this release was usability improvements and a streamlined API.
3434
- [📜 Removal of deprecated functionality](#-removal-of-deprecated-functionality)
3535
- [Cursor and ChangeStream `stream()` method no longer accepts a transform](#cursor-and-changestream-stream-method-no-longer-accepts-a-transform)
3636
- [MONGODB-CR AuthMechanism has been removed](#mongodb-cr-authmechanism-has-been-removed)
37-
- [Internal `ClientMetadata` properties have been removed](#internal-clientmetadata-properties-have-been-removed)
37+
- [Internal `ClientMetadata` properties have been removed from the public API](#internal-clientmetadata-properties-have-been-removed-from-the-public-api)
3838
- [`CommandOptions.noResponse` option removed](#commandoptionsnoresponse-option-removed)
3939
- [Assorted deprecated type, class, and option removals](#assorted-deprecated-type-class-and-option-removals)
4040
- [⚠️ ALL BREAKING CHANGES](#%EF%B8%8F-all-breaking-changes)
@@ -86,7 +86,7 @@ When providing a custom AWS credential provider via the auth mechanism property
8686

8787
### Explicitly provided credentials no longer accepted with MONGODB-AWS authentication
8888

89-
AWS environments (such as AWS Lambda) do not have credentials that are permanent and expire within a set amount of time. Providing credentials in the URI or options would mandate that those credentials would be valid for the life of the `MongoClient`, which is problematic. With this change, the installed required AWS SDK will now fetch credentials using the environment, endpoints, or a custom credential provider.
89+
AWS environments (such as AWS Lambda) do not have credentials that are permanent and expire within a set amount of time. Providing credentials in the URI or options would mandate that those credentials would be valid for the life of the `MongoClient`, which is problematic. With this change, the fetching of credentials is fully handled by the installed required AWS SDK.
9090

9191
This means that for AWS authentication, all client URIs MUST now be specified as:
9292

@@ -95,7 +95,9 @@ import { MongoClient } from 'mongodb';
9595

9696
const client = new MongoClient('mongodb<+srv>://<host>:<port>/?authMechanism=MONGODB-AWS');
9797
```
98+
9899
The previous method of providing URI encoded credentials based on the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` directly in the connection string will no longer work.
100+
99101
## ⚙️ Error handling improvements
100102

101103
### Dropping a collection returns false instead of throwing when NS not found
@@ -118,9 +120,9 @@ The `PoolClearedError` thrown in cases where the connection pool was cleared now
118120

119121
## 💥 Misc breaking improvements
120122

121-
### Change streams no longer whitelist `$changeStream` stage options
123+
### Change streams no longer filter `$changeStream` stage options
122124

123-
Uses are now able to pass any option to `collection.watch()` and if it is invalid in the `$changeStream` stage of the pipeline the server will error. This is to allow users to provide newly added options quickly that are not in our public types.
125+
Users can now pass any option to `collection.watch()`. If an option is invalid for the `$changeStream` stage of the pipeline, the server will return an error. This change makes it possible to use newly introduced server options without waiting for them to become available in our public type definitions and eliminates the risk of valid but unrecognized options being silently ignored.
124126

125127
### Cursors no longer provide a default `batchSize` of 1000 for `getMore`s
126128

@@ -175,9 +177,9 @@ const stream = cursor.stream().map(JSON.stringify);
175177

176178
This mechanism has been unsupported as of MongoDB 4.0 and attempting to use it will still raise an error.
177179

178-
### Internal `ClientMetadata` properties have been removed
180+
### Internal `ClientMetadata` properties have been removed from the public API
179181

180-
Previous versions of the driver unintentionally made properties used when constructing client metadata public. These properties have now been made internal. The full list of properties is:
182+
Previous versions of the driver unintentionally exposed the following properties that have now been made internal:
181183

182184
```
183185
MongoClient.options.additionalDriverInfo

0 commit comments

Comments
 (0)