Skip to content

(DOCSP-29260): Migrate from KMongo #92

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.

Sign up for GitHub

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 7 commits into from
Jul 28, 2023
Merged

(DOCSP-29260): Migrate from KMongo #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e9b5963
initial draft
cbullinger Jun 12, 2023
3d88e28
Rename file
cbullinger Jun 16, 2023
3eb1a5c
fix tables
cbullinger Jun 16, 2023
9958503
Reformat as tabs
cbullinger Jun 16, 2023
746de4a
tweak intro wording
cbullinger Jun 20, 2023
42d4329
Address feedback and note KMongo as deprecated
cbullinger Jul 28, 2023
5790232
Fix autobuilder error
cbullinger Jul 28, 2023
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
10 changes: 4 additions & 6 deletions source/faq.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,7 @@ developed by the MongoDB team and provides a native API for Kotlin
applications to connect to MongoDB and work with data. It is implemented
by wrapping the :driver:`MongoDB Java driver </java-drivers/>`.

Comment on lines 26 to 27
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related to this PR necessarily, but S: move all FAQ entries to top level, right now all but the first are nested under the first even though they are not subsections

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird. Corrected

`KMongo <https://litote.org/kmongo/>`__ is a popular community-developed library
for working with MongoDB from Kotlin applications.
It is also a wrapper around the Java driver.
It was created prior to the creation of the official Kotlin driver to serve
the needs of the Kotlin community.
.. include:: /includes/kmongo-description.rst

The Kotlin driver was developed in collaboration with the creator of KMongo,
Julien Buret, to give users an officially-supported driver.
Expand All @@ -48,11 +44,13 @@ key differences:
- The official driver does *not* have built-in support for `reactor <https://projectreactor.io/>`__,
`rxjava2 <https://github.com/ReactiveX/RxJava>`__, `Jackson <https://github.com/FasterXML/jackson>`__,
or `GSON <https://github.com/google/gson>`__.
- The official driver does not support MongoDB shell commands.
- The official driver does *not* support MongoDB shell commands.
- The official driver supports type-safe queries with the Builders API,
whereas KMongo uses infix functions and property references for
type-safe queries.

For more detailed information, see :ref:`Migrate from KMongo <kotlin-migrate-kmongo>`.

.. _kotlin-faq-connection-pool:

How Does Connection Pooling Work in the Kotlin Driver?
Expand Down
5 changes: 5 additions & 0 deletions source/includes/kmongo-description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
`KMongo <https://litote.org/kmongo/>`__ is a popular community-developed library
for working with MongoDB from Kotlin applications.
It is also a wrapper around the Java driver.
It was created prior to the creation of the official Kotlin driver to serve
Comment on lines +3 to +4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: no changes needed, but suggest combining these sentences to improve flow

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

the needs of the Kotlin community. As of July 2023, it has been marked as deprecated.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: move the deprecation notice into an important admontition

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

1 change: 1 addition & 0 deletions source/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ MongoDB Kotlin Driver
/connection-troubleshooting
/issues-and-help
/compatibility
/migrate-kmongo
View the Source <https://github.com/mongodb/mongo-java-driver>

Introduction
Expand Down
Loading