DOCSP-20086 updates for update pt7 v5.2 (#160) (#187)

* DOCSP-20086 updates for update() pt7

* Add explain, gt

* DOCSP-20086 gt lte lt create-inventory

* gt lt ne nor not

* gte

* Staging fixes

* Review feedback

Author: Dave

source/includes/examples-create-inventory.rst

@@ -0,0 +1,17 @@
+.. code-block:: javascript
+
+   db.inventory.insertMany( [
+      {
+         "item": "nuts", "quantity": 30,
+         "carrier": { "name": "Shipit", "fee": 3 }
+      },
+      {
+         "item": "bolts", "quantity": 50,
+         "carrier": { "name": "Shipit", "fee": 4 }
+      },
+      {
+         "item": "washers", "quantity": 10,
+         "carrier": { "name": "Shipit", "fee": 1 }
+      }
+   ] )
+

source/includes/steps-schedule-balancer-window.yaml

@@ -41,11 +41,11 @@ level: 3
 title: "Modify the balancer's window."
 action:
   - pre: |
-      Set the ``activeWindow`` using :method:`~db.collection.update()`,
+      Set the ``activeWindow`` using :method:`~db.collection.updateOne()`,
       as in the following:
     language: sh
     code: |
-      db.settings.update(
+      db.settings.updateOne(
          { _id: "balancer" },
          { $set: { activeWindow : { start : "<start-time>", stop : "<stop-time>" } } },
          { upsert: true }

source/reference/method/db.collection.explain.txt

@@ -32,11 +32,8 @@ Description
           - :method:`~db.collection.count()`
           - :method:`~db.collection.find()`
           - :method:`~db.collection.remove()`
-          - :method:`~db.collection.update()`
-
         - - :method:`~db.collection.distinct()` 
           - :method:`~db.collection.findAndModify()`
-
         - - :method:`~db.collection.mapReduce()`
 
    To use :method:`db.collection.explain()`, append one of the

source/reference/operator/query/comment.txt

@@ -31,8 +31,8 @@ Behavior
 
 You can use the :query:`$comment` with any expression taking a query
 predicate, such as the query predicate in
-:method:`db.collection.update()` or in the :pipeline:`$match` stage of
-the :doc:`aggregation pipeline </meta/aggregation-quick-reference>`.
+:method:`db.collection.updateOne()` or in the :pipeline:`$match` stage
+of the :doc:`aggregation pipeline </meta/aggregation-quick-reference>`.
 For an example, see :ref:`ex-comment-agg-expression`.
 
 Examples

source/reference/operator/query/gt.txt

@@ -10,50 +10,100 @@ $gt
    :depth: 1
    :class: singlecol
 
+Definition
+----------
+
 .. query:: $gt
 
-   *Syntax*: ``{field: {$gt: value} }``
+   *Syntax*: ``{ field: { $gt: value } }``
 
    :query:`$gt` selects those documents where the value of the
    ``field`` is greater than (i.e. ``>``) the specified ``value``.
 
    .. include:: /includes/fact-type-bracketing.rst
 
-   Consider the following example:
+Examples
+--------
+
+The following examples use the ``inventory`` collection. Create the
+collection:
+
+.. include:: /includes/examples-create-inventory.rst
+
+Match Document Fields
+~~~~~~~~~~~~~~~~~~~~~
+
+Select all documents in the ``inventory`` collection where ``quantity``
+is greater than ``20``:
+
+.. code-block:: javascript
+
+   db.inventory.find( { quantity: { $gt: 20 } } )
+
+Example output:
+
+.. code-block:: javascript
+
+   {
+     _id: ObjectId("61ba25cbfe687fce2f042414"),
+     item: 'nuts',
+     quantity: 30,
+     carrier: { name: 'Shipit', fee: 3 }
+   },
+   {
+     _id: ObjectId("61ba25cbfe687fce2f042415"),
+     item: 'bolts',
+     quantity: 50,
+     carrier: { name: 'Shipit', fee: 4 }
+   }
 
-   .. code-block:: javascript
+Perform an Update Based on Embedded Document Fields
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-      db.inventory.find( { qty: { $gt: 20 } } )
+The following example sets the ``price`` field based on a :query:`$gt`
+comparison against a field in an embedded document.
 
-   This query will select all documents in the ``inventory`` collection
-   where the ``qty`` field value is greater than ``20``.
+.. code-block:: javascript
 
-   Consider the following example that uses the :query:`$gt`
-   operator with a field from an embedded document:
+   db.inventory.updateOne(
+      { "carrier.fee": { $gt: 2 } }, { $set: { "price": 9.99 } }
+   )
 
-   .. code-block:: javascript
+Example output:
 
-      db.inventory.update( { "carrier.fee": { $gt: 2 } }, { $set: { price: 9.99 } } )
+.. code-block:: javascript
 
-   This :method:`~db.collection.update()` operation will set
-   the value of the ``price`` field in the first document found containing the
-   embedded document ``carrier`` whose ``fee`` field value is
-   greater than ``2``.
+   {
+     _id: ObjectId("61ba3ec9fe687fce2f042417"),
+     item: 'nuts',
+     quantity: 30,
+     carrier: { name: 'Shipit', fee: 3 },
+     price: 9.99
+   },
+   {
+     _id: ObjectId("61ba3ec9fe687fce2f042418"),
+     item: 'bolts',
+     quantity: 50,
+     carrier: { name: 'Shipit', fee: 4 }
+   },
+   {
+     _id: ObjectId("61ba3ec9fe687fce2f042419"),
+     item: 'washers',
+     quantity: 10,
+     carrier: { name: 'Shipit', fee: 1 }
+   }
 
-   To set the value of the ``price`` field in *all* documents containing the
-   embedded document ``carrier`` whose ``fee`` field value is greater than ``2``,
-   specify the ``multi:true`` option in the :method:`~db.collection.update()` method:
+This :method:`~db.collection.updateOne()` operation searches for an
+embedded document, ``carrier``, with a subfield named ``fee``. It sets
+``{ price: 9.99 }`` in the first document it finds where ``fee`` has a
+value greater than 2.
 
-   .. code-block:: javascript
+To set the value of the ``price`` field in *all* documents where
+``carrier.fee`` is greater than 2, use
+:method:`~db.collection.updateMany()`.
 
-      db.inventory.update( 
-         { "carrier.fee": { $gt: 2 } },
-         { $set: { price: 9.99 } },
-         { multi: true }
-      )
+.. seealso::
 
-   .. seealso::
+   - :method:`~db.collection.find()`
+   - :update:`$set`
 
-      - :method:`~db.collection.find()`
-      - :method:`~db.collection.update()`
-      - :update:`$set`

source/reference/operator/query/gte.txt

@@ -10,39 +10,96 @@ $gte
    :depth: 1
    :class: singlecol
 
+Definition
+----------
+
 .. query:: $gte
 
-   *Syntax*: ``{field: {$gte: value} }``
+   *Syntax*: ``{ field: { $gte: value } }``
 
    :query:`$gte` selects the documents where the value of the
    ``field`` is greater than or equal to (i.e. ``>=``) a specified
    value (e.g. ``value``.)
 
    .. include:: /includes/fact-type-bracketing.rst
 
-   Consider the following example:
+Examples
+--------
+
+The following examples use the ``inventory`` collection. Create the
+collection:
+
+.. include:: /includes/examples-create-inventory.rst
+
+Match Document Fields
+~~~~~~~~~~~~~~~~~~~~~
+
+Select all documents in the ``inventory`` collection where ``quantity``
+is greater than or equal to ``20``:
+
+.. code-block:: javascript
+
+   db.inventory.find( { quantity: { $gte: 20 } } )
+
+Example output:
+
+.. code-block:: javascript
+
+   {
+     _id: ObjectId("61bb51211b83c864e3bbe037"),
+     item: 'nuts',
+     quantity: 30,
+     carrier: { name: 'Shipit', fee: 3 }
+   },
+   {
+     _id: ObjectId("61bb51211b83c864e3bbe038"),
+     item: 'bolts',
+     quantity: 50,
+     carrier: { name: 'Shipit', fee: 4 }
+  }
+
+Perform an Update Based on Embedded Document Fields
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example sets the ``price`` field based on a :query:`$gte`
+comparison against a field in an embedded document.
+
+.. code-block:: javascript
 
-   .. code-block:: javascript
+   db.inventory.updateMany(
+      { "carrier.fee": { $gte: 2 } }, { $set: { "price": 9.99 } }
+   )
 
-      db.inventory.find( { qty: { $gte: 20 } } )
+Example output:
 
-   This query would select all documents in ``inventory`` where
-   the ``qty`` field value is greater than or equal to ``20``.
+.. code-block:: javascript
 
-   Consider the following example which uses the :query:`$gte`
-   operator with a field from an embedded document:
+   {
+     _id: ObjectId("61bb51211b83c864e3bbe037"),
+     item: 'nuts',
+     quantity: 30,
+     carrier: { name: 'Shipit', fee: 3 },
+     price: 9.99
+   },
+   {
+     _id: ObjectId("61bb51211b83c864e3bbe038"),
+     item: 'bolts',
+     quantity: 50,
+     carrier: { name: 'Shipit', fee: 4 },
+     price: 9.99
+   }
 
-   .. code-block:: javascript
+This :method:`~db.collection.updateOne()` operation searches for an
+embedded document, ``carrier``, with a subfield named ``fee``. It sets
+``{ price: 9.99 }`` in each document where ``fee`` has a value greater
+than or equal to 2.
 
-      db.inventory.update( { "carrier.fee": { $gte: 2 } }, { $set: { price: 9.99 } } )
+To set the value of the ``price`` field in only the first document
+where ``carrier.fee`` is greater than 2, use
+:method:`~db.collection.updateOne()`.
 
-   This :method:`~db.collection.update()` operation will set
-   the value of the ``price`` field that contain the embedded document
-   ``carrier`` whose ``fee`` field value is greater than or equal to
-   ``2``.
+.. seealso::
 
-   .. seealso::
+   - :method:`~db.collection.find()`
+   - :update:`$set`
 
-      - :method:`~db.collection.find()`
-      - :method:`~db.collection.update()`
-      - :update:`$set`