DOCSP-31089: Improve bulk operation examples

Author: norareidy

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

@@ -21,7 +21,7 @@ MongoDB Java Driver.
 To perform a create, replace, update, or delete operation,
 use its corresponding method. For example, to insert one document,
 update multiple documents, and delete one document in your collection,
-use the ``insertOne()``, ``updateMany()`` and ``deleteOne()`` methods. 
+use the ``insertOne()``, ``updateMany()`` and ``deleteOne()`` methods.
 
 The ``MongoClient`` performs these operations by making a call for each
 operation to the database. You can reduce the number of calls to the
@@ -31,18 +31,19 @@ Performing Bulk Operations
 --------------------------
 
 Bulk operations consist of a large number of write operations. To perform
-a bulk operation, pass a ``List`` of ``WriteModel`` documents  to the
+a bulk operation, pass a ``List`` of ``WriteModel`` documents to the
 ``bulkWrite()`` method. A ``WriteModel`` is a model that represents any
 of the write operations. 
 
 The following sections show how to create and use each ``WriteModel``
-document. The examples in each section contain the following documents
-in a collection: 
+document. The examples in each section use the following documents in the
+``people`` collection:
 
 .. code-block:: json
 
-   { "_id": 1 }
-   { "_id": 2 }
+   { "_id": 1, "name": "Karen Sandoval", "age": 31 }
+   { "_id": 2, "name": "William Chin", "age": 54 }
+   { "_id": 8, "name": "Shayla Ray", "age": 20 }
 
 For more information about the methods and classes mentioned in this section,
 see the following API Documentation:
@@ -62,7 +63,7 @@ Example
 ```````
 
 The following example creates an ``InsertOneModel`` for two documents
-where the ``_id`` values are "3" and "4": 
+describing people:
 
 .. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
    :language: java
@@ -77,7 +78,7 @@ where the ``_id`` values are "3" and "4":
    collection. Instead, the method throws a ``MongoBulkWriteException``.
 
    The following example tries to insert two documents where the ``_id`` is
-   "1" and "3":
+   ``1`` and ``3``:
 
    .. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
       :language: java
@@ -90,12 +91,12 @@ where the ``_id`` values are "3" and "4":
    .. code-block:: shell
       :copyable: false
 
-      A MongoBulkWriteException occurred with the following message:  
+      A MongoBulkWriteException occurred with the following message: 
       Bulk write operation error on server sample-shard-00-02.pw0q4.mongodb.net:27017. 
       Write errors: [BulkWriteError{index=0, code=11000, message='E11000 duplicate key 
       error collection: crudOps.bulkWrite index: _id_ dup key: { _id: 1 }', details={}}].
 
-   To see why the document with the ``_id`` of "3" didn't insert, see
+   To see why the document with the ``_id`` of ``3`` didn't insert, see
    the :ref:`Order of Execution <orderOfExecution>` section.
 
 For more information about the methods and classes mentioned in this section,
@@ -121,8 +122,8 @@ Example
 ```````
 
 The following example creates a ``ReplaceOneModel`` to
-replace a document where the ``_id`` is "1" with a document that
-contains an additional field: 
+replace a document where the ``_id`` is ``1`` with a document that
+contains an additional ``location`` field: 
 
 .. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
    :language: java
@@ -158,8 +159,7 @@ Example
 ```````
 
 The following example creates an ``UpdateOneModel`` to update
-a document where the ``_id`` is "2" to a document that
-contains an additional field: 
+the ``age`` field in a document where the ``_id`` is ``2``:
 
 .. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
    :language: java
@@ -195,7 +195,7 @@ Example
 ```````
 
 The following example creates a ``DeleteOneModel`` to delete
-a document where the ``_id`` is "1":
+a document where the ``_id`` is ``1``:
 
 .. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
    :language: java
@@ -230,10 +230,13 @@ Example
 
 The following example performs these bulk operations:
 
-- An insert operation for a document where the ``_id`` is "3"
-- A replace operation for a document where the ``_id`` is "1" with a document that contains an additional field
-- An update operation for a document where the ``_id`` is "3" to a document that contains an additional field
-- A delete operation for all documents that contain the field ``x`` with the value "2"
+- An insert operation for a document where the ``name`` is ``"Zaynab Omar"``and the
+  ``age`` is ``37``
+- A replace operation for a document where the ``_id`` is ``1`` with a new document
+  that contains the ``location`` field
+- An update operation for a document where the ``name`` is ``"Zaynab Omar"`` to change the ``name``
+  field to ``"Zaynab Hassan"``
+- A delete operation for all documents that have an ``age`` value greater than ``50``
 
 .. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
    :language: java
@@ -247,7 +250,9 @@ document:
 .. code-block:: json
    :copyable: false
 
-   { "_id": 2 }
+   { "_id": 1, "name": "Sandy Kane", "location": "Helena, MT" }
+   { "_id": 8, "name": "Shayla Ray", "age": 20 }
+   { "_id": 6, "name": "Zaynab Hassan", "age": 37 }
 
 Unordered Execution
 ~~~~~~~~~~~~~~~~~~~
@@ -280,8 +285,9 @@ operations to execute in any order:
    .. code-block:: json
       :copyable: false
 
-      { "_id": 2 }
-      { "_id": 3 }
+      { "_id": 1, "name": "Sandy Kane", "location": "Helena, MT" }
+      { "_id": 8, "name": "Shayla Ray", "age": 20 }
+      { "_id": 6, "name": "Zaynab Omar", "age": 37 }
 
 For more information about the methods and classes mentioned in this section,
 see the following API Documentation:

source/includes/fundamentals/code-snippets/BulkWrite.java

@@ -114,16 +114,16 @@ private void bulkWriteExample() {
 
         List<WriteModel<Document>> bulkOperations = new ArrayList<>();
 
-        InsertOneModel<Document> doc1 = new InsertOneModel<>(new Document("_id", 3));
-        ReplaceOneModel<Document> doc2 = new ReplaceOneModel<>(Filters.eq("_id", 1), 
-                                            new Document("_id", 1).append("x", 2));                            
-        UpdateOneModel<Document> doc3 = new UpdateOneModel<>(Filters.eq("_id", 3), Updates.set("x", 2));
-        DeleteManyModel<Document> doc4 = new DeleteManyModel<>(Filters.eq("x", 2));
+        InsertOneModel<Document> insertDoc = new InsertOneModel<>(new Document("name", "Zaynab Omar").append("age", 37));
+        ReplaceOneModel<Document> replaceDoc = new ReplaceOneModel<>(Filters.eq("_id", 1), 
+                                            new Document("name", "Sandy Kane").append("location", "Helena, MT"));                            
+        UpdateOneModel<Document> updateDoc = new UpdateOneModel<>(Filters.eq("name", "Zaynab Omar"), Updates.set("name", "Zaynab Hassan"));
+        DeleteManyModel<Document> deleteDoc = new DeleteManyModel<>(Filters.gt("age", 50));
 
-        bulkOperations.add(doc1);
-        bulkOperations.add(doc2);
-        bulkOperations.add(doc3);
-        bulkOperations.add(doc4);
+        bulkOperations.add(insertDoc);
+        bulkOperations.add(replaceDoc);
+        bulkOperations.add(updateDoc);
+        bulkOperations.add(deleteDoc);
 
         collection.bulkWrite(bulkOperations);               
         //end bulkWriteExample
@@ -134,8 +134,8 @@ private void insertDocumentsExample(){
         List<WriteModel<Document>> bulkOperations = new ArrayList<>();
 
         // begin insertDocumentsExample
-        InsertOneModel<Document> doc1 = new InsertOneModel<>(new Document("_id", 3));
-        InsertOneModel<Document> doc2 = new InsertOneModel<>(new Document("_id", 4));
+        InsertOneModel<Document> juneDoc = new InsertOneModel<>(new Document("name", "June Carrie").append("age", 17));
+        InsertOneModel<Document> kevinDoc = new InsertOneModel<>(new Document("name", "Kevin Moss").append("age", 22));
         //end insertDocumentsExample
 
         bulkOperations.add(doc1);
@@ -152,9 +152,9 @@ private void replaceDocumentsExample(){
         InsertOneModel<Document> doc2 = new InsertOneModel<>(new Document("_id", 2));
 
         // begin replaceDocumentsExample
-        ReplaceOneModel<Document> doc3 = new ReplaceOneModel<>(
+        ReplaceOneModel<Document> celineDoc = new ReplaceOneModel<>(
                                             Filters.eq("_id", 1), 
-                                            new Document("_id", 1).append("x", 4));
+                                            new Document("name", "Celine Stork").append("location", "San Diego, CA"));
         //end replaceDocumentsExample
 
         bulkOperations.add(doc1);
@@ -172,9 +172,9 @@ private void updateDocumentsExample(){
         InsertOneModel<Document> doc2 = new InsertOneModel<>(new Document("_id", 2));
 
         // begin updateDocumentsExample
-        UpdateOneModel<Document> doc3 = new UpdateOneModel<>(
+        UpdateOneModel<Document> updateDoc = new UpdateOneModel<>(
                                             Filters.eq("_id", 2), 
-                                            Updates.set("x", 8));
+                                            Updates.set("age", 31));
         //end updateDocumentsExample
 
         bulkOperations.add(doc1);