DOCSP-20016 BACKPORT (#131)

Dave · web-flow · commit ba764f48a713 · 2021-12-10T11:50:48.000-05:00
* DOCSP-20016 updates for update pt5 * DOCSP-20016 additional files * Add sort * Staging updates * Staging Updates * Review feedback
diff --git a/source/includes/example-push-with-multiple-modifiers.rst b/source/includes/example-push-with-multiple-modifiers.rst
@@ -1,16 +1,18 @@
-A collection ``students`` has the following document:
+Add the following document to the ``students`` collection:
 
 .. code-block:: javascript
 
-   {
-      "_id" : 5,
-      "quizzes" : [
-         { "wk": 1, "score" : 10 },
-         { "wk": 2, "score" : 8 },
-         { "wk": 3, "score" : 5 },
-         { "wk": 4, "score" : 6 }
-      ]
-   }
+   db.students.insertOne(
+      {
+         "_id" : 5,
+         "quizzes" : [
+            { "wk": 1, "score" : 10 },
+            { "wk": 2, "score" : 8 },
+            { "wk": 3, "score" : 5 },
+            { "wk": 4, "score" : 6 }
+         ]
+      }
+   )
 
 The following :update:`$push` operation uses:
 
diff --git a/source/reference/operator/update/inc.txt b/source/reference/operator/update/inc.txt
@@ -44,28 +44,29 @@ generate an error.
 Example
 -------
 
-Consider a collection ``products`` with the following document:
+Create the ``products`` collection:
 
 .. code-block:: javascript
 
-   {
-     _id: 1,
-     sku: "abc123",
-     quantity: 10,
-     metrics: {
-       orders: 2,
-       ratings: 3.5
-     }
-   }
+   db.products.insertOne(
+      {
+        _id: 1,
+        sku: "abc123",
+        quantity: 10,
+        metrics: { orders: 2, ratings: 3.5 }
+      }
+   )
+
+The following :method:`~db.collection.updateOne()` operation uses the
+:update:`$inc` operator to:
+
+- increase the ``"metrics.orders"`` field by 1
+- increase the ``quantity`` field by -2 (which decreases ``quantity``)
 
-The following :method:`~db.collection.update()` operation uses the
-:update:`$inc` operator to decrease the ``quantity`` field by ``2``
-(i.e. increase by ``-2``) and increase the ``"metrics.orders"`` field
-by ``1``:
 
 .. code-block:: javascript
 
-   db.products.update(
+   db.products.updateOne(
       { sku: "abc123" },
       { $inc: { quantity: -2, "metrics.orders": 1 } }
    )
@@ -75,16 +76,14 @@ The updated document would resemble:
 .. code-block:: javascript
 
    {
-      "_id" : 1,
-      "sku" : "abc123",
-      "quantity" : 8,
-      "metrics" : {
-         "orders" : 3,
-         "ratings" : 3.5
-      }
+     _id: 1,
+     sku: 'abc123',
+     quantity: 8,
+     metrics: { orders: 3, ratings: 3.5 }
    }
 
 .. seealso::
 
-   - :method:`db.collection.update()`
+   - :method:`db.collection.updateMany()`
    - :method:`db.collection.findAndModify()`
+
diff --git a/source/reference/operator/update/max.txt b/source/reference/operator/update/max.txt
@@ -45,16 +45,17 @@ Examples
 Use ``$max`` to Compare Numbers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Consider the following document in the collection ``scores``:
+Create the ``scores`` collection:
 
 .. code-block:: javascript
 
    { _id: 1, highScore: 800, lowScore: 200 }
 
-The ``highScore`` for the document currently has the value
-``800``. The following operation uses :operator:`$max` to compare
-the ``800`` and the specified value ``950`` and updates the value
-of ``highScore`` to ``950`` since ``950`` is greater than ``800``:
+The ``highScore`` for the document currently has the value 800. The
+following operation:
+
+- Compares the ``highScore``, 800, to the specified value, 950
+- Updates ``highScore`` to 950 since 950 is greater than 800
 
 .. code-block:: javascript
 
@@ -66,12 +67,12 @@ The ``scores`` collection now contains the following modified document:
 
    { _id: 1, highScore: 950, lowScore: 200 }
 
-The next operation has no effect since the current value of the
-field ``highScore``, i.e. ``950``, is greater than ``870``:
+The next operation has no effect since the value of ``highScore``, 950,
+is greater than 870:
 
 .. code-block:: javascript
 
-   db.scores.update( { _id: 1 }, { $max: { highScore: 870 } } )
+   db.scores.updateOne( { _id: 1 }, { $max: { highScore: 870 } } )
 
 The document remains unchanged in the ``scores`` collection:
 
@@ -82,31 +83,33 @@ The document remains unchanged in the ``scores`` collection:
 Use ``$max`` to Compare Dates
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Consider the following document in the collection ``tags``:
+Create the ``tags`` collection:
 
 .. code-block:: javascript
 
-   {
-     _id: 1,
-     desc: "crafts",
-     dateEntered: ISODate("2013-10-01T05:00:00Z"),
-     dateExpired: ISODate("2013-10-01T16:38:16.163Z")
-   }
+   db.tags.insertOne(
+      {
+        _id: 1,
+        desc: "crafts",
+        dateEntered: ISODate("2013-10-01T05:00:00Z"),
+        dateExpired: ISODate("2013-10-01T16:38:16.163Z")
+      }
+   )
 
 The following operation compares the current value of the
-``dateExpired`` field, i.e.
-``ISODate("2013-10-01T16:38:16.163Z")``, with the specified date
-``new Date("2013-09-30")`` to determine whether to update the
-field:
+``dateExpired`` field, ``ISODate("2013-10-01T16:38:16.163Z")``, with
+the specified date ``new Date("2013-09-30")`` to determine whether to
+update the field:
 
 .. code-block:: javascript
 
-   db.tags.update(
+   db.tags.updateOne(
       { _id: 1 },
       { $max: { dateExpired: new Date("2013-09-30") } }
    )
 
-The operation does *not* update the ``dateExpired`` field:
+``new Date("2013-09-30")`` is not the newest date, so the operation
+does *not* update the ``dateExpired`` field:
 
 .. code-block:: javascript
    :emphasize-lines: 5
@@ -120,5 +123,6 @@ The operation does *not* update the ``dateExpired`` field:
 
 .. seealso::
 
-   - :method:`db.collection.update()`
+   - :method:`db.collection.updateMany()`
    - :method:`db.collection.findAndModify()`
+
diff --git a/source/reference/operator/update/pullAll.txt b/source/reference/operator/update/pullAll.txt
@@ -42,27 +42,28 @@ the specified ``<value>`` exactly, including order.
 Examples
 --------
 
-Given the following document in the ``survey`` collection:
+Create the ``survey`` collection:
 
 .. code-block:: javascript
 
-   { _id: 1, scores: [ 0, 2, 5, 5, 1, 0 ] }
+   db.survey.insertOne( { _id: 1, scores: [ 0, 2, 5, 5, 1, 0 ] } )
 
-The following operation removes all instances of the value ``0`` and
-``5`` from the ``scores`` array:
+The following operation removes all instances of the values "0" and "5"
+from the ``scores`` array:
 
 .. code-block:: javascript
 
-   db.survey.update( { _id: 1 }, { $pullAll: { scores: [ 0, 5 ] } } )
+   db.survey.updateOne( { _id: 1 }, { $pullAll: { scores: [ 0, 5 ] } } )
 
-After the operation, the updated document has all instances of ``0``
-and ``5`` removed from the ``scores`` field:
+After the update, the ``scores`` field no longer has any instances of
+"0" or "5".
 
 .. code-block:: javascript
 
    { "_id" : 1, "scores" : [ 2, 1 ] }
 
 .. seealso::
 
-   - :method:`db.collection.update()`
+   - :method:`db.collection.updateMany()`
    - :method:`db.collection.findAndModify()`
+
diff --git a/source/reference/operator/update/set.txt b/source/reference/operator/update/set.txt
@@ -52,20 +52,21 @@ or create each field.
 Examples
 --------
 
-Consider a collection ``products`` with the following document:
+Create the ``products`` collection:
 
 .. code-block:: javascript
 
-   {
-     _id: 100,
-     sku: "abc123",
-     quantity: 250,
-     instock: true,
-     reorder: false,
-     details: { model: "14Q2", make: "xyz" },
-     tags: [ "apparel", "clothing" ],
-     ratings: [ { by: "ijk", rating: 4 } ]
-   }
+   db.products.insertOne(
+      {
+        _id: 100,
+        quantity: 250,
+        instock: true,
+        reorder: false,
+        details: { model: "14QQ", make: "Clothes Corp" },
+        tags: [ "apparel", "clothing" ],
+        ratings: [ { by: "Customer007", rating: 4 } ]
+      }
+   )
 
 Set Top-Level Fields
 ~~~~~~~~~~~~~~~~~~~~
@@ -77,20 +78,35 @@ field.
 
 .. code-block:: javascript
 
-   db.products.update(
+   db.products.updateOne(
       { _id: 100 },
       { $set:
          {
            quantity: 500,
-           details: { model: "14Q3", make: "xyz" },
+           details: { model: "2600", make: "Fashionaires" },
            tags: [ "coats", "outerwear", "clothing" ]
          }
       }
    )
 
-The operation replaces the value of: ``quantity`` to ``500``; the
-``details`` field to a new embedded document, and the ``tags`` field to
-a new array.
+The operation updates the:
+
+- value of ``quantity`` to ``500``
+- ``details`` field with new embedded document
+- ``tags`` field with new array
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+     _id: 100,
+     quantity: 500,
+     instock: true,
+     reorder: false,
+     details: { model: '2600', make: 'Fashionaires' },
+     tags: [ 'coats', 'outerwear', 'clothing' ],
+     ratings: [ { by: 'Customer007', rating: 4 } ]
+   }
 
 Set Fields in Embedded Documents
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -103,11 +119,27 @@ document:
 
 .. code-block:: javascript
 
-   db.products.update(
+   db.products.updateOne(
       { _id: 100 },
-      { $set: { "details.make": "zzz" } }
+      { $set: { "details.make": "Kustom Kidz" } }
    )
 
+After updating, the document has the following values:
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+      _id: 100,
+      quantity: 500,
+      instock: true,
+      reorder: false,
+      details: { model: '2600', make: 'Kustom Kidz' },
+      tags: [ 'coats', 'outerwear', 'clothing' ],
+      ratings: [ { by: 'Customer007', rating: 4 } ]
+   }
+
+
 Set Elements in Arrays
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -120,7 +152,7 @@ element (array index of ``0``) of the ``ratings`` array.
 
 .. code-block:: javascript
 
-   db.products.update(
+   db.products.updateOne(
       { _id: 100 },
       { $set:
          {
@@ -130,10 +162,28 @@ element (array index of ``0``) of the ``ratings`` array.
       }
    )
 
+
+After updating, the document has the following values:
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+     _id: 100,
+     quantity: 500,
+     instock: true,
+     reorder: false,
+     details: { model: '2600', make: 'Kustom Kidz' },
+     tags: [ 'coats', 'rain gear', 'clothing' ],
+     ratings: [ { by: 'Customer007', rating: 2 } ]
+   }
+
+
 For additional update operators for arrays, see
 :doc:`/reference/operator/update-array`.
 
 .. seealso::
 
-   - :method:`db.collection.update()`
+   - :method:`db.collection.updateMany()`
    - :method:`db.collection.findAndModify()`
+
diff --git a/source/reference/operator/update/sort.txt b/source/reference/operator/update/sort.txt
