Skip to content

DOCSP-15486 fix build errors #5957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 7 additions & 24 deletions source/includes/steps-compass-manual-queries.yaml
Original file line number Diff line number Diff line change
@@ -1,34 +1,17 @@
title: Enter a query in the query bar
title: Enter a document filter
level: 4
ref: enter-query
action:
pre: |
Queries entered in the query bar must be valid MongoDB syntax. Only
:dbcommand:`finds <find>` will be executed.

This example manually selects documents whose ``departureAirportFsCode`` is
"JFK".

.. figure:: /images/compass/manual-query.png
:alt: Compass query bar with query entered

When a valid query is entered, the bar is colored green and can be
executed. Invalid queries are colored red. The UI will automatically update
to indicate which fields and values are selected in the query.
A document filter must use valid MongoDB syntax. Only
:dbcommand:`finds <find>` can be executed. Invalid filters are
colored red.
---
title: Apply the query
title: Apply a document filter
level: 4
ref: apply
action:
pre: |
After entering a query, run it by clicking the Apply button. To clear the
query, use the Reset button.

Continuing with the example, executing the query displays information on the
matching documents.

.. figure:: /images/compass/manual-query-results.png
:alt: Compass Apply button executes query

To clear a query, use the Reset button.
To run a filter, click the :guilabel:`FIND` button. To clear a
filter, click the :guilabel:`RESET` button.
...
36 changes: 21 additions & 15 deletions source/reference/audit-message.txt
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,10 @@ associated ``param`` details and the ``result`` values, if any.

- ``result``

* - :authaction:`authenticate`

* - .. _audit-message-authenticate:

``authenticate``

- .. code-block:: none
:copyable: false
Expand All @@ -157,7 +160,9 @@ associated ``param`` details and the ``result`` values, if any.
| ``18`` - Authentication Failed
| ``334`` - Mechanism Unavailable

* - :authaction:`authCheck`
* - .. _audit-message-authCheck:

``authCheck``

- .. code-block:: none
:copyable: false
Expand Down Expand Up @@ -189,7 +194,8 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`createDatabase`

* - ``createDatabase``

- .. code-block:: none
:copyable: false
Expand All @@ -213,7 +219,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`renameCollection`
* - ``renameCollection``

- .. code-block:: none
:copyable: false
Expand Down Expand Up @@ -295,7 +301,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`dropAllUsersFromDatabase`
* - ``dropAllUsersFromDatabase``

- .. code-block:: none
:copyable: false
Expand All @@ -305,7 +311,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`updateUser`
* - ``updateUser``

- .. code-block:: none
:copyable: false
Expand All @@ -329,7 +335,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`grantRolesToUser`
* - ``grantRolesToUser``

- .. code-block:: none
:copyable: false
Expand All @@ -349,7 +355,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`revokeRolesFromUser`
* - ``revokeRolesFromUser``

- .. code-block:: none
:copyable: false
Expand Down Expand Up @@ -401,7 +407,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`updateRole`
* - ``updateRole``

- .. code-block:: none
:copyable: false
Expand Down Expand Up @@ -446,7 +452,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`dropAllRolesFromDatabase`
* - ``dropAllRolesFromDatabase``

- .. code-block:: none
:copyable: false
Expand All @@ -456,7 +462,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`grantRolesToRole`
* - ``grantRolesToRole``

- .. code-block:: none
:copyable: false
Expand All @@ -476,7 +482,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`revokeRolesFromRole`
* - ``revokeRolesFromRole``

- .. code-block:: none
:copyable: false
Expand All @@ -496,7 +502,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`grantPrivilegesToRole`
* - ``grantPrivilegesToRole``

- .. code-block:: none
:copyable: false
Expand All @@ -519,7 +525,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`revokePrivilegesFromRole`
* - ``revokePrivilegesFromRole``

- .. code-block:: none
:copyable: false
Expand Down Expand Up @@ -579,7 +585,7 @@ associated ``param`` details and the ``result`` values, if any.

- ``0`` - Success

* - :authaction:`shardCollection`
* - ``shardCollection``

- .. code-block:: none
:copyable: false
Expand Down
7 changes: 0 additions & 7 deletions source/reference/built-in-roles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -246,19 +246,15 @@ Cluster Administration Roles
- :authaction:`cleanupOrphaned`
- :authaction:`flushRouterConfig`
- :authaction:`getDefaultRWConcern` (New in version 4.4)

- :authaction:`listSessions` (New in version 3.6)

- :authaction:`listShards`
- :authaction:`removeShard`
- :authaction:`replSetConfigure`
- :authaction:`replSetGetConfig`
- :authaction:`replSetGetStatus`
- :authaction:`replSetStateChange`
- :authaction:`resync`

- :authaction:`setDefaultRWConcern` (New in version 4.4)

- :authaction:`setFeatureCompatibilityVersion`
- :authaction:`setFreeMonitoring`

Expand Down Expand Up @@ -398,16 +394,13 @@ Cluster Administration Roles
- :authaction:`hostInfo`
- :authaction:`inprog`
- :authaction:`listDatabases`

- :authaction:`listSessions` (New in version 3.6)

- :authaction:`listShards`
- :authaction:`netstat`
- :authaction:`replSetGetConfig`
- :authaction:`replSetGetStatus`
- :authaction:`serverStatus`
- :authaction:`setFreeMonitoring` (New in version 4.0)

- :authaction:`shardingState`
- :authaction:`top`

Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/mapReduce.txt
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ collection <mapreduce-out-mtd>`:

- :authaction:`find`,
- :authaction:`insert`,
- :authaction:`replace`
- :authaction:`remove`

Map-reduce with the ``merge`` or ``reduce`` actions when
:ref:`outputting to a collection <mapreduce-out-mtd>`:
Expand Down
12 changes: 12 additions & 0 deletions source/reference/privilege-actions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,13 @@ Database Management Actions
User can kill **any** cursor, even cursors created by other users.
Apply this action to collection resources.

.. authaction:: planCacheIndexFilter

User can run the :dbcommand:`planCacheClearFilters`,
:dbcommand:`planCacheListFilters`, and
:dbcommand:`planCacheSetFilter` commands. Apply the
:authaction:`planCacheIndexFilter` action to collection resources.

.. authaction:: revokeRole

User can remove any role from any user from any database in the system.
Expand Down Expand Up @@ -302,6 +309,11 @@ Database Management Actions

Apply this action to database resources.

.. authaction:: setFeatureCompatibilityVersion

User can run the :dbcommand:`setFeatureCompatibilityVersion` command.
Apply this action to the ``cluster`` resource.

.. authaction:: unlock

User can perform the :method:`db.fsyncUnlock()` method. Apply this
Expand Down
4 changes: 3 additions & 1 deletion source/reference/program/mongo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,9 @@ Core Options
Specifies a JavaScript file to run and then exit. Generally this should
be the last option specified.

.. optional:: To specify a JavaScript file to execute *and* allow
.. note:: Optional

To specify a JavaScript file to execute *and* allow
:program:`mongo` to prompt you for a password using
:option:`--password`, pass the filename as the first parameter with
:option:`--username` and :option:`--password` as the last options, as
Expand Down
4 changes: 2 additions & 2 deletions source/release-notes/2.4-upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ operations.
:term:`sharded cluster`, as described in
:ref:`sharding-balancing-disable-temporarily`.

.. optional::
.. note:: Optional

For additional security during the upgrade, you can make a
backup of the config database using :binary:`~bin.mongodump` or
Expand Down Expand Up @@ -265,7 +265,7 @@ operations.
require manual intervention. To continue the upgrade process, you
must follow the :ref:`upgrade-cluster-resync` procedure.

.. optional::
.. note:: Optional

If the :binary:`~bin.mongos` logs show the upgrade waiting for the
upgrade lock, a previous upgrade process may still be active or
Expand Down
4 changes: 3 additions & 1 deletion source/tutorial/add-shards-to-shard-cluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ instance.
name of the replica set and specify a member of the set. In
production deployments, all shards should be replica sets.

.. optional:: You can instead use the :dbcommand:`addShard` database
.. note:: Optional

You can instead use the :dbcommand:`addShard` database
command, which lets you specify a name and maximum size for the
shard. If you do not specify these, MongoDB automatically assigns
a name and maximum size. To use the database command, see
Expand Down
16 changes: 8 additions & 8 deletions source/tutorial/configure-audit-filters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,8 @@ that occur against the ``test`` database by using the filter:
path: data/db/auditLog.bson
filter: '{ atype: "authenticate", "param.db": "test" }'

To filter on all :authaction:`authenticate` operations across
databases, use the filter ``{ atype: "authenticate" }``.
To filter on all ``authenticate`` operations across databases, omit
``"param.db": "test"`` and use the filter ``{ atype: "authenticate" }``.

Filter on Collection Creation and Drop Operations for a Single Database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -212,9 +212,9 @@ with roles that inherit from :authrole:`readWrite`, by using the filter:
Filter on Read and Write Operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To capture :authaction:`read` and :authaction:`write` operations in the
audit, you must also enable the audit system to log authorization
successes using the :parameter:`auditAuthorizationSuccess` parameter.
To capture read and write operations in the audit, you must also
enable the audit system to log authorization successes using the
:parameter:`auditAuthorizationSuccess` parameter.
[#authorization-agnostic]_

.. note::
Expand Down Expand Up @@ -257,9 +257,9 @@ The following example audits the :method:`~db.collection.find()`,
Filter on Read and Write Operations for a Collection
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To capture :authaction:`read` and :authaction:`write` operations in the
audit, you must also enable the audit system to log authorization
successes using the :parameter:`auditAuthorizationSuccess` parameter.
To capture read and write operations in the audit, you must also
enable the audit system to log authorization successes using the
:parameter:`auditAuthorizationSuccess` parameter.
[#authorization-agnostic]_

.. note::
Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/configure-linux-iptables-firewall.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ port ``27017``, which allows the application server to connect to the
:binary:`~bin.mongod` instance. The second rule, allows outgoing traffic
from the :binary:`~bin.mongod` to reach the application server.

.. optional::
.. note:: Optional

If you have only one application server, you can replace
``<ip-address>`` with either the IP address itself, such as:
Expand Down
8 changes: 6 additions & 2 deletions source/tutorial/convert-secondary-into-arbiter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ Convert Secondary to Arbiter and Reuse the Port Number

mv /data/db /data/db-old

.. optional:: You may remove the data instead.
.. note:: Optional

You may remove the data instead.

#. Create a new, empty data directory to point to when restarting the
:binary:`~bin.mongod` instance. You can reuse the previous name. For
Expand Down Expand Up @@ -176,4 +178,6 @@ Convert Secondary to Arbiter Running on a New Port Number

mv /data/db /data/db-old

.. optional:: You may remove the data instead.
.. note:: Optional

You may remove the data instead.
2 changes: 1 addition & 1 deletion source/tutorial/expand-replica-set.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Add a Member to an Existing Replica Set
For more information on configuration options, see the
:binary:`~bin.mongod` manual page.

.. optional::
.. note:: Optional

You can specify the data directory, replica set name, and the ip
binding in the ``mongod.conf`` :doc:`configuration file
Expand Down
Loading