Skip to content

[v5.5] Docsp-49013 (#226) #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions source/fundamentals/builders/builders-data-classes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ To implement this functionality, you must add the
``mongodb-driver-kotlin-extensions`` dependency to your dependencies
list.

.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst

.. replacement:: installation-guide

:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.

Select from the following tabs to see how to add the extension
dependency to your project by using the :guilabel:`Gradle` and
:guilabel:`Maven` package managers:
Expand All @@ -64,7 +70,7 @@ dependency to your project by using the :guilabel:`Gradle` and
.. code-block:: kotlin
:caption: build.gradle.kts

implementation("org.mongodb:mongodb-driver-kotlin-extensions:{+full-version+}")
implementation("org.mongodb:mongodb-driver-kotlin-extensions")

.. tab::
:tabid: Maven
Expand All @@ -78,7 +84,6 @@ dependency to your project by using the :guilabel:`Gradle` and
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>mongodb-driver-kotlin-extensions</artifactId>
<version>{+full-version+}</version>
</dependency>

After you install the extensions dependency, you can use the extension
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ MongoDB Kotlin driver as a dependency to your project, see the
:ref:`driver installation <add-mongodb-dependency>` section of our Quick Start
guide.

.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst

.. replacement:: installation-guide

:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.

We recommend that you use the `Maven <https://maven.apache.org/>`__ or
`Gradle <https://gradle.org/>`__ build automation tool to manage your project's
dependencies. Select from the following tabs to see the dependency declaration
Expand Down
12 changes: 8 additions & 4 deletions source/fundamentals/data-formats/serialization.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ Add {+language+} Serialization to Your Project
Support for serialization in the {+driver-short+} depends on the official `Kotlin
serialization library <https://github.com/Kotlin/kotlinx.serialization>`__.

.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst

.. replacement:: installation-guide

:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.

Select from the following tabs to see how to add the serialization
dependencies to your project by using the :guilabel:`Gradle` and
:guilabel:`Maven` package managers:
Expand All @@ -76,7 +82,7 @@ dependencies to your project by using the :guilabel:`Gradle` and
:caption: build.gradle.kts

implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:{+serializationVersion+}")
implementation("org.mongodb:bson-kotlinx:{+full-version+}")
implementation("org.mongodb:bson-kotlinx")

.. tab::
:tabid: Maven
Expand All @@ -95,7 +101,6 @@ dependencies to your project by using the :guilabel:`Gradle` and
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>bson-kotlinx</artifactId>
<version>{+full-version+}</version>
</dependency>

.. _kotlin-data-class-annotation:
Expand Down Expand Up @@ -192,7 +197,7 @@ add the dependency to your project by using the :guilabel:`Gradle` and
.. code-block:: kotlin
:caption: build.gradle.kts

implementation("org.mongodb:bson-kotlinx:{+full-version+}")
implementation("org.mongodb:bson-kotlinx")

.. tab::
:tabid: Maven
Expand All @@ -206,7 +211,6 @@ add the dependency to your project by using the :guilabel:`Gradle` and
<dependency>
<groupId>org.jetbrains.kotlinx</groupId>
<artifactId>bson-kotlinx</artifactId>
<version>{+full-version+}</version>
</dependency>

.. note:: bson-kotlin Dependency
Expand Down
51 changes: 29 additions & 22 deletions source/fundamentals/encrypt-fields.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,32 @@

.. replacement:: driver-specific-content

.. important:: Compatible Encryption Library Version

The {+driver-short+} uses the `mongodb-crypt
<https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
encryption library for in-use encryption. This driver version
is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.

Select from the following :guilabel:`Maven` and
:guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
dependency to your project by using the specified manager:

.. tabs::

.. tab:: Maven
:tabid: maven-dependency

.. include:: /includes/fundamentals/code-snippets/crypt-maven-versioned.rst

.. tab:: Gradle
:tabid: gradle-dependency

.. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
Compatible Encryption Library Version
-------------------------------------

The {+driver-short+} uses the `mongodb-crypt
<https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
encryption library for in-use encryption. This driver version
is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.

.. sharedinclude:: dbx/jvm/BOM-installation-tip.rst

.. replacement:: installation-guide

:ref:`Add the Driver Bill of Materials <kotlin-get-started-install-bom>` step of the Quick Start guide.

Select from the following :guilabel:`Maven` and
:guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
dependency to your project by using the specified manager:

.. tabs::

.. tab:: Maven
:tabid: maven-dependency

.. include:: /includes/fundamentals/code-snippets/crypt-maven-versioned.rst

.. tab:: Gradle
:tabid: gradle-dependency

.. include:: /includes/fundamentals/code-snippets/crypt-gradle-versioned.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. code-block:: kotlin
dependencies {
implementation("org.mongodb:bson:{+full-version+}")
implementation("org.mongodb:bson")
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>bson</artifactId>
<version>{+full-version+}</version>
</dependency>
</dependencies>

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. code-block:: groovy

dependencies {
implementation("org.mongodb:mongodb-crypt:{+mongocrypt-version+}")
implementation("org.mongodb:mongodb-crypt")
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>mongodb-crypt</artifactId>
<version>{+mongocrypt-version+}</version>
</dependency>
</dependencies>
4 changes: 2 additions & 2 deletions source/includes/serialization-libs-gradle-versioned.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:caption: build.gradle.kts
:copyable: true

implementation("org.mongodb:bson-kotlinx:{+full-version+}")
implementation("org.mongodb:bson-kotlinx")
// OR
implementation("org.mongodb:bson-kotlin:{+full-version+}")
implementation("org.mongodb:bson-kotlin")

2 changes: 0 additions & 2 deletions source/includes/serialization-libs-maven-versioned.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>bson-kotlinx</artifactId>
<version>{+full-version+}</version>
</dependency>
<!--OR-->
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>bson-kotlin</artifactId>
<version>{+full-version+}</version>
</dependency>

Loading