Skip to content

Commit e95aca0

Browse files
committed
JAVA-2751: Reference documentation for installation of new mongodb-driver-sync module
1 parent c6f1c5d commit e95aca0

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

docs/reference/content/driver/getting-started/installation.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,52 @@ title = "Installation"
1313
The recommended way to get started using one of the drivers in your
1414
project is with a dependency management system.
1515

16-
There are two Maven artifacts available in the release. The preferred artifact for new applications is `mongodb-driver`
17-
however, we still publish the legacy `mongo-java-driver` uber-jar.
16+
There are two Maven artifacts available in the release. The preferred artifact for new applications is `mongodb-driver-sync`
17+
however, we still publish the legacy `mongo-java-driver` uber-jar as well as the `mongodb-driver` jar introduced in 3.0.
1818

1919
{{< distroPicker >}}
2020

21+
## MongoDB Driver Sync
22+
23+
The MongoDB Driver `mongodb-driver-sync` is the synchronous Java driver containing only the generic `MongoCollection` interface that
24+
complies with a new cross-driver CRUD specification. It does *not* include the legacy API (e.g. `DBCollection`).
25+
26+
{{% note class="important" %}}
27+
28+
This is a Java 9-compliant module with an Automatic-Module-Name of `org.mongodb.driver.sync.client`.
29+
30+
The `mongodb-driver-sync` artifact is a valid OSGi bundle whose symbolic name is `org.mongodb.driver-sync`.
31+
32+
{{% /note %}}
33+
34+
{{< install artifactId="mongodb-driver-sync" version="3.7.0" dependencies="true">}}
35+
2136
## MongoDB Driver
2237

23-
The MongoDB Driver ``mongodb-driver`` is the updated synchronous Java driver that includes the legacy API as well as a new generic `MongoCollection` interface that complies with a new cross-driver CRUD specification.
38+
The MongoDB Driver `mongodb-driver` is the updated synchronous Java driver that includes the legacy API as well as a new generic `MongoCollection` interface that complies with a new cross-driver CRUD specification.
2439

2540
{{% note class="important" %}}
2641
`mongodb-driver` is *not* an OSGi bundle: both `mongodb-driver` and `mongodb-driver-core`, a dependency of `mongodb-driver`, include classes from the `com.mongodb` package.
2742

28-
For OSGi-based applications, use the [mongo-java-driver](#uber-jar-legacy) uber jar instead.
43+
For OSGi-based applications, use the [mongodb-driver-sync](#mongodb-driver-sync) or the [mongo-java-driver](#uber-jar-legacy) uber jar instead.
44+
45+
It is also *not* a Java 9 module.
2946

3047
{{% /note %}}
3148

32-
{{< install artifactId="mongodb-driver" version="3.6.0" dependencies="true">}}
49+
{{< install artifactId="mongodb-driver" version="3.7.0" dependencies="true">}}
3350

3451

3552
## Uber Jar (Legacy)
3653

37-
For new applications, the preferred artifact is [mongodb-driver](#mongodb-driver); however, the legacy `mongo-java-driver` uber jar is still available. The uber jar contains: the BSON library, the core library, and the `mongodb-driver`.
54+
For new applications, the preferred artifact is [mongodb-driver-sync](#mongodb-driver-sync); however, the legacy `mongo-java-driver` uber
55+
jar is still available. The uber jar contains: the BSON library, the core library, and the `mongodb-driver`.
3856

3957

4058
{{% note %}}
41-
The `mongo-java-driver` artifact is a valid OSGi bundle.
59+
This is a Java 9-compliant module with an Automatic-Module-Name of `org.mongodb.driver.sync.client`.
60+
61+
The `mongo-java-driver` artifact is a valid OSGi bundle whose symbolic name is `org.mongodb.mongo-java-driver`.
4262
{{% /note %}}
4363

44-
{{< install artifactId="mongo-java-driver" version="3.6.0">}}
64+
{{< install artifactId="mongo-java-driver" version="3.7.0">}}

0 commit comments

Comments
 (0)