DOCSP-19996 updates for update pt2 v5.1 (#109)

Dave · web-flow · commit 77754fc37e99 · 2021-12-07T16:40:57.000-05:00
* DOCSP-19996-updates-for-update-pt2 * Add files
diff --git a/source/core/query-optimization.txt b/source/core/query-optimization.txt
@@ -205,8 +205,6 @@ To determine whether a query is a covered query, use the
 :method:`db.collection.explain()` or the :method:`~cursor.explain()`
 method and review the :ref:`results <explain-output-covered-queries>`.
 
-.. include:: /includes/fact-explain-collection-method.rst
-
 For more information see :ref:`indexes-measuring-use`.
 
 .. toctree::
diff --git a/source/includes/fact-explain-collection-method.rst b/source/includes/fact-explain-collection-method.rst
diff --git a/source/includes/fact-single-modification-in-sharded-collections.rst b/source/includes/fact-single-modification-in-sharded-collections.rst
@@ -1,6 +1,10 @@
 All |single-modification-operation-names| operations for a sharded
-collection that specify the |single-modification-operation-option| option must include the
-:term:`shard key` *or* the ``_id`` field in the query specification.
-|single-modification-operation-names| operations specifying |single-modification-operation-option|
-in a sharded collection which do not contain either the
-:term:`shard key` or the ``_id`` field return an error.
+collection that specify the |single-modification-operation-option|
+option must include the :term:`shard key` *or* the ``_id`` field in
+the query specification.
+
+|single-modification-operation-names| operations specifying
+|single-modification-operation-option| in a sharded collection which do
+not contain either the :term:`shard key` or the ``_id`` field return an
+error.
+
diff --git a/source/includes/table-transactions-operations.rst b/source/includes/table-transactions-operations.rst
@@ -86,7 +86,6 @@
    * - | :method:`db.collection.updateOne()`
        | :method:`db.collection.updateMany()`
        | :method:`db.collection.replaceOne()`
-       | :method:`db.collection.update()`
 
      - :dbcommand:`update`
 
diff --git a/source/reference/glossary.txt b/source/reference/glossary.txt
@@ -1025,7 +1025,7 @@ Glossary
 
    upsert
       An option for update operations; e.g.
-      :method:`db.collection.update()`,
+      :method:`db.collection.updateOne()`,
       :method:`db.collection.findAndModify()`. If set to true, the
       update operation will either update the document(s) matched by
       the specified query or if no documents match, insert a new
diff --git a/source/reference/limits.txt b/source/reference/limits.txt
@@ -312,7 +312,7 @@ Sharding Operational Restrictions
 
 .. limit:: Single Document Modification Operations in Sharded Collections
 
-   .. |single-modification-operation-names| replace:: :method:`~db.collection.update()` and :method:`~db.collection.remove()`
+   .. |single-modification-operation-names| replace:: :dbcommand:`update` and :method:`~db.collection.remove()`
    .. |single-modification-operation-option| replace:: ``justOne`` or ``multi: false``
 
    .. include:: /includes/fact-single-modification-in-sharded-collections.rst
diff --git a/source/reference/method.txt b/source/reference/method.txt
@@ -189,10 +189,6 @@ Collection
 
      - Unhides an index from the query planner.
 
-   * - :method:`db.collection.update()`
-
-     - Modifies a document in a collection.
-
    * - :method:`db.collection.updateOne()`
 
      - Modifies a single document in a collection.
diff --git a/source/reference/method/db.collection.explain.txt b/source/reference/method/db.collection.explain.txt
@@ -236,11 +236,11 @@ specified :method:`~db.collection.find()` operation:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The following example runs :method:`db.collection.explain()` in
-``"allPlansExecution"`` verbosity mode. The
+``"allPlansExecution"`` verbosity mode.
 :method:`db.collection.explain()` returns the
 :data:`~explain.queryPlanner` and :data:`~explain.executionStats` for
 all considered plans for the specified
-:method:`~db.collection.update()` operation:
+:method:`~db.collection.findAndModify()` operation:
 
 .. note::
 
@@ -251,10 +251,11 @@ all considered plans for the specified
 
 .. code-block:: javascript
 
-   db.products.explain("allPlansExecution").update(
-      { quantity: { $lt: 1000}, category: "apparel" },
-      { $set: { reorder: true } }
-   )
+   db.products.explain( "allPlansExecution" ).findAndModify( {
+      query: { name: "Tom", state: "active", rating: { $gt: 10 } },
+      sort: { rating: 1 },
+      update: { $inc: { score: 1 } }
+   } )
 
 .. _explain-find-modifiers:
 
diff --git a/source/reference/method/js-collection.txt b/source/reference/method/js-collection.txt
@@ -188,10 +188,6 @@ Collection Methods
 
      - Unhides an index from the query planner.
 
-   * - :method:`db.collection.update()`
-
-     - Modifies a document in a collection.
-
    * - :method:`db.collection.updateOne()`
 
      - Modifies a single document in a collection.
diff --git a/source/reference/read-concern.txt b/source/reference/read-concern.txt
@@ -430,7 +430,6 @@ of a multi-document transaction:
      - 
 
    * - | :dbcommand:`update`
-       | :method:`db.collection.update()`
        | :method:`db.collection.updateMany()`
        | :method:`db.collection.updateOne()`
        | :method:`db.collection.replaceOne()`
diff --git a/source/reference/update-methods.txt b/source/reference/update-methods.txt
@@ -11,35 +11,16 @@ collection:
    :widths: 35 65
 
    * - :method:`db.collection.updateOne()`
-
      - Updates at most a single document that match a specified filter
        even though multiple documents may match the specified filter.
 
-       .. versionadded:: 3.2
-
    * - :method:`db.collection.updateMany()`
-
      - Update all documents that match a specified filter.
 
-       .. versionadded:: 3.2
-
    * - :method:`db.collection.replaceOne()`
-
      - Replaces at most a single document that match a specified filter
        even though multiple documents may match the specified filter.
 
-       .. versionadded:: 3.2
-
-   * - :method:`db.collection.update()`
-
-     - Either updates or replaces a single document that match a
-       specified filter or updates all documents that match a specified
-       filter.
-
-       By default, the :method:`db.collection.update()` method
-       updates a **single** document. To update multiple documents, use
-       the :ref:`multi <multi-parameter>` option.
-
 .. _additional-updates:
 
 Additional Methods
@@ -48,11 +29,8 @@ Additional Methods
 The following methods can also update documents from a collection:
 
 - :method:`db.collection.findOneAndReplace()`.
-
 - :method:`db.collection.findOneAndUpdate()`.
-
 - :method:`db.collection.findAndModify()`.
-
 - :method:`db.collection.bulkWrite()`.
 
 See the individual reference pages for the methods for more information
diff --git a/source/tutorial/analyze-query-plan.txt b/source/tutorial/analyze-query-plan.txt
@@ -23,9 +23,8 @@ subject to change between MongoDB versions.
          and the :method:`db.collection.explain("executionStats")
          <db.collection.explain()>` methods provide statistics about
          the performance of a query. These statistics can be useful in
-         measuring if and how a query uses an index.
-
-         .. include:: /includes/fact-explain-collection-method.rst
+         measuring if and how a query uses an index. See
+         :method:`db.collection.explain()` for details.
 
      - id: compass
        content: |

Original file line number	Diff line number	Diff line change
`@@ -430,7 +430,6 @@ of a multi-document transaction:`
`430`	`430`	`-`
`431`	`431`
`432`	`432`	* - \| :dbcommand:`update`
`433`		- \| :method:`db.collection.update()`
`434`	`433`	\| :method:`db.collection.updateMany()`
`435`	`434`	\| :method:`db.collection.updateOne()`
`436`	`435`	\| :method:`db.collection.replaceOne()`