Skip to content

Commit 83319fe

Browse files
committed
Clarify in reference documentation that the callback-based async driver is deprecated
JAVA-3217
1 parent 85aa9b5 commit 83319fe

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

docs/landing/layouts/partials/features.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ <h2>Features</h2>
88
<dt>MongoDB Driver</dt>
99
<dd>An updated Java driver that includes the legacy API as well as a new generic MongoCollection interface that complies with a new cross-driver CRUD specification.</dd>
1010
<dt>MongoDB Async Driver</dt>
11-
<dd>A new asynchronous API that can leverage either Netty or Java 7's AsynchronousSocketChannel for fast and non-blocking IO.</dd>
12-
<dt>Core driver</dt>
13-
<dd>The MongoDB Driver and Async Driver are both built on top of a new core library, which anyone can use to build alternative or experimental high-level APIs.</dd>
11+
<dd>A callback-based asynchronous driver. Note that this driver is now deprecated in favor of the
12+
<a href="http://mongodb.github.io/mongo-java-driver-reactivestreams/">Reactive Streams Java Driver</a>
13+
</dd>
1414
</dl>

docs/landing/layouts/partials/introduction.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ <h2>Introduction</h2>
22

33
<p>
44
The official MongoDB Java Driver providing both synchronous and asynchronous interaction with MongoDB.
5-
Powering the drivers is a new driver core and BSON library.
65
</p>

docs/reference/content/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ For the synchronous MongoDB Driver, see [MongoDB Driver section]({{< relref "dri
2323

2424
### MongoDB Async Driver
2525

26-
For the new asynchronous MongoDB Async Driver, the [MongoDB Async Driver section]({{< relref "driver-async/index.md" >}}).
26+
For the callback-based asynchronous MongoDB Async Driver, see [MongoDB Async Driver section]({{< relref "driver-async/index.md" >}}). Note
27+
that this driver has been deprecated in favor of the
28+
[Reactive Streams Java Driver](http://mongodb.github.io/mongo-java-driver-reactivestreams/).
2729

2830
### BSON Library
2931

docs/reference/content/upgrading.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,17 @@ title = "Upgrade Considerations"
99

1010
## Upgrading from 3.9.x
1111

12+
Please note that two large portions of the current driver have been deprecated as of the 3.9.0 release:
13+
14+
* The callback-based asynchronous driver has been deprecated in favor of the
15+
[Reactive Streams Java Driver](http://mongodb.github.io/mongo-java-driver-reactivestreams/).
16+
* Much of the "core" driver on which the both the asynchronous and synchronous drivers are built has been deprecated. In 3.0 we made most
17+
of this "core" driver a public API, but the benefit to users has turned out to be small and the maintenance costs of maintaining backwards
18+
compatibility has turned out to be high. For that reason we've decided to remove it from the public API (though it will still continue
19+
to exist as an implementation artifact).
20+
1221
In the upcoming 4.0 release, all deprecated API elements except those documented as "not currently scheduled for removal" will be removed.
13-
Currently the only API elements _not_ scheduled for removal are:
22+
Currently the only deprecated API elements _not_ scheduled for removal are:
1423

1524
* [`Mongo.getDB`]({{<apiref "com/mongodb/Mongo.html#getDB-java.lang.String-">}})
1625
* [`JsonMode.STRICT`]({{<apiref "org/bson/json/JsonMode.html#STRICT">}})

0 commit comments

Comments
 (0)