(DOCSP-29260): Migrate from KMongo #92

cbullinger · 2023-06-16T14:38:47Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-29260
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/docsp-29260-migrate/migrate-kmongo/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?

rozza · 2023-06-19T11:36:06Z

source/migrate-kmongo.txt

+  .. tab::
+      :tabid: {+driver-long+}
+
+      You can serialize data classes in the Kotlin driver using the ``kotlinx.serialization`` 


Note: You can use either automatic data class codecs or kotlinx serialization.

rozza · 2023-06-19T11:37:00Z

source/migrate-kmongo.txt

+.. _kotlin-migrate-kmongo:
+
+===================
+Migrate from KMongo


Is Migrate the right word?

This is more a comparison between the two

rustagir

approving with some small suggestions that I think would help the refine the page

rustagir · 2023-07-28T14:17:44Z

source/includes/kmongo-description.rst

+It is also a wrapper around the Java driver.
+It was created prior to the creation of the official Kotlin driver to serve


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

rustagir · 2023-07-28T14:18:55Z

source/faq.txt

 by wrapping the :driver:`MongoDB Java driver </java-drivers/>`.



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

Weird. Corrected

rustagir · 2023-07-28T14:20:04Z

source/includes/kmongo-description.rst

+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. As of July 2023, it has been marked as deprecated.


S: move the deprecation notice into an important admontition

rustagir · 2023-07-28T14:21:08Z

source/migrate-kmongo.txt

+        // Insert a document
+          val jedi =a Jedi("Luke Skywalker", 19)
+          collection.insertOne(jedi)
+
+          // Find a document
+          val luke = collection.find(Jedi::name.name, "Luke Skywalker")
+          val jedis = collection.find(lt(Jedi::age.name, 30)).toList()
+
+          // Update a document
+          val filter = Filters.eq(Jedi::name.name, "Luke Skywalker")
+          val update = Updates.set(Jedi::age.name, 20)
+          collection.updateOne(filter, update)
+
+          // Delete a document
+          val filter = Filters.eq(Jedi::name.name, "Luke Skywalker")
+          collection.deleteOne(filter)


S: remove unneeded indentation

rustagir · 2023-07-28T14:21:34Z

source/migrate-kmongo.txt

+      Aggregation pipelines can be built using the ``aggregate`` method and the 
+      ``pipeline`` function: 


Suggested change

Aggregation pipelines can be built using the ``aggregate`` method and the

``pipeline`` function:

You can build aggregation pipelines by using the ``aggregate`` method and the

``pipeline`` function:

S: In general, change from passive to active second person where possible

rustagir · 2023-07-28T14:24:43Z

source/migrate-kmongo.txt

+      .. code-block:: kotlin
+
+        data class Jedi(val name: String)
+
+        val yoda = col.findOne(Jedi::name eq "Yoda")
+
+        // Compile error (2 is not a String)
+        val error = col.findOne(Jedi::name eq 2)
+
+        // Use property reference with instances
+        val yoda2 = col.findOne(yoda::name regex "Yo.*")


S: fix indentation

rustagir · 2023-07-28T14:24:56Z

source/migrate-kmongo.txt

+      .. code-block:: kotlin
+
+        import org.litote.kmongo.MongoOperator.lt
+        import org.litote.kmongo.MongoOperator.match
+        import org.litote.kmongo.MongoOperator.regex
+        import org.litote.kmongo.MongoOperator.sample
+
+        val yoda = col.findOne("{name: {$regex: 'Yo.*'}}")!! 
+        val luke = col.aggregate<Jedi>("""[ {$match:{age:{$lt : ${yoda.age}}}},
+                                            {$sample:{size:1}}
+                                        ]""").first()


S fix indentation

check all code blocks

rustagir · 2023-07-28T14:25:24Z

source/migrate-kmongo.txt

+          // Async operations
+          val jedi =a Jedi("Luke Skywalker", 19)
+          collection.insertOne(jedi)
+        }


S fix indentation

rustagir · 2023-07-28T14:25:29Z

source/migrate-kmongo.txt

+          // Async operations
+          col.insertOne(Jedi("Luke Skywalker", 19))
+          val yoda : Jedi? = col.findOne(Jedi::name eq "Yoda")
+        }


S fix indentation

docs-builder-bot · 2023-07-28T14:49:26Z

✨ Staging URL: https://docs-mongodborg-staging.corp.mongodb.com/kotlin/docsworker-xlarge/master/

🪵 Logs

job log: a2c6ed7cbf0289ab1a8b2ca9c8267add85a5d5b9

# Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-29260 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/docsp-29260-migrate/migrate-kmongo/ ## Self-Review Checklist - [ ] Is this free of any warnings or errors in the RST? - [ ] Did you run a spell-check? - [ ] Did you run a grammar-check? - [ ] Are all the links working? (cherry picked from commit a2c6ed7)

# Pull Request Info Miss from merged #92 JIRA - https://jira.mongodb.org/browse/DOCSP-29260 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/no-jira-fix-kmongo-includes/migrate-kmongo/ --------- Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit f3dfc0e)

# Pull Request Info Miss from merged #92 JIRA - https://jira.mongodb.org/browse/DOCSP-29260 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/no-jira-fix-kmongo-includes/migrate-kmongo/ --------- Co-authored-by: Rea Rustagi <[email protected]>

cbullinger added the Try to Have Try to have for .local NYC label Jun 19, 2023

cbullinger requested a review from rozza June 19, 2023 11:19

rozza reviewed Jun 19, 2023

View reviewed changes

cbullinger and others added 6 commits July 28, 2023 07:27

initial draft

e9b5963

Rename file

3d88e28

fix tables

3eb1a5c

Reformat as tabs

9958503

tweak intro wording

746de4a

Address feedback and note KMongo as deprecated

42d4329

cbullinger force-pushed the docsp-29260-migrate branch from a1f24dd to 42d4329 Compare July 28, 2023 11:38

cbullinger marked this pull request as ready for review July 28, 2023 11:39

cbullinger requested review from rustagir and ashni-mehta July 28, 2023 11:40

Fix autobuilder error

5790232

rustagir approved these changes Jul 28, 2023

View reviewed changes

ashni-mehta approved these changes Jul 28, 2023

View reviewed changes

cbullinger merged commit a2c6ed7 into mongodb:master Jul 28, 2023

cbullinger mentioned this pull request Jul 28, 2023

DOCSP-29260: Make KMongo deprecation an important admonition #119

Merged

		It is also a wrapper around the Java driver.
		It was created prior to the creation of the official Kotlin driver to serve

		by wrapping the :driver:`MongoDB Java driver </java-drivers/>`.

		Aggregation pipelines can be built using the ``aggregate`` method and the
		``pipeline`` function:

(DOCSP-29260): Migrate from KMongo #92

(DOCSP-29260): Migrate from KMongo #92

Uh oh!

Conversation

cbullinger commented Jun 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

docs-builder-bot commented Jul 28, 2023

🪵 Logs

Uh oh!

Uh oh!

cbullinger commented Jun 16, 2023 •

edited

Loading