(DOCSP-29220): CRUD > Upsert page (#38)

* (DOCSP-29220): CRUD > Upsert

* Update examples/src/test/kotlin/UpsertTest.kt

Co-authored-by: Ben Perlmutter <[email protected]>

---------

Co-authored-by: Ben Perlmutter <[email protected]>

Author: cbullinger

examples/src/test/kotlin/UpsertTest.kt

@@ -0,0 +1,91 @@
+
+import com.mongodb.client.model.Filters
+import com.mongodb.client.model.UpdateOptions
+import com.mongodb.client.model.Updates
+import com.mongodb.kotlin.client.coroutine.MongoClient
+import io.github.cdimascio.dotenv.dotenv
+import kotlinx.coroutines.runBlocking
+import org.bson.codecs.pojo.annotations.BsonId
+import org.bson.types.ObjectId
+import org.junit.jupiter.api.AfterAll
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.BeforeAll
+import org.junit.jupiter.api.TestInstance
+import java.util.*
+import kotlin.test.*
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+internal class UpsertTest {
+
+    // :snippet-start: upsert-data-model
+    data class PaintOrder(
+        @BsonId val id: ObjectId = ObjectId(),
+        val qty: Int,
+        val color: String
+    )
+    // :snippet-end:
+
+    companion object {
+        val dotenv = dotenv()
+        val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val database = client.getDatabase("paint_store")
+        val collection = database.getCollection<PaintOrder>("paint_order")
+
+        @BeforeAll
+        @JvmStatic
+        private fun beforeAll() {
+            runBlocking {
+                val paintOrders = listOf(
+                    PaintOrder(ObjectId(), 5, "red"),
+                    PaintOrder(ObjectId(), 8, "purple"),
+                    PaintOrder(ObjectId(), 0,  "blue"),
+                    PaintOrder(ObjectId(), 0,  "white"),
+                    PaintOrder(ObjectId(), 6,  "yellow"),
+                    PaintOrder(ObjectId(), 0,  "pink"),
+                    PaintOrder(ObjectId(), 0,  "green"),
+                    PaintOrder(ObjectId(), 8,  "black")
+                )
+                collection.insertMany(paintOrders)
+            }
+        }
+
+        @AfterAll
+        @JvmStatic
+        private fun afterAll() {
+            runBlocking {
+                collection.drop()
+                client.close()
+            }
+        }
+    }
+
+    @Test
+    fun insertUpdateTest() = runBlocking {
+        // :snippet-start: upsert-update
+        val filter = Filters.eq(PaintOrder::color.name, "orange")
+        val update = Updates.inc(PaintOrder::qty.name, 10)
+        val options = UpdateOptions().upsert(true)
+
+        val results = collection.updateOne(filter, update, options)
+
+        println(results)
+        // :snippet-end:
+        // Junit test for the above code
+        assertTrue(results.wasAcknowledged())
+        assertEquals(0, results.modifiedCount)
+    }
+
+    @Test
+    fun updateOptionsTest() = runBlocking {
+        // :snippet-start: no-options
+        val filter = Filters.eq(PaintOrder::color.name, "orange")
+        val update = Updates.inc(PaintOrder::qty.name, 10)
+
+        val results = collection.updateOne(filter, update)
+
+        println(results)
+        // :snippet-end:
+        assertTrue(results.wasAcknowledged())
+        assertEquals(0, results.modifiedCount)
+    }
+}

source/examples/generated/UpsertTest.snippet.no-options.kt

@@ -0,0 +1,6 @@
+val filter = Filters.eq(PaintOrder::color.name, "orange")
+val update = Updates.inc(PaintOrder::qty.name, 10)
+
+val results = collection.updateOne(filter, update)
+
+println(results)

source/examples/generated/UpsertTest.snippet.upsert-data-model.kt

@@ -0,0 +1,5 @@
+data class PaintOrder(
+    @BsonId val id: ObjectId = ObjectId(),
+    val qty: Int,
+    val color: String
+)

source/examples/generated/UpsertTest.snippet.upsert-update.kt

@@ -0,0 +1,7 @@
+val filter = Filters.eq(PaintOrder::color.name, "orange")
+val update = Updates.inc(PaintOrder::qty.name, 10)
+val options = UpdateOptions().upsert(true)
+
+val results = collection.updateOne(filter, update, options)
+
+println(results)

source/fundamentals/crud/write-operations/upsert.txt

@@ -14,7 +14,7 @@ Overview
 --------
 
 In this guide, you can learn how to perform an **upsert** with the
-MongoDB Java driver.
+MongoDB Kotlin driver.
 
 Applications use insert and update operations to store and modify data.
 Sometimes, you need to choose between an insert and update depending on
@@ -50,6 +50,11 @@ colors of paint. The store had their annual online sale. Their
     { "_id": { "$oid": "606b4cfbcd83be7518b958e0" }, "color": "green", "qty": 0 }
     { "_id": { "$oid": "606b4cfbcd83be7518b958e1" }, "color": "black", "qty": 8 }
 
+This data is modeled with the following Kotlin data class:
+
+.. literalinclude:: /examples/generated/UpsertTest.snippet.upsert-data-model.kt
+   :language: kotlin
+
 The store received a fresh shipment and needs to update their inventory.
 The first item in the shipment is ten cans of orange paint.
 
@@ -58,18 +63,15 @@ where the ``color`` is ``"orange"``, specify an update to ``increment`` the
 ``qty`` field by ``10``, and specify ``true`` to
 ``UpdateOptions.upsert()``: 
 
-.. literalinclude:: /includes/fundamentals/code-snippets/InsertUpdate.java
-   :language: java
-   :dedent:
-   :start-after: begin updateOneExample
-   :end-before: end updateOneExample
+.. io-code-block::
 
-The method returns:
+   .. input:: /examples/generated/UpsertTest.snippet.upsert-update.kt
+      :language: kotlin
 
-.. code-block:: json   
-   :copyable: false
+   .. output:: 
+      :language:  console
 
-    AcknowledgedUpdateResult{ matchedCount=0, modifiedCount=0, upsertedId=BsonObjectId{ value=606b4cfc1601f9443b5d6978 }} 
+        AcknowledgedUpdateResult{ matchedCount=0, modifiedCount=0, upsertedId=BsonObjectId{ value=606b4cfc1601f9443b5d6978 }} 
 
 This ``AcknowledgedUpdateResult`` tells us:
 
@@ -96,18 +98,15 @@ The following shows the documents in the ``paint_inventory`` collection:
 
     Not including ``UpdateOptions`` results in no change to the collection.
 
-    .. literalinclude:: /includes/fundamentals/code-snippets/InsertUpdate.java
-        :language: java
-        :dedent:
-        :start-after: begin updateOneAttemptExample
-        :end-before: end updateOneAttemptExample
+    .. io-code-block::
 
-    The method returns:
+        .. input:: /examples/generated/UpsertTest.snippet.no-options.kt
+            :language: kotlin
 
-    .. code-block:: json
-       :copyable: false 
-    
-        AcknowledgedUpdateResult{ matchedCount=0, modifiedCount=0, upsertedId=null }
+        .. output:: 
+            :language:  console
+            
+            AcknowledgedUpdateResult{ matchedCount=0, modifiedCount=0, upsertedId=null }
 
 For more information about the methods and classes mentioned in this section,
 see the following API Documentation: