Reorganize 5.0 release notes #524
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -40,37 +40,65 @@ Learn what's new in: | |||||
| What's New in 5.0 | ||||||
| ----------------- | ||||||
|
|
||||||
| .. warning:: Breaking changes in this release | ||||||
|
There was a problem hiding this comment. For consistency with the What's New sections for previous releases, this should be left as it is.
Suggested change
There was a problem hiding this comment. I see that the warning about deprecations in 4.11 (the latest release at the moment) uses the "Deprecations in this release" wording. This suggests that the wording was changed since release 4.8, where the wording is "Breaking Changes in v4.8". @rachel-mack Are you sure the old wording should be used again? |
||||||
|
|
||||||
| This driver version introduces breaking changes. For a list of these changes, see | ||||||
| the :ref:`Version 5.0 Breaking Changes section <java-breaking-changes-v5.0>` in the | ||||||
| Upgrade guide. | ||||||
|
|
||||||
| .. warning:: Deprecations in this release | ||||||
|
|
||||||
| To avoid breaking changes in future major releases of the driver, | ||||||
| replace any application code that depends on deprecated program elements. | ||||||
|
|
||||||
| This section includes the following information: | ||||||
|
|
||||||
| - :ref:`java-deprecations-5.0` | ||||||
| - :ref:`java-behavioral-changes-5.0` | ||||||
| - :ref:`java-new-features-5.0` | ||||||
|
|
||||||
| .. _java-deprecations-5.0: | ||||||
|
|
||||||
| Deprecations in 5.0 | ||||||
| ~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| - The ``org.mongodb.scala.Observable.completeWithUnit()`` method is deprecated. | ||||||
| This method is not useful anymore because | ||||||
| the driver now exposes ``org.mongodb.scala.Observable[Unit]`` | ||||||
| instead of ``org.mongodb.scala.Observable[Void]``. | ||||||
| This relates to a :ref:`breaking change about Observables in this release | ||||||
| <java-breaking-changes-v5.0-observables>`. | ||||||
|
|
||||||
| .. _java-behavioral-changes-5.0: | ||||||
|
|
||||||
| Behavioral changes in 5.0 | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| - The ``getElapsedTime()`` method on ``com.mongodb.event.ConnectionReadyEvent`` | ||||||
| includes the time taken to deliver the ``ConnectionCreatedEvent``. That is, | ||||||
| the time returned includes the duration of the | ||||||
| ``com.mongodb.event.ConnectionPoolListener.connectionCreated()`` method. | ||||||
|
|
||||||
| The ``getElapsedTime()`` methods on | ||||||
| ``com.mongodb.event.ConnectionCheckedOutFailedEvent`` and | ||||||
| ``com.mongodb.event.ConnectionCheckedOutEvent`` include the time taken to | ||||||
| deliver the ``com.mongodb.event.ConnectionCheckOutStartedEvent``. That is, the | ||||||
| time returned includes the duration of the | ||||||
| ``com.mongodb.eventConnectionPoolListener.connectionCheckOutStarted()`` method. | ||||||
|
|
||||||
| .. _java-new-features-5.0: | ||||||
|
|
||||||
| New features in 5.0 | ||||||
| ~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| The 5.0 driver release introduces the following features: | ||||||
|
|
||||||
| - Adds support for the ``authorizedCollection`` option of | ||||||
| the ``listCollections`` command. This was done by changing the | ||||||
| ``com.mongodb.client.MongoDatabase.listCollectionNames()`` methods. | ||||||
| The return type is now ``com.mongodb.client.ListCollectionNamesIterable``, | ||||||
| while previously it was a ``MongoIterable<String>``. | ||||||
| This change allows the return value to be | ||||||
| configured using the ``ListCollectionNamesIterable.authorizedCollections()`` | ||||||
| method and specifying the ``authorizedCollections`` option. Equivalent changes | ||||||
| were made to following classes and interfaces: | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This duplication probably happened as a result of (presumably) rebasing and manually resolving non-trivial conflicts in #513 after the review had been completed.