DOCSP-34569 Bulk Update Task Page

source/documents.txt

@@ -13,14 +13,17 @@ Documents are individual records in a MongoDB :ref:`collection
 
 From the :guilabel:`Documents` tab, you can
 :ref:`view <compass-view-documents>`, :ref:`insert <insert-documents>`,
-:ref:`modify <compass-modify-documents>`,
-:ref:`clone <clone-documents>`, and
-:ref:`delete <compass-delete-documents>` documents in your selected
-collection or view.
+:ref:`modify <compass-modify-documents>`, 
+:ref:`modify multiple <compass-bulk-update>`,
+:ref:`clone <clone-documents>`,
+:ref:`delete <compass-delete-documents>`, and 
+:ref:`delete multiple <compass-bulk-delete>` 
+documents in your selected collection or view.
 
 .. note::
 
-   .. include:: /includes/extracts/query-bar-results.rst
+   For query result sets larger than 20 documents, Compass shows 
+   paginated results. By default, pages display 20 documents at a time.
 
 From the :ref:`query bar <query-bar>`, you can specify a query to
 filter the displayed documents. Click :guilabel:`Options` to
@@ -31,8 +34,10 @@ specify query options.
    - :doc:`/documents/view`
    - :doc:`/documents/insert`
    - :doc:`/documents/modify`
+   - :ref:`compass-bulk-update`
    - :doc:`/documents/clone`
    - :doc:`/documents/delete`
+   - :ref:`compass-bulk-delete`
 
 .. toctree::
    :titlesonly:

source/documents/modify-multiple.txt

@@ -14,4 +14,155 @@ Modify Multiple Documents
    :depth: 1
    :class: singlecol
 
-You can perform bulk update operations on multiple documents in Compass.
+You can perform bulk update operations on multiple documents in Compass
+by using the :guilabel:`Update Documents` modal. Performing updates with
+the :guilabel:`Update Documents` modal helps you visualize updates 
+to your data before you apply them.
+
+About this Task
+---------------
+
+- You can use any syntax that works with the ``update`` parameter of
+  :method:`db.collection.updateMany()`. 
+
+- The :guilabel:`Update Documents` modal does not support any ``options`` 
+  parameters such as upsert, writeConcern, or collation.
+
+Before you Begin
+----------------
+
+The :guilabel:`Update Documents` modal is available starting
+in Compass version ``1.5.X``. For instructions on updating or installing
+the latest Compass version, see :ref:`download-install`. 
+
+Steps
+-----
+
+.. procedure::
+   :style:  normal
+
+   .. step:: Apply a query filter
+
+      From the :guilabel:`Documents` tab, input a query into the 
+      :guilabel:`Query bar`. The filter criteria of the query specified 
+      applies to the documents in the :guilabel:`Bulk Update` modal. If 
+      you need to apply an update to all documents in a collection, 
+      leave the :guilabel:`Query bar` blank.
+
+   .. step:: Open the bulk update modal
+
+      On the :guilabel:`Documents` tab, click the :icon-lg:`Edit` 
+      :guilabel:`Update` button to display the 
+      :guilabel:`Update Documents` modal. The following 
+      table summarizes the :abbr:`UI (User Interface)` of the modal:
+
+      .. list-table::
+         :widths: 40 60
+         :header-rows: 1
+
+         * - UI Element
+           - Description
+
+         * - :guilabel:`Filter`
+           - Any filter criteria specified on the 
+             :guilabel:`Query Bar` applies to the 
+             :guilabel:`Update Documents` modal.
+             To update the filter query, exit the 
+             :guilabel:`Update Documents` modal and modify the 
+             query in the :guilabel:`Query Bar`.
+         * - :guilabel:`Update`
+           - The update syntax that is applied to the 
+             documents specified in the filter criteria. You can use 
+             any syntax that works with the ``update`` parameter of the
+             :method:`db.collection.updateMany()`.
+         * - :guilabel:`Preview`
+           - A preview of documents with the update syntax applied.
+
+   .. step:: Enter the update syntax 
+
+      In the :guilabel:`Update` text field, provide the update 
+      syntax.
+
+      The number of documents affected by the update displays at 
+      the top of the :guilabel:`Update Documents` modal.
+
+      .. note::
+
+         The documents under the :guilabel:`Preview` header show how the 
+         :guilabel:`Update` syntax affects documents in your collection.
+
+   .. step:: (Optional) Name and save your :guilabel:`Update`
+
+      You can name and save the update query in the 
+      :guilabel:`Update Documents` modal. Saving your query adds it 
+      to your :ref:`favorite queries <saved-favorite-query-view>` for 
+      that collection and allows you to load and copy the query after 
+      you close the modal.
+
+      a. Click the :guilabel:`Save` button on the bottom left of the 
+         modal.
+      #. Enter a name for the update syntax.
+      #. Click the green :guilabel:`Save` button.
+
+   .. step:: Update your documents
+
+      Click :guilabel:`Update Documents`.
+
+      Compass applies the :guilabel:`Update` to the documents
+      within the :guilabel:`Filter` expression.
+
+Example
+-------
+
+The following example uses the 
+:ref:`sample_mflix dataset <sample-data>`. 
+
+This example updates the ``tomatoes.viewer.numReviews`` and 
+``tomatoes.viewer.meter`` fields with the Compass 
+:guilabel:`Update Documents` modal.
+
+Apply a filter in the :guilabel:`Query Bar` to filter movies which
+have a ``year`` of ``1917``.
+
+.. code-block:: javascript
+
+   { 'year' : 1917 }
+
+Click the :icon-lg:`Edit` :guilabel:`Update` button, the :guilabel:`Update Documents` 
+modal displays.
+
+In the :guilabel:`Update` text box, paste the following syntax:
+
+.. code-block:: javascript
+
+   { 
+      $inc: { "tomatoes.viewer.numReviews" : 1}, 
+      $set: { "tomatoes.viewer.meter" : 99 } 
+   }
+
+This syntax:
+
+- :manual:`Increments </reference/operator/update/inc>` the 
+  ``tomatoes.viewer.numReviews`` field by ``1``.
+- :manual:`Sets </reference/operator/update/set>` the 
+  ``tomatoes.viewer.meter`` field to ``99``.
+
+The :guilabel:`Preview` section populates with sample documents
+affected by the update query.
+
+To view the updates to the :guilabel:`numReviews` 
+and :guilabel:`meter` fields:
+
+- Click the :icon-fa5:`angle-right` arrow icon next to 
+  :guilabel:`tomatoes`. 
+- Click the :icon-fa5:`angle-right` arrow icon next to 
+  :guilabel:`viewer`.
+
+Click the :guilabel:`Update Documents` button to update the collection's
+data.
+
+Learn More
+----------
+
+- :ref:`compass-bulk-delete`
+- :ref:`saved-favorite-query-view`

source/includes/fact-viewing-favorite-queries.rst

@@ -12,4 +12,29 @@
 
    .. step:: Click the :guilabel:`Favorites` button in the past queries pane.
 
-      Select favorite queries.
+      Select your favorited operation.
+
+      - If your favorited operation is a query, only a :guilabel:`Filter` 
+        statement displays in the :guilabel:`Favorites` list view 
+        along with copy :icon-lg:`Copy` and delete :icon-lg:`Trash` 
+        icons.
+
+        .. note::
+
+            Clicking a favorited query in the 
+            :guilabel:`Favorites` list view populates your 
+            :guilabel:`Query Bar` with that query.
+
+      - If your favorited operation is a bulk update statement, a 
+        :guilabel:`Filter` and :guilabel:`Update` statement display in 
+        the :guilabel:`Favorites` list view along with copy 
+        :icon-lg:`Copy`, delete :icon-lg:`Trash`, and 
+        :icon-lg:`OpenNewTab` open in modal icons.
+
+        .. note::
+
+            Clicking the :icon-lg:`OpenNewTab` icon opens the bulk 
+            update statement and the filter criteria in the 
+            :guilabel:`Update Documents` modal. For details on bulk 
+            update statements in Compass, see 
+            :ref:`compass-bulk-update`.

source/query/queries.txt

@@ -73,6 +73,8 @@ When you click a saved or favorite pipeline tile, Compass opens the
    :figwidth: 720 px
    :alt: My queries view
 
+.. _saved-favorite-query-view:
+
 Using the :guilabel:`Favorites` Tab 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~