Skip to content

Commit d8c4702

Browse files
committed
Updated reference documentation in preparation for the 3.1 release.
1 parent 56cd727 commit d8c4702

File tree

10 files changed

+36
-88
lines changed

10 files changed

+36
-88
lines changed

docs/reference/content/bson/installation-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ This library comprehensively supports [BSON](http://www.bsonspec.org),
2222
the data storage and network transfer format that MongoDB uses for "documents".
2323
BSON is short for Binary [JSON](http://json.org/), is a binary-encoded serialization of JSON-like documents.
2424

25-
{{< install artifactId="bson" version="3.1.0-SNAPSHOT" >}}
25+
{{< install artifactId="bson" version="3.1.0-rc0" >}}

docs/reference/content/driver-async/getting-started/quick-tour-admin.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,8 @@ For more information about text search see the [text index]({{< docsref "/core/i
223223
## Running a command
224224

225225
While not all commands have a specific helper, however you can run any [command]({{< docsref "/reference/command">}})
226-
by using the [`runCommand()`](http://api.mongodb.org/java/3.0/?com/mongodb/async/client/MongoDatabase.html#runCommand-org.bson.conversions.Bson-com.mongodb.ReadPreference-com.mongodb.async.SingleResultCallback-) method. Here we call the [buildInfo]({{ docsref "reference/command/buildInfo" }}) command:
226+
by using the [`runCommand()`](http://api.mongodb.org/java/3.1/?com/mongodb/async/client/MongoDatabase.html#runCommand-org.bson.conversions.Bson-com.mongodb.ReadPreference-com.mongodb.async.SingleResultCallback-)
227+
method. Here we call the [buildInfo]({{ docsref "reference/command/buildInfo" }}) command:
227228

228229
```java
229230
database.runCommand(new Document("buildInfo", 1), new SingleResultCallback<Document>() {

docs/reference/content/driver-async/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title = "Reference"
1111
## Reference
1212

1313
The reference documentation for the Java driver focuses on high-level documentation and use-cases. The Javadoc-generated API reference is
14-
[here](http://api.mongodb.org/java/3.0/).
14+
[here](http://api.mongodb.org/java/3.1/).
1515

1616
- [Connecting]({{< relref "driver-async/reference/connecting/index.md" >}}): Documentation of the driver's support for connecting to MongoDB servers
1717
- [CRUD]({{< relref "driver-async/reference/crud/index.md" >}}): Documentation of the driver's support for CRUD operations

docs/reference/content/driver-async/reference/management/monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The driver uses [JMX](http://docs.oracle.com/javase/8/docs/technotes/guides/jmx/
1515
application or end user to monitor various aspects of the driver.
1616

1717
The driver creates MXBean instances of a single type:
18-
[ConnectionPoolStatisticsMBean](http://api.mongodb.org/java/3.0/com/mongodb/management/ConnectionPoolStatisticsMBean.html).
18+
[ConnectionPoolStatisticsMBean]({{< apiref "com/mongodb/management/ConnectionPoolStatisticsMBean" >}}).
1919
The driver registers one `ConnectionPoolStatisticsMBean` instance per each server it connects to. For example, in the case of a replica
2020
set, the driver creates an instance per each non-hidden member of the replica set.
2121

docs/reference/content/driver/getting-started/quick-tour-admin.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ For more information about text search see the [text index]({{< docsref "/core/i
166166
## Running a command
167167

168168
While not all commands have a specific helper, however you can run any [command]({{< docsref "/reference/command">}})
169-
by using the [`runCommand()`](http://api.mongodb.org/java/3.0/?com/mongodb/client/MongoDatabase.html#runCommand-org.bson.conversions.Bson-com.mongodb.ReadPreference-) method. Here we call the [buildInfo]({{ docsref "reference/command/buildInfo" }}) command:
169+
by using the [`runCommand()`](http://api.mongodb.org/java/3.1/?com/mongodb/client/MongoDatabase.html#runCommand-org.bson.conversions.Bson-com.mongodb.ReadPreference-)
170+
method. Here we call the [buildInfo]({{ docsref "reference/command/buildInfo" }}) command:
170171

171172
```java
172173
Document buildInfo = database.runCommand(new Document("buildInfo", 1));

docs/reference/content/driver/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title = "Reference"
1111
## Reference
1212

1313
The reference documentation for the Java driver focuses on high-level documentation and use-cases. The Javadoc-generated API reference is
14-
[here](http://api.mongodb.org/java/3.0/).
14+
[here](http://api.mongodb.org/java/3.1/).
1515

1616
- [Connecting]({{< relref "driver/reference/connecting/index.md" >}}): Documentation of the driver's support for connecting to MongoDB servers
1717
- [CRUD]({{< relref "driver/reference/crud/index.md" >}}): Documentation of the driver's support for CRUD operations

docs/reference/content/driver/reference/management/monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The driver uses [JMX](http://docs.oracle.com/javase/8/docs/technotes/guides/jmx/
1515
application or end user to monitor various aspects of the driver.
1616

1717
The driver creates MXBean instances of a single type:
18-
[ConnectionPoolStatisticsMBean](http://api.mongodb.org/java/3.0/com/mongodb/management/ConnectionPoolStatisticsMBean.html).
18+
[ConnectionPoolStatisticsMBean]({{< apiref "com/mongodb/management/ConnectionPoolStatisticsMBean" >}}).
1919
The driver registers one `ConnectionPoolStatisticsMBean` instance per each server it connects to. For example, in the case of a replica
2020
set, the driver creates an instance per each non-hidden member of the replica set.
2121

docs/reference/content/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,16 @@ type = "index"
66

77
## MongoDB Java Driver Documentation
88

9-
Welcome to the MongoDB Java driver documentation hub for the 3.0 driver release.
9+
Welcome to the MongoDB Java driver documentation hub for the 3.1 driver release.
1010

1111

12-
### What's New in 3.0
12+
### What's New in 3.1
1313

1414
The [What's New]({{< relref "whats-new/index.md" >}}) guide explains the major new features of the driver.
1515

16-
If you are upgrading from the 2.x series of the driver, consult the [Upgrading]({{< relref "whats-new/upgrading.md" >}}) documentation for
17-
information on breaking changes.
16+
If you are upgrading from the 3.0.x series of the driver, consult the [Upgrading]({{< relref "whats-new/upgrading.md" >}}) documentation
17+
for information on breaking changes. If you are upgrading from the 2.x series of the driver, please consult the 3.0 reference
18+
documentation as well.
1819

1920

2021
### MongoDB Driver

docs/reference/content/whats-new/index.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,20 @@ title = "What's New"
77
pre = "<i class='fa fa-cog'></i>"
88
+++
99

10-
# What's New in 3.0
10+
# What's New in 3.1
1111

12-
Key features of the 3.0 driver include:
12+
Key new features of the 3.1 driver include:
1313

14-
- A generic [`MongoCollection`]({{< apiref "com/mongodb/client/MongoCollection" >}}) interface that complies with a new cross-driver
15-
[CRUD specification](https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst).
16-
- A new [asynchronous API](https://github.com/mongodb/mongo-java-driver/tree/master/driver-async) that can leverage either
17-
[Netty](http://netty.io/) or Java 7's
18-
[AsynchronousSocketChannel](http://docs.oracle .com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html)
19-
- A new [Codec]({{< ref "bson/codecs.md" >}}) infrastructure that you can use to build high-performance
20-
encoders and decoders without requiring an intermediate Map instance.
21-
- A new core driver on top of which you can build alternative or experimental driver APIs
14+
- Builder support for [updates]({{< ref "builders/updates.md" >}})
15+
- Builder support for [aggregation stages and accumulators]({{< ref "builders/aggregation.md" >}})
16+
- Builder support for [geospatial query filters]({{< ref "builders/filters.md#geospatial" >}})
17+
- Builder support for [index keys]({{< ref "builders/indexes.md" >}})
18+
- A new [GridFS API]({{< ref "driver/reference/gridfs/index.md" >}}) that is compatible with the CRUD API introduced in the 3.0
19+
driver release
20+
(not yet available in the async driver)
21+
- An [event-based API]({{< ref "driver/reference/management/monitoring.md#command-monitoring" >}}) for monitoring all commands that the
22+
driver sends to a MongoDB server and all responses received (not yet available in the async driver)
2223

2324
## Upgrading
2425

25-
See the [upgrading guide]({{<ref "whats-new/upgrading.md">}}) on how to upgrade to 3.0
26+
See the [upgrading guide]({{<ref "whats-new/upgrading.md">}}) on how to upgrade to 3.1
Lines changed: 10 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
+++
22
date = "2015-03-19T12:53:39-04:00"
3-
title = "Upgrading to 3.0"
3+
title = "Upgrading to 3.1"
44
[menu.main]
55
parent = "Whats New"
6-
identifier = "Upgrading to 3.0"
6+
identifier = "Upgrading to 3.1"
77
weight = 40
88
pre = "<i class='fa fa-wrench'></i>"
99
+++
1010

11-
# Upgrading to 3.0
11+
# Upgrading from 3.0.x
1212

13-
The 3.0 release is **incompatible** with the 2.x release series. However, where possible, the 2.13.0 driver has deprecated classes or
14-
methods that have been removed in 3.0.
13+
The 3.1 release is binary and source compatible with the 3.0 release, with the following exceptions:
14+
15+
- Other than BsonDocument, subclasses of BsonValue no longer implement Serializable
16+
- BsonDocumentWrapper and RawBsonDocument are now final
1517

16-
Before upgrading to 3.0, compile against 2.13.0 with deprecation warnings enabled and remove use of any deprecated methods or classes.
18+
# Upgrading from 2.x
19+
20+
Please see the Upgrading guide in the 3.0 driver reference documentation.
1721

1822
## System Requirements
1923

@@ -24,63 +28,3 @@ The minimum JVM is now Java 6: however, specific features require Java 7:
2428
- The asynchronous API requires Java 7, as by default it relies on
2529
[`AsynchronousSocketChannel`](http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html) for
2630
its implementation. See [Async]({{< ref "driver-async/index.md" >}}) for details on configuring the driver to use [Netty](http://netty.io/) instead.
27-
28-
## Incompatibilities
29-
30-
The following lists the most significant backwards-breaking changes, along with the recommended solutions.
31-
32-
### General
33-
34-
The driver now enables host name verification by default for SSL connections. If you are knowingly using an invalid certificate, or are
35-
using Java 6 (see above), set the
36-
[`sslInvalidHostNameAllowed`](http://api.mongodb.org/java/3.0/com/mongodb/MongoClientOptions.html#isSslInvalidHostNameAllowed--)
37-
property to true.
38-
39-
### MongoClientOptions
40-
41-
Providing little practical value,
42-
the [`autoConnectRetry`](https://api.mongodb.org/java/2.13/com/mongodb/MongoClientOptions .html#isAutoConnectRetry--) and
43-
[`maxAutoConnectRetryTime`](https://api.mongodb.org/java/2.13/com/mongodb/MongoClientOptions.html#getMaxAutoConnectRetryTime--)
44-
properties in
45-
[`MongoClientOptions`]({{< apiref "com/mongodb/MongoClientOptions" >}}) have been removed from the Java driver to be consistent with other
46-
MongoDB-supported drivers .
47-
48-
#### MongoClient
49-
50-
The [`MongoClient`]({{< apiref "com/mongodb/MongoClient" >}}) (and
51-
[`ServerAddress`]({{< apiref "com/mongodb/ServerAddress" >}})) constructors no longer throw
52-
[`UnknownHostException`](http://docs.oracle.com/javase/8/docs/api/java/net/UnknownHostException.html): This breaks source but not binary
53-
compatibility, so re-compilation with 3.0 will only succeed after removing any reference to this exception in catch blocks or method
54-
throws declarations.
55-
56-
### DB
57-
58-
The [`requestStart`](https://api.mongodb.org/java/2.13/com/mongodb/DB.html#requestStart--) and
59-
[`requestDone`](https://api.mongodb.org/java/2.13/com/mongodb/DB.html#requestDone--) methods in
60-
[`DB`]({{< apiref "com/mongodb/DB" >}}) have been removed: These methods have been removed in accordance with the
61-
[server selection specification](https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#what-happened-to-pinning).
62-
63-
The [`authenticate`](https://api.mongodb.org/java/2.13/com/mongodb/DB.html#authenticate-java.lang.String-char:A-) method in
64-
[`DB`]({{< apiref "com/mongodb/DB" >}}) has been replaced with
65-
[`MongoClient`](http://api.mongodb.org/java/3.0/com/mongodb/MongoClient.html#MongoClient-java.util.List-java.util.List-) constructors that
66-
take [`MongoCredential`]({{< apiref "com/mongodb/MongoCredential" >}}) instances.
67-
68-
### DBCollection
69-
70-
The [`ensureIndex`](https://api.mongodb.org/java/2.13/com/mongodb/DBCollection.html#ensureIndex-com.mongodb.DBObject-) methods in
71-
[`DBCollection`]({{< apiref "com/mongodb/DBCollection" >}}) have been removed:
72-
replace with the corresponding
73-
[`createIndex`](https://api.mongodb.org/java/2.13/com/mongodb/DBCollection.html#createIndex-com.mongodb.DBObject-) method.
74-
75-
### WriteResult
76-
77-
The [`getLastError`](http://api.mongodb.org/java/2.13/com/mongodb/WriteResult.html#getLastError--) method in
78-
[`WriteResult`]({{< apiref "com/mongodb/WriteResult" >}}) has been removed: this method does not work reliably in
79-
the 2.x series and there is no way to make work reliably, so it has been removed. Replace with use of an acknowledged
80-
[`WriteConcern`]({{< apiref "com/mongodb/WriteConcern" >}}) when executing the write operation.
81-
82-
### DBRef
83-
84-
The [`fetch`](https://api.mongodb.org/java/2.13/com/mongodb/DBRefBase.html#fetch--) method in
85-
[`DBRef`]({{< apiref "com/mongodb/DBRef" >}}) has been removed: use the
86-
[`findOne`](https://api.mongodb.org/java/3.0/com/mongodb/DBCollection.html#findOne-java.lang.Object-) method instead.

0 commit comments

Comments
 (0)