DOCSP-24397 bulk write example (#1646) (#1651)

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

* DOCSP-24397-bulk-write-example

Co-authored-by: jason-price-mongodb <[email protected]>

Co-authored-by: jason-price-mongodb <[email protected]>

Author: jason-price-mongodb

source/core/bulk-write-operations.txt

@@ -26,6 +26,8 @@ perform bulk insert, update, and delete operations.
 MongoDB also supports bulk insert through the 
 :method:`db.collection.insertMany()` method.
 
+.. _bulk-write-operations-ordered-vs-unordered:
+
 Ordered vs Unordered Operations
 -------------------------------
 
@@ -70,83 +72,17 @@ bulkWrite() Methods
 Each write operation is passed to :method:`~db.collection.bulkWrite()` as a 
 document in an array.
 
-For example, the following performs multiple write operations:
-
-The ``characters`` collection contains the following documents:
-
-.. code-block:: javascript
-
-   { "_id" : 1, "char" : "Brisbane", "class" : "monk", "lvl" : 4 },
-   { "_id" : 2, "char" : "Eldon", "class" : "alchemist", "lvl" : 3 },
-   { "_id" : 3, "char" : "Meldane", "class" : "ranger", "lvl" : 3 }
-   
-The following :method:`~db.collection.bulkWrite()` performs multiple 
-operations on the collection:
-
-.. code-block:: javascript
-
-   try {
-      db.characters.bulkWrite(
-         [
-            { insertOne : 
-               { 
-                  "document" : 
-                  {
-                     "_id" : 4, "char" : "Dithras", "class" : "barbarian", "lvl" : 4
-                  }
-               } 
-            },
-            { insertOne : 
-               { 
-                  "document" : 
-                  {
-                     "_id" : 5, "char" : "Taeln", "class" : "fighter", "lvl" : 3
-                  }
-               } 
-            },
-            { updateOne : 
-               { 
-                  "filter" : { "char" : "Eldon" }, 
-                  "update" : { $set : { "status" : "Critical Injury" } }
-               }
-            },
-            { deleteOne : 
-               { "filter" : { "char" : "Brisbane" } }
-            },
-            { replaceOne :
-               {
-                  "filter" : { "char" : "Meldane" },
-                  "replacement" : { "char" : "Tanys", "class" : "oracle", "lvl" : 4 }
-               }
-            }
-         ]
-      );
-   }
-   catch (e) {
-      print(e);
-   }
-
-The operation returns the following:
-
-.. code-block:: javascript
-
-   {
-      "acknowledged" : true,
-      "deletedCount" : 1,
-      "insertedCount" : 2,
-      "matchedCount" : 2,
-      "upsertedCount" : 0,
-      "insertedIds" : {
-         "0" : 4,
-         "1" : 5
-      },
-      "upsertedIds" : {
-      
-      }
-   }
-   
-For more examples, see 
-:ref:`bulkWrite() Examples <bulkwrite-example-bulk-write-operation>`
+Example
+-------
+
+The example in this section uses the ``pizzas`` collection:
+
+.. include:: /includes/pizza-example-collection.rst
+
+.. include:: /includes/pizza-bulk-write-example.rst
+
+For more examples, see :ref:`bulkWrite() Examples
+<bulkwrite-example-bulk-write-operation>`.
 
 Strategies for Bulk Inserts to a Sharded Collection
 ---------------------------------------------------

source/includes/pizza-bulk-write-example.rst

@@ -0,0 +1,43 @@
+The following :method:`~db.collection.bulkWrite()` example runs
+these operations on the ``pizzas`` collection:
+
+- Adds two documents using ``insertOne``.
+- Updates a document using ``updateOne``.
+- Deletes a document using ``deleteOne``.
+- Replaces a document using ``replaceOne``.
+
+.. code-block:: javascript
+
+   try {
+      db.pizzas.bulkWrite( [
+         { insertOne: { document: { _id: 3, type: "beef", size: "medium", price: 6 } } },
+         { insertOne: { document: { _id: 4, type: "sausage", size: "large", price: 10 } } },
+         { updateOne: {
+            filter: { type: "cheese" },
+            update: { $set: { price: 8 } }
+         } },
+         { deleteOne: { filter: { type: "pepperoni"} } },
+         { replaceOne: {
+            filter: { type: "vegan" },
+            replacement: { type: "tofu", size: "small", price: 4 }
+         } }
+      ] )
+   } catch( error ) {
+      print( error )
+   }
+
+Example output, which includes a summary of the completed operations:
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+      acknowledged: true,
+      insertedCount: 2,
+      insertedIds: { '0': 3, '1': 4 },
+      matchedCount: 2,
+      modifiedCount: 2,
+      deletedCount: 1,
+      upsertedCount: 0,
+      upsertedIds: {}
+   }

source/includes/pizza-example-collection.rst

@@ -0,0 +1,7 @@
+.. code-block:: javascript
+
+   db.pizzas.insertMany( [
+      { _id: 0, type: "pepperoni", size: "small", price: 4 },
+      { _id: 1, type: "cheese", size: "medium", price: 7 },
+      { _id: 2, type: "vegan", size: "large", price: 8 }
+   ] )