Skip to content

Commit 9832778

Browse files
committed
Update reference documentation for uuidRepresentation setting
JAVA-3516
1 parent d688944 commit 9832778

File tree

3 files changed

+49
-6
lines changed

3 files changed

+49
-6
lines changed

docs/reference/content/driver/tutorials/databases-collections.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -200,4 +200,12 @@ MongoDatabase database = client.getDatabase("mydb")
200200
// or per collection
201201
MongoCollection<Document> collection = database.getCollection("mycoll")
202202
.withCodecRegistry(codecRegistry);
203-
```
203+
```
204+
205+
{{% note %}}
206+
Starting with the 3.12 release of the driver, you can also change the encoding of `UUID` instances via the `uuidRepresentation` property of
207+
`MongoClientSettings`. See
208+
[`MongoClientSettings.getUuidRepresentation`]({{<apiref "com/mongodb/MongoClientSettings.html#getUuidRepresentation()">}}) for
209+
details.
210+
{{% /note %}}
211+

docs/reference/content/upgrading.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,24 @@ title = "Upgrade Considerations"
77
pre = "<i class='fa fa-level-up'></i>"
88
+++
99

10+
## Upgrading from 3.11.x
11+
12+
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 deprecated API elements _not_ scheduled for removal are:
14+
15+
* [`Mongo.getDB`]({{<apiref "com/mongodb/Mongo.html#getDB-java.lang.String-">}})
16+
* [`JsonMode.STRICT`]({{<apiref "org/bson/json/JsonMode.html#STRICT">}})
17+
18+
To prepare for the 4.0 release, please compile with deprecation warnings enabled and replace all usage of deprecated API elements with their
19+
recommended replacements.
20+
21+
Also, note that the 3.12 release (which includes support for MongoDB 4.2) will be the last release that is compatible with *Java 6
22+
or Java 7*. The 4.0 Java driver will require a minimum of Java 8. The 3.11 release will also be the last non-patch release in the 3.x
23+
line. In particular, support for MongoDB 4.4 will only be made available via a 4.x driver release.
24+
25+
The 3.12 release is binary and source compatible with the 3.11 release, except for methods that have been added to interfaces that
26+
have been marked as unstable, and changes to classes or interfaces that have been marked as internal or annotated as Beta.
27+
1028
## Upgrading from 3.10.x
1129

1230
Please note that the 3.11 driver enables both retryable reads and retryable writes by default, so users upgrading to the 3.11 driver may
@@ -21,11 +39,7 @@ Currently the only deprecated API elements _not_ scheduled for removal are:
2139
To prepare for the 4.0 release, please compile with deprecation warnings enabled and replace all usage of deprecated API elements with their
2240
recommended replacements.
2341

24-
Also, note that the 3.11 release (which includes support for MongoDB 4.2) will be the last release that is compatible with *Java 6
25-
or Java 7*. The 4.0 Java driver will require a minimum of Java 8. The 3.11 release will also be the last non-patch release in the 3.x
26-
line. In particular, support for MongoDB 4.4 will only be made available via a 4.x driver release.
27-
28-
The 3.11 release is binary and source compatible with the 3.9 release, except for methods that have been added to interfaces that
42+
The 3.11 release is binary and source compatible with the 3.10 release, except for methods that have been added to interfaces that
2943
have been marked as unstable, and changes to classes or interfaces that have been marked as internal or annotated as Beta.
3044

3145
## Upgrading from 3.9.x

docs/reference/content/whats-new.md

+21
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,27 @@ title = "What's New"
77
pre = "<i class='fa fa-level-up'></i>"
88
+++
99

10+
## What's new in 3.12
11+
12+
This release fully supports all MongoDB releases from versions 2.6 to 4.2. Key new features of the 3.11 Java driver release include:
13+
14+
### Security improvements
15+
16+
Client-side field level encryption is supported. Automatic encryption and decryption is available for users of
17+
[MongoDB Enterprise Advanced](https://www.mongodb.com/products/mongodb-enterprise-advanced), while explicit encryption and decryption is
18+
available for users of MongoDB Community.
19+
20+
See [Client-side Encryption]({{<ref "driver/tutorials/client-side-encryption.md">}}) for further details.
21+
22+
### Improved interoperability when using the native UUID type
23+
24+
The driver now supports setting the BSON binary representation of `java.util.UUID` instances via a new `UuidRepresentation` property on
25+
`MongoClientSettings`. The default representation has not changed, but it will in the upcoming 4.0 major release of the driver.
26+
Applications that store UUID values in MongoDB can use this setting to easily control the representation in MongoDB without having to
27+
register a `Codec<Uuid>` in the `CodecRegistry`.
28+
29+
See [`MongoClientSettings.getUuidRepresentation`]({{<apiref "com/mongodb/MongoClientSettings.html#getUuidRepresentation()">}}) for details.
30+
1031
## What's new in 3.11
1132

1233
This release fully supports all MongoDB releases from versions 2.6 to 4.2. Key new features of the 3.11 Java driver release include:

0 commit comments

Comments
 (0)