Skip to content

Commit 42d4329

Browse files
committed
Address feedback and note KMongo as deprecated
1 parent 746de4a commit 42d4329

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

source/includes/kmongo-description.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
for working with MongoDB from Kotlin applications.
33
It is also a wrapper around the Java driver.
44
It was created prior to the creation of the official Kotlin driver to serve
5-
the needs of the Kotlin community.
5+
the needs of the Kotlin community. As of July 2023, it has been marked as deprecated.

source/migrate-kmongo.txt

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ Migrate from KMongo
1414
Overview
1515
--------
1616

17-
In this page, you can identify the changes you need to make to migrate from the KMongo driver to the official MongoDB Kotlin driver.
17+
This page contains a high-level comparison of most of the ways the official
18+
MongoDB Kotlin and the community-developed KMongo driver differ.
19+
You can use this page to identify the changes you need to make to migrate from
20+
the deprecated KMongo driver to the official MongoDB Kotlin driver.
1821

1922
.. include:: /includes/kmongo-description.rst
2023

2124
The MongoDB Kotlin driver is the officially supported and maintained MongoDB driver for
2225
Kotlin. It is developed by the MongoDB team.
2326

24-
This page contains a high-level comparison of most of the ways the drivers differ.
2527
Although both drivers :ref:`support synchronous and asynchronous operations <kotlin-sync-async-support>`,
2628
the examples on this page will use asynchronous coroutine-based operations.
2729

@@ -307,8 +309,9 @@ in Kotlin to and from BSON.
307309
.. tab::
308310
:tabid: {+driver-long+}
309311

310-
You can serialize data classes in the Kotlin driver using the ``kotlinx.serialization``
311-
library. The driver provides an efficient ``Bson`` serializer that handles the
312+
You can serialize data classes in the Kotlin driver using both automatic
313+
data class codecs as well as the ``kotlinx.serialization`` library. The
314+
driver provides an efficient ``Bson`` serializer that handles the
312315
serialization of Kotlin objects to BSON data.
313316

314317
.. code-block:: kotlin
@@ -323,9 +326,8 @@ in Kotlin to and from BSON.
323326
val manufacturer: String = "Acme" // Use instead of @BsonProperty
324327
)
325328

326-
.. TODO DOCSP-29226 - add link to serialization docs
327-
.. To learn more about serializing data classes with ``kotlinx.serialization``,
328-
.. see the :ref:`Kotlin Serialization <fundamentals-kotlin-serialization>` documentation.
329+
To learn more, see the :ref:`Kotlin Serialization <fundamentals-kotlin-serialization>`
330+
documentation.
329331

330332
If you use the ``Document`` class to represent your collection, you can
331333
serialize it to JSON and EJSON using the ``.toJson()`` method:
@@ -342,7 +344,7 @@ in Kotlin to and from BSON.
342344
val json = doc.toJson(settings)
343345

344346
To learn more about serializing data with the ``Document`` class, refer to
345-
:ref:`Document Data Format: Extended JSON <write-ejson>` documentation.
347+
:ref:`Document Data Format - Extended JSON <kotlin-extended-json>` documentation.
346348

347349
.. tab::
348350
:tabid: KMongo

0 commit comments

Comments
 (0)