Skip to content

Commit

Permalink
DOCSP-34569 Bulk Update Task Page
Browse files Browse the repository at this point in the history
  • Loading branch information
ianf-mongodb committed Nov 20, 2023
1 parent 39d1e19 commit be8fdb5
Showing 1 changed file with 96 additions and 1 deletion.
97 changes: 96 additions & 1 deletion source/documents/modify-multiple.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,99 @@ 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.

A task page begins with a brief introduction summarizing the task, often called
a short description. The short description briefly explains the task, and
answers the following questions:

- "What is this task?"

- "What is it used for?"

- "Why do I care?"

This paragraph can include links out to important conceptual information
required for this task.

About this Task
---------------

Optional.

Include important conceptual or behavioral information that's directly relevant
to the task. If task-related information is extensive, consider a bulleted list
that contains brief descriptions of important concepts and links to deeper reading.

Before you Begin
----------------

Optional.

An ordered or unordered list of any prerequisites for the task.

Steps
-----

These are the steps to complete the task.

In some cases, we recomend that you use a stepped content approach. In others,

Check failure on line 53 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.Wordiness] Consider using 'sometimes' instead of 'In some cases'. Raw Output: {"message": "[MongoDB.Wordiness] Consider using 'sometimes' instead of 'In some cases'.", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 53, "column": 1}}}, "severity": "ERROR"}
a single statement and copyable command or syntax example. In most cases, it's helpful

Check failure on line 54 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.Wordiness] Consider using 'usually' instead of 'In most cases'. Raw Output: {"message": "[MongoDB.Wordiness] Consider using 'usually' instead of 'In most cases'.", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 54, "column": 61}}}, "severity": "ERROR"}
to include an example of what a successful result looks like. It could be a
brief description, code block, or screenshot.

.. procedure::
:style: connected

.. step:: Open the Bulk Update Modal

From the :guilabel:`Documents` tab, click :guilabel:`Update`.

The :guilabel:`Update Documents` modal displays.

This modal displays:

- Any filter criteria, this is the filter criteria from
the :guilabel:`Query Bar`.
- The update statement, this is the ``$set`` command, that is applied

Check failure on line 71 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.CommaRestrictiveClause] Don’t use a comma to set off a restrictive clause (one that begins with that). Raw Output: {"message": "[MongoDB.CommaRestrictiveClause] Don’t use a comma to set off a restrictive clause (one that begins with that).", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 71, "column": 59}}}, "severity": "ERROR"}
to the documents in the collection.
- A preview of documents after the update statement is applied.

.. step:: Provide the update syntax

a. In the :guilabel:`Update` text field, provide the update
syntax.

.. note::

The number of documents affected by the update displays in

Check failure on line 82 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.Accessibility] Don't use language (such as 'affected by') that defines people by their disability. Raw Output: {"message": "[MongoDB.Accessibility] Don't use language (such as 'affected by') that defines people by their disability.", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 82, "column": 37}}}, "severity": "ERROR"}
the top of the :guilabel:`Update Documents` modal in
parentheses.

#. Click :guilabel:`Update Documents`.

Compass applies the :guilabel:`Update` syntax to the documents
within the filter criteria in the :guilabel:`` expression.

Example
-------

Optional.

In some cases, you can work through a specific example throughout the steps.

Check failure on line 96 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.Wordiness] Consider using 'sometimes' instead of 'In some cases'. Raw Output: {"message": "[MongoDB.Wordiness] Consider using 'sometimes' instead of 'In some cases'.", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 96, "column": 1}}}, "severity": "ERROR"}
In others, it is helpful to show a complete example at the end. In most cases,

Check failure on line 97 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.Wordiness] Consider using 'usually' instead of 'In most cases'. Raw Output: {"message": "[MongoDB.Wordiness] Consider using 'usually' instead of 'In most cases'.", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 97, "column": 65}}}, "severity": "ERROR"}
it's helpful to include an example of what a successful result looks like. It

Check failure on line 98 in source/documents/modify-multiple.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.AvoidSubjunctive] Avoid the subjunctive ' could'. Raw Output: {"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive ' could'.", "location": {"path": "source/documents/modify-multiple.txt", "range": {"start": {"line": 98, "column": 79}}}, "severity": "ERROR"}
could be a brief description, code block, or screenshot.

Next Steps
----------

Optional.

If there is one or many logical next things to do, you can link to them here.

Learn More
----------

.. include:: /includes/info-typing/fact-learn-more.rst

0 comments on commit be8fdb5

Please sign in to comment.