diff --git a/source/about.txt b/source/about.txt index 08b18aab290..5534d3c6bc4 100644 --- a/source/about.txt +++ b/source/about.txt @@ -27,7 +27,7 @@ Attribution-NonCommercial-ShareAlike 3.0 United States License |copy| MongoDB, Inc. 2008-|year| Man Pages --------- +--------- In addition to the `MongoDB Manual `_, you can access the :manual:`MongoDB Man Pages `, diff --git a/source/administration/security-checklist.txt b/source/administration/security-checklist.txt index c91b13b0829..ca80a61a474 100644 --- a/source/administration/security-checklist.txt +++ b/source/administration/security-checklist.txt @@ -26,15 +26,17 @@ Pre-production Checklist/Considerations requires that all clients and servers provide valid credentials before they can connect to the system. -See also: + | -- :doc:`/core/authentication` -- :doc:`/tutorial/enable-authentication` + See also: + + - :doc:`/core/authentication` + - :doc:`/tutorial/enable-authentication` .. _security-checklist-role-based-access-control: -Configure Role-Based Access Control -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +|arrow| Configure Role-Based Access Control +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Create a user administrator **first**, then create additional users. Create a unique MongoDB user for each person/application @@ -45,16 +47,19 @@ Configure Role-Based Access Control users and assign them only the roles they need to perform their operations. A user can be a person or a client application. - Note that a user can have privileges across different databases. If a - user requires privileges on multiple databases, create a - single user with roles that grant applicable database - privileges instead of creating the user multiple times in - different databases. + .. note:: + + A user can have privileges across different databases. If a user + requires privileges on multiple databases, create a single user + with roles that grant applicable database privileges instead of + creating the user multiple times in different databases. + + | -See also: + See also: -- :doc:`/core/authorization` -- :doc:`/tutorial/manage-users-and-roles` + - :doc:`/core/authorization` + - :doc:`/tutorial/manage-users-and-roles` |arrow| Encrypt Communication (TLS/SSL) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -71,7 +76,9 @@ See also: .. include:: /includes/fact-tls-1.0.rst -See also: :doc:`/tutorial/configure-ssl`. + | + + See also: :doc:`/tutorial/configure-ssl`. .. |binary| replace:: MongoDB @@ -108,19 +115,21 @@ See also: :doc:`/tutorial/configure-ssl`. .. include:: /includes/fact-default-bind-ip-change.rst -See also: + | -- :doc:`/core/security-hardening` + See also: -- the :setting:`net.bindIp` configuration setting - -- the :setting:`security.clusterIpSourceWhitelist` configuration - setting + - :doc:`/core/security-hardening` -- the :ref:`authenticationRestrictions - ` field to the - :dbcommand:`db.createUser()` command to specify a per-user IP - whitelist. + - the :setting:`net.bindIp` configuration setting + + - the :setting:`security.clusterIpSourceWhitelist` configuration + setting + + - the :ref:`authenticationRestrictions + ` field to the + :method:`db.createUser()` command to specify a per-user IP + whitelist. |arrow| Audit System Activity @@ -136,11 +145,13 @@ See also: up filters to record specific events, such as authentication events. -See also: + | + + See also: -- :doc:`/core/auditing` + - :doc:`/core/auditing` -- :doc:`/tutorial/configure-auditing` + - :doc:`/tutorial/configure-auditing` |arrow| Run MongoDB with a Dedicated User ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -149,7 +160,9 @@ See also: account. Ensure that the account has permissions to access data but no unnecessary permissions. -See also: :doc:`/installation` + | + + See also: :doc:`/installation` .. _security-checklist-javascript: @@ -168,7 +181,9 @@ See also: :doc:`/installation` This ensures that all documents stored by the :binary:`~bin.mongod` instance are valid :term:`BSON`. -See also: :doc:`/core/security-hardening` + | + + See also: :doc:`/core/security-hardening` |arrow| Request a Security Technical Implementation Guide (where applicable) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/changeStreams.txt b/source/changeStreams.txt index 763c4d0cd1f..ad38d33245a 100644 --- a/source/changeStreams.txt +++ b/source/changeStreams.txt @@ -118,6 +118,15 @@ The following example opens a change stream for a collection and iterates over the cursor to retrieve the change stream documents. [#start-time]_ +---------- + +.. |arrow| unicode:: U+27A4 + +|arrow| Use the **Select your language** drop-down menu in the +upper-right to set the language of the examples on this page. + +---------- + .. tabs-selector:: drivers .. tabs-drivers:: @@ -308,6 +317,13 @@ open, the cursor remains open until one of the following occurs: Modify Change Stream Output --------------------------- +---------- + +|arrow| Use the **Select your language** drop-down menu in the +upper-right to set the language of the examples on this page. + +---------- + .. tabs-drivers:: .. tab:: @@ -482,6 +498,13 @@ the update operation. However, you can configure the change stream to return the most current majority-committed version of the updated document. +---------- + +|arrow| Use the **Select your language** drop-down menu in the +upper-right to set the language of the examples on this page. + +---------- + .. tabs-drivers:: .. tab:: diff --git a/source/core/capped-collections.txt b/source/core/capped-collections.txt index ff02918349b..05d020fb3d7 100644 --- a/source/core/capped-collections.txt +++ b/source/core/capped-collections.txt @@ -116,8 +116,8 @@ Query Efficiency ~~~~~~~~~~~~~~~~ Use natural ordering to retrieve the most recently inserted elements -from the collection efficiently. This is (somewhat) analogous to tail -on a log file. +from the collection efficiently. This is similar to using the ``tail`` +command on a log file. Aggregation ``$out`` ~~~~~~~~~~~~~~~~~~~~ @@ -166,7 +166,9 @@ collection using the ``max`` field as in the following document: documents if a collection reaches the maximum size limit before it reaches the maximum document count. -.. see:: :method:`db.createCollection()` and :dbcommand:`create`. +.. see:: + + :method:`db.createCollection()` and :dbcommand:`create`. .. _capped-collections-options: diff --git a/source/core/map-reduce-concurrency.txt b/source/core/map-reduce-concurrency.txt index 619e2791fa7..4e881c26f76 100644 --- a/source/core/map-reduce-concurrency.txt +++ b/source/core/map-reduce-concurrency.txt @@ -10,8 +10,7 @@ Map-Reduce Concurrency :depth: 1 :class: singlecol -.. admonition:: Aggregation Pipeline as an Alternative to Map-Reduce - :class: note +.. note:: Aggregation Pipeline as an Alternative to Map-Reduce .. include:: /includes/fact-use-aggregation-not-map-reduce.rst diff --git a/source/core/map-reduce-sharded-collections.txt b/source/core/map-reduce-sharded-collections.txt index 4bf5c0027e5..b725f6bed63 100644 --- a/source/core/map-reduce-sharded-collections.txt +++ b/source/core/map-reduce-sharded-collections.txt @@ -10,8 +10,7 @@ Map-Reduce and Sharded Collections :depth: 1 :class: singlecol -.. admonition:: Aggregation Pipeline as an Alternative to Map-Reduce - :class: note +.. note:: Aggregation Pipeline as an Alternative to Map-Reduce .. include:: /includes/fact-use-aggregation-not-map-reduce.rst diff --git a/source/core/read-isolation-consistency-recency.txt b/source/core/read-isolation-consistency-recency.txt index 8446144380c..2f604d9e12e 100644 --- a/source/core/read-isolation-consistency-recency.txt +++ b/source/core/read-isolation-consistency-recency.txt @@ -279,7 +279,7 @@ upper-right to set the language of this example. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. tabs-drivers:: diff --git a/source/core/replica-set-high-availability.txt b/source/core/replica-set-high-availability.txt index 3a98232a650..955b1484455 100644 --- a/source/core/replica-set-high-availability.txt +++ b/source/core/replica-set-high-availability.txt @@ -1,4 +1,3 @@ -: replica set; failover .. _replica-set-failover-administration: .. _replica-set-failover: .. _failover: diff --git a/source/core/replica-set-rollbacks.txt b/source/core/replica-set-rollbacks.txt index a7b9ad6c5c3..e1423df63dc 100644 --- a/source/core/replica-set-rollbacks.txt +++ b/source/core/replica-set-rollbacks.txt @@ -1,7 +1,3 @@ - - single: replica set; rollbacks - single: consistency; rollbacks - .. _replica-set-rollbacks: .. _replica-set-rollback: @@ -58,7 +54,6 @@ By default, when a rollback occurs, MongoDB writes the rollback data to :term:`BSON` files. .. note:: Rollback Directory Change - Starting in Mongo 4.4, the rollback directory for a collection is named after the collection's UUID rather than the collection namespace. diff --git a/source/core/security-client-side-encryption.txt b/source/core/security-client-side-encryption.txt index 1d73eec9274..5facf6c0e0c 100644 --- a/source/core/security-client-side-encryption.txt +++ b/source/core/security-client-side-encryption.txt @@ -413,7 +413,7 @@ the following official 4.2-compatible driver versions: - Supported Versions - Quickstarts / Tutorials - * - :driverecosystem:`Node ` + * - :driver:`Node ` - ``3.4.0+`` - | `Node.js Quickstart `__ | :driver:`Client-Side Field Level Encryption Guide ` diff --git a/source/core/sharding-shard-key.txt b/source/core/sharding-shard-key.txt index c7313681c5e..e8716f54198 100644 --- a/source/core/sharding-shard-key.txt +++ b/source/core/sharding-shard-key.txt @@ -1,6 +1,3 @@ - - single: sharding; shard key - .. _sharding-shard-key: .. _shard-key: .. _sharding-internals-shard-keys: @@ -11,8 +8,6 @@ Shard Keys .. default-domain:: mongodb - - .. contents:: On this page :local: :backlinks: none diff --git a/source/core/transactions-in-applications.txt b/source/core/transactions-in-applications.txt index 8393cd15028..37e65fe2c26 100644 --- a/source/core/transactions-in-applications.txt +++ b/source/core/transactions-in-applications.txt @@ -7,8 +7,6 @@ Drivers API .. default-domain:: mongodb - - .. contents:: On this page :local: :backlinks: none @@ -62,7 +60,7 @@ upper-right to set the language of the examples on this page. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. tabs-drivers:: @@ -353,8 +351,6 @@ upper-right to set the language of the examples on this page. The following example incorporates logic to retry the transaction for transient errors and retry the commit for unknown commit error: -.. tabs-pillstrip:: languages - .. include:: /includes/driver-examples/driver-example-transactions-retry-3.rst Driver Versions diff --git a/source/core/transactions.txt b/source/core/transactions.txt index c37e0839090..2b0a5d57213 100644 --- a/source/core/transactions.txt +++ b/source/core/transactions.txt @@ -31,8 +31,6 @@ databases, documents, and shards. Transactions API ---------------- -This example highlights the key components of the transactions API. - ---------- .. |arrow| unicode:: U+27A4 @@ -42,7 +40,9 @@ upper-right to set the language of the following example. ---------- -.. tabs-pillstrip:: languages +This example highlights the key components of the transactions API. + +.. tabs-selector:: drivers .. tabs-drivers:: diff --git a/source/core/wiredtiger.txt b/source/core/wiredtiger.txt index 9a48ac82bf4..5438182a7f0 100644 --- a/source/core/wiredtiger.txt +++ b/source/core/wiredtiger.txt @@ -1,4 +1,5 @@ .. _storage-wiredtiger: +.. _storage-wiredTiger: ========================= WiredTiger Storage Engine diff --git a/source/faq/concurrency.txt b/source/faq/concurrency.txt index a3d25dd5d91..93e03824e89 100644 --- a/source/faq/concurrency.txt +++ b/source/faq/concurrency.txt @@ -244,7 +244,7 @@ following locks depending on the version of MongoDB: - MongoDB 4.0.X and previous - * - :dbcommand:`renameCollection` + * - :dbcommand:`renameCollection` database command - If renaming a collection within the same database, the :dbcommand:`renameCollection` command takes an exclusive (W) lock @@ -270,7 +270,7 @@ following locks depending on the version of MongoDB: the same database. - * - :method:`~db.collection.renameCollection()` + * - :method:`~db.collection.renameCollection()` shell helper method - If renaming a collection within the same database, the :method:`~db.collection.renameCollection()` method takes an @@ -333,7 +333,7 @@ the collection level: Prior to MongoDB 4.2, the operation takes an exclusive (W) lock on the database when renaming within the same database. - - For :dbcommand:`renameCollection` *only*:: If the target namespace + - For :dbcommand:`renameCollection` *only*: If the target namespace is in a different database as the source collection, the locking behavior is version dependent: diff --git a/source/faq/replica-sets.txt b/source/faq/replica-sets.txt index b2e9389ca54..0f8a1f0598a 100644 --- a/source/faq/replica-sets.txt +++ b/source/faq/replica-sets.txt @@ -95,9 +95,7 @@ networks. .. see:: - The overview of - :ref:`Arbiter Members of Replica Sets - `. + :ref:`Arbiter Members of Replica Sets ` Is it normal for replica set members to use different amounts of disk space? ---------------------------------------------------------------------------- diff --git a/source/includes/changelogs/releases/4.0.22.rst b/source/includes/changelogs/releases/4.0.22.rst index fca0abd1aed..d78a605e172 100644 --- a/source/includes/changelogs/releases/4.0.22.rst +++ b/source/includes/changelogs/releases/4.0.22.rst @@ -7,7 +7,7 @@ Sharding ~~~~~~~~ - :issue:`SERVER-36739` Use the mongos_manual_intervention_action hook in concurrency stepdown suites -- :issue:`SERVER-41192` Add a metric for the size of the SessionCatalog under `logicalSessionRecordCache` +- :issue:`SERVER-41192` Add a metric for the size of the SessionCatalog under ``logicalSessionRecordCache`` - :issue:`SERVER-42632` Disable pinger threads that reach out to config server to make integration tests pass - :issue:`SERVER-46393` Always check client last operation time when computing operationTime to append to the response - :issue:`SERVER-48679` flushRoutingTableCacheUpdates should block on critical section with kWrite, not kRead diff --git a/source/includes/changelogs/releases/4.0.23.rst b/source/includes/changelogs/releases/4.0.23.rst index b755c47c76f..d9a8c6cab06 100644 --- a/source/includes/changelogs/releases/4.0.23.rst +++ b/source/includes/changelogs/releases/4.0.23.rst @@ -7,7 +7,7 @@ Sharding ~~~~~~~~ - :issue:`SERVER-50305` ARS::next() does not respect OperationContext deadline -- :issue:`SERVER-53274` The force-write of the `history` field to all chunks on FCV upgrade from 3.6 to 4.0 is unnecessary +- :issue:`SERVER-53274` The force-write of the ``history`` field to all chunks on FCV upgrade from 3.6 to 4.0 is unnecessary Replication ~~~~~~~~~~~ diff --git a/source/includes/extracts-4.2-downgrade-fcv.yaml b/source/includes/extracts-4.2-downgrade-fcv.yaml index dc705384320..baed4049ffe 100644 --- a/source/includes/extracts-4.2-downgrade-fcv.yaml +++ b/source/includes/extracts-4.2-downgrade-fcv.yaml @@ -34,7 +34,11 @@ content: | { name: } } - .. see:: :method:`db.collection.dropIndex()` and :method:`db.collection.createIndex()` + .. see:: + + - :method:`db.collection.dropIndex()` + - :method:`db.collection.createIndex()` + --- ref: 4.2-downgrade-fcv-unique-index content: | diff --git a/source/includes/extracts-4.4-changes.yaml b/source/includes/extracts-4.4-changes.yaml index bfc07bc96ec..acfbd80600a 100644 --- a/source/includes/extracts-4.4-changes.yaml +++ b/source/includes/extracts-4.4-changes.yaml @@ -144,9 +144,10 @@ content: | ref: 4.4-changes-projection-sort-meta-list content: | - - Starting in MongoDB 4.4, you can specify the :projection:`{ $meta: - "textScore" } <$meta>` expression in the :method:`~cursor.sort()` - without also specifying the expression in the projection. For example, + - Starting in MongoDB 4.4, you can specify the + :projection:`{ $meta: "textScore" } <$meta>` expression in the + :method:`~cursor.sort()` without also specifying the expression in + the projection. For example, .. code-block:: javascript diff --git a/source/includes/fact-selinux-redhat-options.rst b/source/includes/fact-selinux-redhat-options.rst index b3a0cfcb395..eef954e9386 100644 --- a/source/includes/fact-selinux-redhat-options.rst +++ b/source/includes/fact-selinux-redhat-options.rst @@ -52,46 +52,44 @@ SELinux set to ``enforcing``. Permit Access to ``netstat`` for FTDC +++++++++++++++++++++++++++++++++++++ -.. container:: - - The current SELinux Policy does not allow the MongoDB process to open - and read ``/proc/net/netstat``, which is required for - :ref:`Full Time Diagnostic Data Capture (FTDC) `. - If you intend to run SELinux in - ``enforcing`` mode, you will need to make the following adjustment - to your SELinux policy: +The current SELinux Policy does not allow the MongoDB process to open +and read ``/proc/net/netstat``, which is required for +:ref:`Full Time Diagnostic Data Capture (FTDC) `. +If you intend to run SELinux in +``enforcing`` mode, you will need to make the following adjustment +to your SELinux policy: - #. Ensure your system has the ``checkpolicy`` package installed: +#. Ensure your system has the ``checkpolicy`` package installed: - .. code-block:: sh + .. code-block:: sh - sudo yum install checkpolicy + sudo yum install checkpolicy - #. Create a custom policy file :file:`mongodb_proc_net.te`: +#. Create a custom policy file :file:`mongodb_proc_net.te`: - .. code-block:: sh + .. code-block:: sh - cat > mongodb_proc_net.te < mongodb_proc_net.te <` (``/etc/mongod.conf``). You can use the initialization script to start :binary:`~bin.mongod` - with the configuration file. For details, see `Run MongoDB - Community Edition`_. + with the configuration file. For details, see the "Run MongoDB + Community Edition" section, above. * - ``{+package-name-org+}-mongos`` - Contains the :binary:`~bin.mongos` daemon. diff --git a/source/includes/steps-shard-a-collection-ranged.yaml b/source/includes/steps-shard-a-collection-ranged.yaml index a95172a0294..1626bbf346b 100644 --- a/source/includes/steps-shard-a-collection-ranged.yaml +++ b/source/includes/steps-shard-a-collection-ranged.yaml @@ -59,7 +59,7 @@ ref: select-shard-key pre: | Determine your :term:`shard key`. Your selection of shard key affects the efficiency of sharding. See the selection considerations listed under - :doc:`/tutorial/choose-a-shard-key` + :ref:`sharding-shard-key-selection` .. warning:: You cannot change a shard key once you have enabled sharding diff --git a/source/index.txt b/source/index.txt index 4eadf2d43c7..eff202b2a62 100644 --- a/source/index.txt +++ b/source/index.txt @@ -45,13 +45,22 @@ Getting Started MongoDB provides a :gettingstarted:`Getting Started Guide ` in the following editions. -- :doc:`mongo Shell Edition ` -- `Node.JS Edition `_ -- :api:`Python Edition ` -- `C++ Edition `_ -- `Java Edition `_ -- `C# Edition `_ -- `Ruby Edition `_ +.. list-table:: + :class: index-table + + * - :doc:`mongo Shell Edition ` + + `Node.JS Edition `_ + + - :api:`Python Edition ` + + `C++ Edition `_ + + - `Java Edition `_ + + `C# Edition `_ + + - `Ruby Edition `_ Once you complete the Getting Started Guide, you may find the following topics useful. @@ -149,7 +158,7 @@ Licensing The manual is licensed under a `Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License -`_ +`_. For information on MongoDB licensing, see `MongoDB Licensing `_. @@ -158,7 +167,6 @@ For information on MongoDB licensing, see `MongoDB Licensing Additional Resources -------------------- - `MongoDB, Inc.`_ The company behind MongoDB. diff --git a/source/indexes.txt b/source/indexes.txt index 889c114ea59..2d3458a1b5e 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -31,10 +31,6 @@ database systems. MongoDB defines indexes at the :term:`collection` level and supports indexes on any field or sub-field of the documents in a MongoDB collection. - - - - .. _index-type-id: Default ``_id`` Index @@ -57,6 +53,17 @@ this index on the ``_id`` field. Create an Index --------------- +---------- + +.. |arrow| unicode:: U+27A4 + +|arrow| Use the **Select your language** drop-down menu in the +upper-right to set the language of the examples on this page. + +---------- + +.. tabs-selector:: drivers + .. include:: /includes/driver-examples/driver-example-indexes-1.rst .. [#b-tree] MongoDB indexes use a B-tree data structure. @@ -272,6 +279,13 @@ Indexes and Collation .. include:: /includes/extracts/collation-versionadded.rst +---------- + +|arrow| Use the **Select your language** drop-down menu in the +upper-right to set the language of the examples on this page. + +---------- + .. include:: /includes/driver-examples/driver-example-indexes-2.rst .. include:: /includes/extracts/collation-index-use.rst diff --git a/source/reference/aggregation-commands-comparison.txt b/source/reference/aggregation-commands-comparison.txt index cd7c255abdd..2c04bc53d6b 100644 --- a/source/reference/aggregation-commands-comparison.txt +++ b/source/reference/aggregation-commands-comparison.txt @@ -10,8 +10,7 @@ Aggregation Commands Comparison :depth: 1 :class: singlecol -.. admonition:: Aggregation Pipeline as Alternative to Map-Reduce - :class: note +.. note:: Aggregation Pipeline as Alternative to Map-Reduce .. include:: /includes/fact-use-aggregation-not-map-reduce.rst diff --git a/source/reference/command/authenticate.txt b/source/reference/command/authenticate.txt index e11ec63a3f4..01503c8102a 100644 --- a/source/reference/command/authenticate.txt +++ b/source/reference/command/authenticate.txt @@ -31,8 +31,10 @@ authenticate db.auth( "username", "password" ) - .. see:: :method:`db.auth()` and :doc:`/security` - for more information. + .. see:: + + - :method:`db.auth()` + - :doc:`/security` Behavior -------- diff --git a/source/reference/command/delete.txt b/source/reference/command/delete.txt index aa888e604b1..e83250b27ae 100644 --- a/source/reference/command/delete.txt +++ b/source/reference/command/delete.txt @@ -212,7 +212,7 @@ BSON document size `. The total number of delete documents in the ``deletes`` array must be less than or equal to the :limit:`maximum bulk size -`. +`. Transactions ~~~~~~~~~~~~ diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index 1efcab23a48..aa65aea5f83 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -295,8 +295,9 @@ The command accepts the following fields: `. To use ``oplogReplay``, the ``find`` field must provide a ``filter`` - option comparing the ``ts`` document field to a :data:`timestamp` using - one of the following comparison operators: + option comparing the ``ts`` document field to a + :bsontype:`timestamp ` using one of the following + comparison operators: * :expression:`$gte` * :expression:`$gt` diff --git a/source/reference/command/insert.txt b/source/reference/command/insert.txt index 667ab30c969..ed2f154b96d 100644 --- a/source/reference/command/insert.txt +++ b/source/reference/command/insert.txt @@ -120,7 +120,8 @@ than or equal to the :limit:`maximum BSON document size `. The total number of documents in the ``documents`` array must be less -than or equal to the :limit:`maximum bulk size `. +than or equal to the :limit:`maximum bulk size +`. Document Validation ~~~~~~~~~~~~~~~~~~~ diff --git a/source/reference/command/mapReduce.txt b/source/reference/command/mapReduce.txt index 81d93ebe2ed..ad83ff5b21a 100644 --- a/source/reference/command/mapReduce.txt +++ b/source/reference/command/mapReduce.txt @@ -10,8 +10,7 @@ mapReduce :depth: 1 :class: singlecol -.. admonition:: Aggregation Pipeline as Alternative to Map-Reduce - :class: note +.. note:: Aggregation Pipeline as Alternative to Map-Reduce .. include:: /includes/fact-use-aggregation-not-map-reduce.rst @@ -408,6 +407,7 @@ For more information and examples, see the :doc:`/tutorial/perform-incremental-map-reduce`. .. _mapreduce-output: +.. _mapReduce-output: Output ------ diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt index c757c5dae88..ffff2ea7bb5 100644 --- a/source/reference/command/serverStatus.txt +++ b/source/reference/command/serverStatus.txt @@ -858,6 +858,7 @@ freeMonitoring The number of errors encountered when uploading metrics. +.. _globalLock: .. _globallock: .. _global-lock: .. _server-status-globallock: diff --git a/source/reference/command/update.txt b/source/reference/command/update.txt index 8fe8b110847..e7efb72e78b 100644 --- a/source/reference/command/update.txt +++ b/source/reference/command/update.txt @@ -395,7 +395,7 @@ to the :limit:`maximum BSON document size `. The total number of update statements in the ``updates`` array must be less than or equal to the :limit:`maximum bulk size -`. +`. Document Validation ~~~~~~~~~~~~~~~~~~~ diff --git a/source/reference/connection-string.txt b/source/reference/connection-string.txt index 0705fdaf28d..6e2c357560a 100644 --- a/source/reference/connection-string.txt +++ b/source/reference/connection-string.txt @@ -198,7 +198,6 @@ The standard URI connection string includes the following components: specify a slash (``/``) between the last ``host`` and the question mark (``?``) that begins the string of options. --seedlist .. _connections-dns-seedlist: DNS Seed List Connection Format diff --git a/source/reference/limits.txt b/source/reference/limits.txt index 29778e9572f..28986bcee03 100644 --- a/source/reference/limits.txt +++ b/source/reference/limits.txt @@ -380,7 +380,11 @@ Operations .. limit:: 2d Geospatial queries cannot use the $or operator - .. see:: :query:`$or` and :doc:`/core/geospatial-indexes`. + .. see:: + + - :query:`$or` + + - :doc:`/core/geospatial-indexes` .. limit:: Geospatial Queries diff --git a/source/reference/method/WriteResult.txt b/source/reference/method/WriteResult.txt index 53c1f3f9970..57410d9dc9a 100644 --- a/source/reference/method/WriteResult.txt +++ b/source/reference/method/WriteResult.txt @@ -18,9 +18,12 @@ Definition A wrapper that contains the result status of the :binary:`~bin.mongo` shell write methods. - .. see:: :method:`db.collection.insert()`, - :method:`db.collection.update()`, - :method:`db.collection.remove()`, and :method:`db.collection.save()`. + .. see:: + + - :method:`db.collection.insert()` + - :method:`db.collection.update()` + - :method:`db.collection.remove()` + - :method:`db.collection.save()` Properties ---------- diff --git a/source/reference/method/cursor.explain.txt b/source/reference/method/cursor.explain.txt index 2842aecf687..b2622aea871 100644 --- a/source/reference/method/cursor.explain.txt +++ b/source/reference/method/cursor.explain.txt @@ -91,10 +91,10 @@ verbosity mode. ``````````````````````` .. include:: /includes/fact-explain-verbosity-executionStats.rst - :end-before: .. start-explain-write + :end-before: start-explain-write .. include:: /includes/fact-explain-verbosity-executionStats.rst - :start-after: .. end-explain-write + :start-after: end-explain-write .. _explain-cursor-method-allPlansExecution: @@ -102,16 +102,15 @@ verbosity mode. `````````````````````````` .. include:: /includes/fact-explain-verbosity-allPlansExecution.rst - :end-before: .. start-explain-write + :end-before: start-explain-write .. include:: /includes/fact-explain-verbosity-allPlansExecution.rst - :start-after: .. end-explain-write + :start-after: end-explain-write ``db.collection.explain().find()`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: /includes/fact-explain-methods-differences.rst - :end-before: If run interactively See :method:`db.collection.explain()` for more information. diff --git a/source/reference/method/db.collection.mapReduce.txt b/source/reference/method/db.collection.mapReduce.txt index f9eb7119662..9d0ab049637 100644 --- a/source/reference/method/db.collection.mapReduce.txt +++ b/source/reference/method/db.collection.mapReduce.txt @@ -10,8 +10,7 @@ db.collection.mapReduce() :depth: 1 :class: singlecol -.. admonition:: Aggregation Pipeline as Alternative to Map-Reduce - :class: note +.. note:: Aggregation Pipeline as Alternative to Map-Reduce .. include:: /includes/fact-use-aggregation-not-map-reduce.rst diff --git a/source/reference/method/db.collection.update.txt b/source/reference/method/db.collection.update.txt index 5c7ea4c5c1d..6e8de24c5e1 100644 --- a/source/reference/method/db.collection.update.txt +++ b/source/reference/method/db.collection.update.txt @@ -1537,8 +1537,9 @@ inserted by the update, and the number of documents modified: .. see:: - :data:`WriteResult.nMatched`, :data:`WriteResult.nUpserted`, - :data:`WriteResult.nModified` + - :data:`WriteResult.nMatched` + - :data:`WriteResult.nUpserted` + - :data:`WriteResult.nModified` Write Concern Errors ~~~~~~~~~~~~~~~~~~~~ diff --git a/source/reference/method/db.killOp.txt b/source/reference/method/db.killOp.txt index fcb35ec295d..a0f2b19ac9d 100644 --- a/source/reference/method/db.killOp.txt +++ b/source/reference/method/db.killOp.txt @@ -21,7 +21,6 @@ Description The :method:`db.killOp()` method has the following parameter: - .. list-table:: :header-rows: 1 :widths: 20 20 80 @@ -99,7 +98,7 @@ Starting in MongoDB 4.0 .. seealso:: - The ``localOps`` parameter in :pipeline:`$currentOp`. + The ``localOps`` parameter in :pipeline:`$currentOp`. - id: mongod diff --git a/source/reference/operator/aggregation/meta.txt b/source/reference/operator/aggregation/meta.txt index 4d226e605b9..c6dca54c897 100644 --- a/source/reference/operator/aggregation/meta.txt +++ b/source/reference/operator/aggregation/meta.txt @@ -68,7 +68,7 @@ Usage In Projection - The ``{ $meta: "textScore" }`` expression can be a part of the :term:`projection` document to include the text score metadata. -- The :projection:`$meta` expression can be present in either an +- The :expression:`$meta` expression can be present in either an inclusion or an exclusion projection. - If you set the expression to a field name that already exists diff --git a/source/reference/operator/aggregation/redact.txt b/source/reference/operator/aggregation/redact.txt index ee37adc2551..8838c193fc8 100644 --- a/source/reference/operator/aggregation/redact.txt +++ b/source/reference/operator/aggregation/redact.txt @@ -27,9 +27,9 @@ Definition { $redact: } The argument can be any valid :ref:`expression - ` as long as it resolves to `$$DESCEND`_, - `$$PRUNE`_, or `$$KEEP`_ system variables. For more information on - expressions, see :ref:`aggregation-expressions`. + ` as long as it resolves to the + ``$$DESCEND``, ``$$PRUNE``, or ``$$KEEP`` system variables. For more + information on expressions, see :ref:`aggregation-expressions`. .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/set.txt b/source/reference/operator/aggregation/set.txt index 6902c781ceb..a3da7c741e6 100644 --- a/source/reference/operator/aggregation/set.txt +++ b/source/reference/operator/aggregation/set.txt @@ -13,7 +13,7 @@ $set (aggregation) Definition ---------- -.. topic:: Disambiguation +.. note:: Disambiguation The following page refers to the aggregation stage :pipeline:`$set`, available starting in MongoDB 4.2 For the diff --git a/source/reference/operator/aggregation/setEquals.txt b/source/reference/operator/aggregation/setEquals.txt index 43778c0a8e6..9942dfcbd40 100644 --- a/source/reference/operator/aggregation/setEquals.txt +++ b/source/reference/operator/aggregation/setEquals.txt @@ -35,7 +35,7 @@ Behavior .. |set-operator-name| replace:: :expression:`$setEquals` .. include:: /includes/important-set-operator-semantics.rst - :end-before: .. set-output + :end-before: set-output .. include:: /includes/extracts/fact-agg-top-level-expressions-setEquals.rst diff --git a/source/reference/operator/aggregation/setIsSubset.txt b/source/reference/operator/aggregation/setIsSubset.txt index 66e9b75bcb5..9b661a3886a 100644 --- a/source/reference/operator/aggregation/setIsSubset.txt +++ b/source/reference/operator/aggregation/setIsSubset.txt @@ -36,7 +36,7 @@ Behavior .. |set-operator-name| replace:: :expression:`$setIsSubset` .. include:: /includes/important-set-operator-semantics.rst - :end-before: .. set-output + :end-before: set-output .. include:: /includes/extracts/fact-agg-top-level-expressions-setIsSubset.rst diff --git a/source/reference/operator/aggregation/unset.txt b/source/reference/operator/aggregation/unset.txt index 4852f1da780..20d3de073de 100644 --- a/source/reference/operator/aggregation/unset.txt +++ b/source/reference/operator/aggregation/unset.txt @@ -13,7 +13,7 @@ $unset (aggregation) Definition ---------- -.. topic:: Disambiguation +.. note:: Disambiguation The following page refers to the aggregation stage :pipeline:`$unset`. For the update operator :update:`$unset`, see diff --git a/source/reference/operator/projection/positional.txt b/source/reference/operator/projection/positional.txt index 7d2b7333274..e8614f4373f 100644 --- a/source/reference/operator/projection/positional.txt +++ b/source/reference/operator/projection/positional.txt @@ -28,7 +28,7 @@ Definition See the aggregation operator :expression:`$filter` to return an array with only those elements that match the specified condition. - .. see:: Disambiguation + .. note:: Disambiguation To specify an array element to update, see the :doc:`positional $ operator for updates diff --git a/source/reference/operator/projection/slice.txt b/source/reference/operator/projection/slice.txt index 1c269f8a9e6..75431a0821e 100644 --- a/source/reference/operator/projection/slice.txt +++ b/source/reference/operator/projection/slice.txt @@ -18,7 +18,7 @@ Definition The :projection:`$slice` projection operator specifies the number of elements in an array to return in the query result. - .. see:: Disambiguation + .. note:: Disambiguation For information on limiting the size of an array during an update with :update:`$push`, see the :update:`$slice` modifier instead. diff --git a/source/reference/operator/query/rand.txt b/source/reference/operator/query/rand.txt index 961104aaffa..46c05c3e3ed 100644 --- a/source/reference/operator/query/rand.txt +++ b/source/reference/operator/query/rand.txt @@ -122,7 +122,7 @@ The intial match on the ``district`` field selects documents where the voter is from district 3. The :query:`$expr` operator uses ``$rand`` to further refine the -:dbcommand:`$find` operation. For each document, ``$rand`` generates a +:dbcommand:`find` operation. For each document, ``$rand`` generates a value between 0 and 1. The threshold of ``0.5`` means the less than :expression:`($lt)<$lt>` comparison will be true for about half the documents in the set. diff --git a/source/reference/operator/update/positional-all.txt b/source/reference/operator/update/positional-all.txt index 0a3a6b51b74..2d7152fb949 100644 --- a/source/reference/operator/update/positional-all.txt +++ b/source/reference/operator/update/positional-all.txt @@ -288,6 +288,6 @@ nested ``grades.questions`` array, regardless of ``type``: - :method:`db.collection.findAndModify()`, - - :query:`$elemMatch()` + - :query:`$elemMatch` .. |arrow| unicode:: U+27A4 diff --git a/source/reference/operator/update/positional-filtered.txt b/source/reference/operator/update/positional-filtered.txt index 22f5a5134b9..b65556a1567 100644 --- a/source/reference/operator/update/positional-filtered.txt +++ b/source/reference/operator/update/positional-filtered.txt @@ -456,6 +456,6 @@ nested ``grades.questions`` array, regardless of ``type``: - :method:`db.collection.findAndModify()`, - - :query:`$elemMatch()` + - :query:`$elemMatch` .. |arrow| unicode:: U+27A4 diff --git a/source/reference/operator/update/positional.txt b/source/reference/operator/update/positional.txt index cc161f7a2fa..53bd2d557b3 100644 --- a/source/reference/operator/update/positional.txt +++ b/source/reference/operator/update/positional.txt @@ -19,7 +19,7 @@ Definition an array to update without explicitly specifying the position of the element in the array. - .. see:: Disambiguation + .. note:: Disambiguation - To project, or return, an array element from a read operation, see the :projection:`$` projection operator instead. @@ -202,7 +202,7 @@ Update Embedded Documents Using Multiple Field Matches ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The :update:`$` operator can update the first array element that matches -multiple query criteria specified with the :query:`$elemMatch()` operator. +multiple query criteria specified with the :query:`$elemMatch` operator. Consider the following document in the ``students`` collection whose ``grades`` field value is an array of embedded documents: @@ -250,6 +250,6 @@ criteria, namely the second embedded document in the array: .. seealso:: - :method:`db.collection.update()`, - - :method:`db.collection.findAndModify()`, :query:`$elemMatch()` + - :method:`db.collection.update()` + - :method:`db.collection.findAndModify()` + - :query:`$elemMatch` diff --git a/source/reference/operator/update/set.txt b/source/reference/operator/update/set.txt index da594899a98..1f01b5a7287 100644 --- a/source/reference/operator/update/set.txt +++ b/source/reference/operator/update/set.txt @@ -13,7 +13,7 @@ $set Definition ---------- -.. topic:: Disambiguation +.. note:: Disambiguation The following page refers to the update operator :update:`$set`. For the aggregation stage :pipeline:`$set`, available starting in diff --git a/source/reference/operator/update/unset.txt b/source/reference/operator/update/unset.txt index 6eb20aa1231..b96d9d63daf 100644 --- a/source/reference/operator/update/unset.txt +++ b/source/reference/operator/update/unset.txt @@ -13,7 +13,7 @@ $unset Definition ---------- -.. topic:: Disambiguation +.. note:: Disambiguation The following page refers to the update operator :update:`$unset`. For the aggregation stage :pipeline:`$unset`, available starting in diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt index 68f174e6fcb..3638cb2e0f9 100644 --- a/source/reference/parameters.txt +++ b/source/reference/parameters.txt @@ -524,8 +524,9 @@ Authentication Parameters .. seealso:: + :parameter:`tlsMode` - :parameter:`tlsMode`.. parameter:: tlsMode +.. parameter:: tlsMode .. versionadded:: 4.2 @@ -549,8 +550,9 @@ Authentication Parameters .. seealso:: + :parameter:`sslMode` - :parameter:`sslMode`.. parameter:: tlsOCSPStaplingTimeoutSecs +.. parameter:: tlsOCSPStaplingTimeoutSecs .. versionadded:: 4.4 @@ -841,8 +843,9 @@ General Parameters .. seealso:: + :parameter:`connPoolMaxShardedConnsPerHost` - :parameter:`connPoolMaxShardedConnsPerHost`.. parameter:: shardedConnPoolIdleTimeoutMinutes +.. parameter:: shardedConnPoolIdleTimeoutMinutes .. versionadded:: 3.6.3 @@ -862,8 +865,9 @@ General Parameters .. seealso:: + :parameter:`connPoolMaxShardedConnsPerHost` - :parameter:`connPoolMaxShardedConnsPerHost`.. parameter:: connPoolMaxConnsPerHost +.. parameter:: connPoolMaxConnsPerHost *Default*: 200 @@ -911,8 +915,9 @@ General Parameters .. seealso:: + :parameter:`connPoolMaxConnsPerHost` - :parameter:`connPoolMaxConnsPerHost`.. parameter:: globalConnPoolIdleTimeoutMinutes +.. parameter:: globalConnPoolIdleTimeoutMinutes .. versionadded:: 3.6.3 @@ -933,8 +938,9 @@ General Parameters .. seealso:: + :parameter:`connPoolMaxShardedConnsPerHost` - :parameter:`connPoolMaxShardedConnsPerHost`.. parameter:: cursorTimeoutMillis +.. parameter:: cursorTimeoutMillis *Default*: 600000 (i.e. 10 minutes) @@ -1126,8 +1132,7 @@ General Parameters .. seealso:: - `RFC7413 `__. - + `RFC7413 `__. .. parameter:: tcpFastOpenClient @@ -1164,8 +1169,7 @@ General Parameters .. seealso:: - `RFC7413 `__. - + `RFC7413 `__. .. parameter:: tcpFastOpenQueueSize @@ -1617,8 +1621,7 @@ Logging Parameters .. seealso:: - :setting:`systemLog.quiet` - + :setting:`systemLog.quiet` .. parameter:: redactClientLogData @@ -1651,8 +1654,7 @@ Logging Parameters .. seealso:: - :setting:`security.redactClientLogData` - + :setting:`security.redactClientLogData` .. parameter:: traceExceptions @@ -1671,9 +1673,7 @@ Logging Parameters .. seealso:: - :setting:`systemLog.traceAllExceptions` - - + :setting:`systemLog.traceAllExceptions` .. parameter:: suppressNoTLSPeerCertificateWarning @@ -2018,8 +2018,9 @@ Logical Session .. seealso:: + :parameter:`localLogicalSessionTimeoutMinutes` - :parameter:`localLogicalSessionTimeoutMinutes`.. parameter:: enableFlowControl +.. parameter:: enableFlowControl .. versionadded:: 4.2 @@ -2514,7 +2515,6 @@ Sharding Parameters .. seealso:: - :parameter:`shardedIndexConsistencyCheckIntervalMS` parameter - - :serverstatus:`shardedIndexConsistency` metrics returned by the :dbcommand:`serverStatus` command. @@ -2546,7 +2546,6 @@ Sharding Parameters .. seealso:: - :parameter:`enableShardedIndexConsistencyCheck` parameter - - :serverstatus:`shardedIndexConsistency` metrics returned by the :dbcommand:`serverStatus` commandq @@ -2574,10 +2573,10 @@ Sharding Parameters mongod --setParameter enableFinerGrainedCatalogCacheRefresh=true mongos --setParameter enableFinerGrainedCatalogCacheRefresh=true - .. seealso:: + .. seealso:: - - - :serverstatus:`shardingStatistics.catalogCache` + - :ref:`sharding-background` + - :serverstatus:`shardingStatistics.catalogCache` .. parameter:: maxTimeMSForHedgedReads @@ -2614,7 +2613,6 @@ Sharding Parameters .. seealso:: - :parameter:`readHedgingMode` - - :ref:`mongos-hedged-reads` .. parameter:: readHedgingMode @@ -2669,10 +2667,12 @@ Sharding Parameters db.adminCommand( { setParameter: 1, readHedgingMode: "off" } ) - .. seealso:: - + .. seealso:: + + - :ref:`mongos-hedged-reads` + - :parameter:`maxTimeMSForHedgedReads` - .. parameter:: replMonitorMaxFailedChecks +.. parameter:: replMonitorMaxFailedChecks *Available in MongoDB 3.2 only* @@ -2805,8 +2805,9 @@ Sharding Parameters .. seealso:: + :parameter:`ShardingTaskExecutorPoolMinSize` - :parameter:`ShardingTaskExecutorPoolMinSize`.. parameter:: ShardingTaskExecutorPoolMinSize +.. parameter:: ShardingTaskExecutorPoolMinSize Type: integer @@ -2848,9 +2849,11 @@ Sharding Parameters :parameter:`taskExecutorPoolSize`. .. seealso:: + + - :parameter:`ShardingTaskExecutorPoolMaxSize` + - :parameter:`warmMinConnectionsInShardingTaskExecutorPoolOnStartup` - - - :parameter:`ShardingTaskExecutorPoolMaxSize`.. parameter:: ShardingTaskExecutorPoolRefreshRequirementMS +.. parameter:: ShardingTaskExecutorPoolRefreshRequirementMS Type: integer @@ -3018,7 +3021,6 @@ Sharding Parameters .. seealso:: - :parameter:`ShardingTaskExecutorPoolMaxSize` - - :parameter:`ShardingTaskExecutorPoolMinSize` .. parameter:: loadRoutingTableOnStartup @@ -3088,9 +3090,11 @@ Sharding Parameters :option:`--setParameter ` command line option. .. seealso:: + + - :parameter:`warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS` + - :parameter:`ShardingTaskExecutorPoolMinSize` - - - :parameter:`warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS`.. parameter:: warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS +.. parameter:: warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS .. versionadded:: 4.4 @@ -3113,9 +3117,11 @@ Sharding Parameters :option:`--setParameter ` command line option. .. seealso:: + + - :parameter:`warmMinConnectionsInShardingTaskExecutorPoolOnStartup` + - :parameter:`ShardingTaskExecutorPoolMinSize` - - - :parameter:`warmMinConnectionsInShardingTaskExecutorPoolOnStartup`.. parameter:: migrateCloneInsertionBatchDelayMS +.. parameter:: migrateCloneInsertionBatchDelayMS .. versionadded:: 4.0.5 @@ -3349,8 +3355,7 @@ Storage Parameters .. seealso:: - :setting:`storage.journal.commitIntervalMs` - + :setting:`storage.journal.commitIntervalMs` .. parameter:: syncdelay @@ -3371,8 +3376,8 @@ Storage Parameters .. seealso:: - - - :setting:`storage.syncPeriodSecs` + - :parameter:`journalCommitInterval` + - :setting:`storage.syncPeriodSecs` .. parameter:: honorSystemUmask @@ -3506,8 +3511,7 @@ WiredTiger Parameters .. seealso:: - :serverstatus:`wiredTiger.concurrentTransactions` - + :serverstatus:`wiredTiger.concurrentTransactions` .. parameter:: wiredTigerConcurrentWriteTransactions @@ -3524,8 +3528,7 @@ WiredTiger Parameters .. seealso:: - :serverstatus:`wiredTiger.concurrentTransactions` - + :serverstatus:`wiredTiger.concurrentTransactions` .. parameter:: wiredTigerEngineRuntimeConfig @@ -3583,10 +3586,11 @@ Auditing Parameters .. include:: /includes/fact-auditAuthorizationSuccess-performance-impact.rst -.. seealso:: + .. seealso:: + :dbcommand:`getParameter` - :dbcommand:`getParameter`.. parameter:: transactionLifetimeLimitSeconds +.. parameter:: transactionLifetimeLimitSeconds .. versionadded:: 4.0 diff --git a/source/reference/program/mongod.txt b/source/reference/program/mongod.txt index cf16817ab31..380c706bf83 100644 --- a/source/reference/program/mongod.txt +++ b/source/reference/program/mongod.txt @@ -776,7 +776,7 @@ Core Options .. seealso:: - :setting:`processManagement.timeZoneInfo`. + :setting:`processManagement.timeZoneInfo`. @@ -2440,7 +2440,7 @@ TLS Options .. seealso:: - :ref:`ssl-disallow-protocols` + :ref:`ssl-disallow-protocols` .. option:: --tlsFIPSMode @@ -2924,7 +2924,7 @@ SSL Options (Deprecated) .. seealso:: - :ref:`ssl-disallow-protocols` + :ref:`ssl-disallow-protocols` .. option:: --sslFIPSMode @@ -2971,7 +2971,7 @@ Profiler Options .. seealso:: - :doc:`/tutorial/manage-the-database-profiler` + :doc:`/tutorial/manage-the-database-profiler` .. _cli-mongod-profiler-slowOpSampleRate: @@ -3261,7 +3261,7 @@ Encryption Key Management Options .. seealso:: - :ref:`kmip-master-key-rotation` + :ref:`kmip-master-key-rotation` diff --git a/source/reference/program/mongos.txt b/source/reference/program/mongos.txt index 006eedc14e0..8a979a89135 100644 --- a/source/reference/program/mongos.txt +++ b/source/reference/program/mongos.txt @@ -726,8 +726,10 @@ Sharded Cluster Options TLS Options ~~~~~~~~~~~ -.. see:: :doc:`/tutorial/configure-ssl` for full - documentation of MongoDB's support. +.. see:: + + :doc:`/tutorial/configure-ssl` for full documentation of MongoDB's + support. .. option:: --tlsMode @@ -1106,7 +1108,7 @@ TLS Options .. seealso:: - :ref:`ssl-disallow-protocols` + :ref:`ssl-disallow-protocols` .. option:: --tlsFIPSMode @@ -1527,7 +1529,7 @@ SSL Options (Deprecated) .. seealso:: - :ref:`ssl-disallow-protocols` + :ref:`ssl-disallow-protocols` .. option:: --sslFIPSMode diff --git a/source/reference/sql-comparison.txt b/source/reference/sql-comparison.txt index dbf2d3f27ff..4371f59ee1a 100644 --- a/source/reference/sql-comparison.txt +++ b/source/reference/sql-comparison.txt @@ -764,22 +764,22 @@ reading records from tables and the corresponding MongoDB statements. For more information on the methods and operators used, see - - :method:`db.collection.find()` - - :method:`db.collection.distinct()` - - :method:`db.collection.findOne()` - - :method:`~cursor.limit()` - - :method:`~cursor.skip()` - - :method:`~cursor.explain()` - - :method:`~cursor.sort()` - - :method:`~cursor.count()` - - :query:`$ne` - - :query:`$and` - - :query:`$or` - - :query:`$gt` - - :query:`$lt` - - :query:`$exists` - - :query:`$lte` - - :query:`$regex` +- :method:`db.collection.find()` +- :method:`db.collection.distinct()` +- :method:`db.collection.findOne()` +- :method:`~cursor.limit()` +- :method:`~cursor.skip()` +- :method:`~cursor.explain()` +- :method:`~cursor.sort()` +- :method:`~cursor.count()` +- :query:`$ne` +- :query:`$and` +- :query:`$or` +- :query:`$gt` +- :query:`$lt` +- :query:`$exists` +- :query:`$lte` +- :query:`$regex` .. seealso:: diff --git a/source/release-notes/1.8.txt b/source/release-notes/1.8.txt index 6bba77aac8b..1871aaaa6c7 100644 --- a/source/release-notes/1.8.txt +++ b/source/release-notes/1.8.txt @@ -374,7 +374,7 @@ Additional Changes and Enhancements - Slave delay support for replica sets. -- :data:`~local.system.replset.settings.getLastErrorDefaults` for replica sets. +- ``local.system.replset.settings.getLastErrorDefaults`` for replica sets. - Auto completion in the shell. diff --git a/source/release-notes/2.4-upgrade.txt b/source/release-notes/2.4-upgrade.txt index 334fdaba8a9..ad7168cf8a3 100644 --- a/source/release-notes/2.4-upgrade.txt +++ b/source/release-notes/2.4-upgrade.txt @@ -35,10 +35,10 @@ When upgrading, consider the following: will need to upgrade first to 2.2.1 and then upgrade to 2.4. See :ref:`2.4-upgrade-auth-limitation`. -- If you have :data:`system.users <.system.users>` documents +- If you have :data:`system.users` documents (i.e. for :setting:`~security.authorization`) that you created before 2.4 you *must* ensure that there are no duplicate values for the ``user`` field in - the :data:`system.users <.system.users>` collection in + the :data:`system.users` collection in *any* database. If you *do* have documents with duplicate user fields, you must remove them before upgrading. diff --git a/source/release-notes/2.6-compatibility.txt b/source/release-notes/2.6-compatibility.txt index fbe7590b2fb..09cef3eb95e 100644 --- a/source/release-notes/2.6-compatibility.txt +++ b/source/release-notes/2.6-compatibility.txt @@ -24,7 +24,7 @@ Enforce Index Key Length Limit Description MongoDB 2.6 implements a stronger enforcement of the limit on - :limit:`index key `. + :limit:`index key `. Creating indexes will error if an index key in an existing document exceeds the limit: diff --git a/source/release-notes/2.6-upgrade.txt b/source/release-notes/2.6-upgrade.txt index 671007a93ac..3161a6a470a 100644 --- a/source/release-notes/2.6-upgrade.txt +++ b/source/release-notes/2.6-upgrade.txt @@ -89,7 +89,7 @@ authentication and authorization: the role :authrole:`userAdminAnyDatabase`. - If your application performs CRUD operations on the - :data:`.system.users` collection or uses a + :data:`system.users` collection or uses a ``db.addUser()``\ -like method, then you **must** upgrade those drivers (i.e. client libraries) **before** :binary:`~bin.mongod` or :binary:`~bin.mongos` instances. diff --git a/source/release-notes/3.0.txt b/source/release-notes/3.0.txt index c927a31389e..8a75f0d3efb 100644 --- a/source/release-notes/3.0.txt +++ b/source/release-notes/3.0.txt @@ -357,9 +357,8 @@ drivers. For more information, see .. seealso:: - :ref:`3.0-compatibility-touch`, :doc:`/core/wiredtiger` - - documentation + - :ref:`3.0-compatibility-touch` + - :doc:`/core/wiredtiger` documentation WiredTiger Configuration ```````````````````````` @@ -370,6 +369,7 @@ can set :ref:`WiredTiger options on the command line `. .. seealso:: + :doc:`/core/wiredtiger` WiredTiger Concurrency and Compression @@ -383,6 +383,7 @@ By default, WiredTiger compresses collection data using the compression` on all indexes by default. .. seealso:: + :ref:`prod-notes-wired-tiger-concurrency` section in the :doc:`/administration/production-notes`, the blog post `New Compression Options in MongoDB 3.0`_ @@ -441,7 +442,6 @@ allows in-place updates and removes when low on disk space. :ref:`3.0-compatiblity-record-alloc` - .. _3.0-replica-sets: Replica Sets @@ -515,7 +515,6 @@ Other Replica Set Operational Changes .. seealso:: :ref:`3.0-compatibility-rs` in - :doc:`/release-notes/3.0-compatibility` .. _3.0-sharded-clusters: @@ -550,7 +549,6 @@ MongoDB 3.0 provides the following enhancements to sharded clusters: .. seealso:: :ref:`3.0-compatibility-sharded-cluster` in - :doc:`/release-notes/3.0-compatibility` Security Improvements @@ -569,6 +567,7 @@ MongoDB 3.0 includes the following security enhancements: access MongoDB. For details, see :ref:`3.0-compatibility-localhost`. .. seealso:: + :ref:`3.0-compatibility-security-changes` Improvements @@ -660,6 +659,7 @@ Indexes :binary:`~bin.mongos` if the index includes the shard key. .. seealso:: + :ref:`3.0-compatibility-indexes` in :doc:`/release-notes/3.0-compatibility` @@ -705,6 +705,7 @@ MongoDB builds are available for Windows Server 2003 and Windows Vista version is Windows Server 2008. .. seealso:: + :ref:`3.0-compatibility-platform-support` Package Repositories @@ -762,5 +763,6 @@ To download MongoDB 3.0, go to the `downloads page`_. .. _`downloads page`: http://www.mongodb.org/downloads .. seealso:: - - `All Third Party License Notices `_. - - `All JIRA issues resolved in 3.0 `_. + + - `All Third Party License Notices `_ + - `All JIRA issues resolved in 3.0 `_ diff --git a/source/release-notes/3.2.txt b/source/release-notes/3.2.txt index 42dfedaf51a..e25c012dcb6 100644 --- a/source/release-notes/3.2.txt +++ b/source/release-notes/3.2.txt @@ -1395,5 +1395,6 @@ To download MongoDB 3.2, go to the `downloads page`_. .. _`downloads page`: http://www.mongodb.org/downloads .. seealso:: - - `All Third Party License Notices `_. - - `All JIRA issues resolved in 3.2 `_. + + - `All Third Party License Notices `_ + - `All JIRA issues resolved in 3.2 `_ diff --git a/source/release-notes/3.4-compatibility.txt b/source/release-notes/3.4-compatibility.txt index 66ef720e4e5..49b6eb5d151 100644 --- a/source/release-notes/3.4-compatibility.txt +++ b/source/release-notes/3.4-compatibility.txt @@ -76,8 +76,6 @@ MongoDB 3.4 manual :v3.4:`Upgrade Config Servers to Replica Set .. seealso:: - - :ref:`Sharded Cluster Release Notes Section <3.4-rel-notes-sharded-cluster>` .. _3.4-compatibility-initial-sync: diff --git a/source/release-notes/3.4.txt b/source/release-notes/3.4.txt index 6a650d50350..d452081b3fc 100644 --- a/source/release-notes/3.4.txt +++ b/source/release-notes/3.4.txt @@ -1131,6 +1131,7 @@ authentication for replica sets and sharded clusters. For details, see command line option for :binary:`~bin.mongod` and :binary:`~bin.mongos`. .. seealso:: + :doc:`/tutorial/enforce-keyfile-access-control-in-existing-replica-set-without-downtime` User Roles Changes @@ -1313,7 +1314,7 @@ To download the MongoDB 3.4, go to the `MongoDB Download Center .. seealso:: - - `All Third Party License Notices `_. + `All Third Party License Notices `_ .. toctree:: :titlesonly: diff --git a/source/release-notes/3.6.txt b/source/release-notes/3.6.txt index 2104da9c60e..42f6643b475 100644 --- a/source/release-notes/3.6.txt +++ b/source/release-notes/3.6.txt @@ -541,8 +541,7 @@ Additional Security Enhancements .. seealso:: - :ref:`3.6-compatibility-enabled` - + :ref:`3.6-compatibility-enabled` .. _3.6-rel-notes-aggregation: @@ -717,7 +716,7 @@ operations on arrays and nested arrays: Negative Array Index Position for ``push`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The :update:`$position` modifier for the :update:`push` update operator +The :update:`$position` modifier for the :update:`$push` update operator can accept a negative array index value to indicate a position starting from the end of the array. @@ -1126,7 +1125,7 @@ Read Concern .. seealso:: - :parameter:`orphanCleanupDelaySecs` + :parameter:`orphanCleanupDelaySecs` - Starting in MongoDB 3.6, MongoDB enables support for :v3.6:`"majority" ` read concern by @@ -1242,7 +1241,7 @@ Download Center .. seealso:: - - `All Third Party License Notices `_. + `All Third Party License Notices `_ .. _3.6.3-known-issues: diff --git a/source/release-notes/4.0-compatibility.txt b/source/release-notes/4.0-compatibility.txt index 0cf02c650d4..3d30d5ff844 100644 --- a/source/release-notes/4.0-compatibility.txt +++ b/source/release-notes/4.0-compatibility.txt @@ -350,7 +350,7 @@ Output Field Changes - :data:`replSetGetStatus.members[n].syncingTo` - Use :data:`replSetGetStatus.replSetGetStatus.syncSourceHost` and + Use :data:`replSetGetStatus.syncSourceHost` and :data:`replSetGetStatus.members[n].syncSourceHost` instead. - The :pipeline:`$currentOp` aggregation stage, the diff --git a/source/release-notes/4.0.txt b/source/release-notes/4.0.txt index e989e73e50a..557579762d8 100644 --- a/source/release-notes/4.0.txt +++ b/source/release-notes/4.0.txt @@ -720,7 +720,7 @@ Additional Improvements ``````````` The :pipeline:`$bucket` stage no longer requires ``boundaries`` -document arguments to be wrapped in :pipeline:`$literal`. +document arguments to be wrapped in :expression:`$literal`. .. _4.0-dateToString: @@ -1304,10 +1304,10 @@ support matrix. MongoDB Tools ------------- -:toolcommand:`mongoreplay play ` supports a new ``MONGOREPLAY_HOST`` -environment variable that specifies the MongoDB connection string when -running ``mongoreplay play``. The new environment vairable can be used -instead of the command-line ``--host`` option. +The :binary:`~bin.mongoreplay` ``play`` command supports a new +``MONGOREPLAY_HOST`` environment variable that specifies the MongoDB +connection string when running ``mongoreplay play``. The new environment +variable can be usedinstead of the command-line ``--host`` option. For example, to play back a recording to a :binary:`~bin.mongod` instance running with authentication at ``mongodb1.example.net:27017``, @@ -1505,7 +1505,7 @@ To download MongoDB 4.0, go to the `MongoDB Download Center .. seealso:: - - `All Third Party License Notices `_. + `All Third Party License Notices `_. .. _4.0.3-known-issues: diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index c0c246fe74a..2229e1a283d 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -173,8 +173,7 @@ The options for :pipeline:`$geoNear` are similar to the removed .. seealso:: - :ref:`4.2-compat-geoNear` - + :ref:`4.2-compat-geoNear` .. _4.2-compat-remove-repairDatabase: @@ -350,7 +349,6 @@ Instead, you can rewrite the aggregation to the following pipeline: :ref:`4.2-agg` - .. _4.2-compatibility-txn: Transactions @@ -381,7 +379,6 @@ Availability :ref:`4.2 Changes to Change Streams <4.2-change-stream>` - Default Collation ~~~~~~~~~~~~~~~~~ diff --git a/source/release-notes/4.2-downgrade-replica-set.txt b/source/release-notes/4.2-downgrade-replica-set.txt index 042a58b90cc..a4a0d2a0ba0 100644 --- a/source/release-notes/4.2-downgrade-replica-set.txt +++ b/source/release-notes/4.2-downgrade-replica-set.txt @@ -134,9 +134,7 @@ Script 2d. Remove ``user_1_db_1`` System Unique Index `````````````````````````````````````````````` -.. container:: - - .. include:: /includes/extracts/4.2-downgrade-fcv-system-unique-index.rst +.. include:: /includes/extracts/4.2-downgrade-fcv-system-unique-index.rst 2e. Remove Wildcard Indexes ```````````````````````````` diff --git a/source/release-notes/4.2-downgrade-standalone.txt b/source/release-notes/4.2-downgrade-standalone.txt index 1b9517c66a2..b1bd06e0cd3 100644 --- a/source/release-notes/4.2-downgrade-standalone.txt +++ b/source/release-notes/4.2-downgrade-standalone.txt @@ -96,9 +96,7 @@ Script 2d. Remove ``user_1_db_1`` System Unique Index `````````````````````````````````````````````` -.. container:: - - .. include:: /includes/extracts/4.2-downgrade-fcv-system-unique-index.rst +.. include:: /includes/extracts/4.2-downgrade-fcv-system-unique-index.rst 2e. Remove Wildcard Indexes ``````````````````````````` diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt index 02562fd4888..a3b42b81cfc 100644 --- a/source/release-notes/4.2.txt +++ b/source/release-notes/4.2.txt @@ -4,15 +4,12 @@ Release Notes for MongoDB 4.2 .. default-domain:: mongodb - - .. contents:: On this page :local: :backlinks: none :depth: 1 :class: twocols - Minor Releases -------------- @@ -381,7 +378,6 @@ For more information, see :doc:`/core/transactions`. :ref:`4.2 Transaction Compatibility Changes <4.2-compatibility-txn>` - Removed MMAPv1 Storage Engine ----------------------------- @@ -634,7 +630,6 @@ has always supported TLS 1.0 and later. :ref:`4.2-tlsclustercafile` - Deprecated ``SSL`` Options ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -693,7 +688,6 @@ handshake. :ref:`4.2-tls` - Forward Secrecy ~~~~~~~~~~~~~~~ @@ -990,8 +984,7 @@ MongoDB 4.2 adds the following new aggregation pipeline stages: .. seealso:: - :ref:`4.2-deprecated-plan-cache` - + :ref:`4.2-deprecated-plan-cache` * - :pipeline:`$replaceWith` @@ -1055,10 +1048,7 @@ See the individual reference pages for details and examples. .. seealso:: - - - :doc:`/tutorial/update-documents-with-aggregation-pipeline` - - :ref:`4.2-compat-agg` .. _4.2-change-stream: @@ -1106,7 +1096,6 @@ to modify the change stream output (i.e. the event documents): :ref:`Change Streams Compatibility Changes <4.2-compatibility-change-streams>` - Update Enhancements ------------------- @@ -1232,7 +1221,6 @@ For details on MongoDB extended JSON v2, see :ref:`4.2-compatibility-v2-query` - ``mongofiles`` ~~~~~~~~~~~~~~ @@ -1524,9 +1512,11 @@ the following output changes: - Added new fields: - - :serverstatus:`metrics.repl.network.notMasterLegacyUnacknowledgedWrites` + - :serverstatus:`metrics.repl.network.notMasterLegacyUnacknowledgedWrites + ` - - :serverstatus:`metrics.repl.network.notMasterUnacknowledgedWrites` + - :serverstatus:`metrics.repl.network.notMasterUnacknowledgedWrites + ` * - :serverstatus:`metrics.repl` - Added new :serverstatus:`metrics.repl.stepDown` metrics: @@ -1687,17 +1677,15 @@ applies. :ref:`4.2 Indexes Compatibility Changes <4.2-index-compat-changes>` - Remove Index Name Length Limit ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: /includes/extracts/4.2-changes-index-names.rst .. seealso:: - - :ref:`4.2 Indexes Compatibility Changes <4.2-index-compat-changes>`, - :ref:`4.2-compatibility-enabled` + - :ref:`4.2 Indexes Compatibility Changes <4.2-index-compat-changes>` + - :ref:`4.2-compatibility-enabled` Improvements to ``dropIndexes`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1778,7 +1766,7 @@ see :doc:`/core/query-plans`. .. seealso:: - :ref:`plan-cache-key` + :ref:`plan-cache-key` - The ``queryHash`` and ``planCacheKey`` are available in: @@ -2061,7 +2049,7 @@ To download MongoDB 4.2, go to the `MongoDB Download Center .. seealso:: - - `All Third Party License Notices `_. + `All Third Party License Notices `_. .. _4.2-known-issues: diff --git a/source/release-notes/4.4-compatibility.txt b/source/release-notes/4.4-compatibility.txt index 5789ba5ce25..fce1089a12f 100644 --- a/source/release-notes/4.4-compatibility.txt +++ b/source/release-notes/4.4-compatibility.txt @@ -250,7 +250,6 @@ functions has been deprecated since version 4.2.1. :ref:`4.4-compatibility-deprecations` - Structured Logging ------------------ diff --git a/source/release-notes/4.4.txt b/source/release-notes/4.4.txt index 087945eeb1e..231602d280c 100644 --- a/source/release-notes/4.4.txt +++ b/source/release-notes/4.4.txt @@ -576,7 +576,7 @@ Hedged Read Parameters `````````````````````` .. list-table:: - :widths: 20 80 + :widths: 40 60 :header-rows: 1 * - Parameter @@ -720,7 +720,8 @@ where the hashed field is the shard key prefix: .. seealso:: - :ref:`sharding-hashed-sharding` , :ref:`4.4-rel-notes-compound-hashed-index` + - :ref:`sharding-hashed-sharding` + - :ref:`4.4-rel-notes-compound-hashed-index` Chunk Migration Failover Resiliency Improvements @@ -868,7 +869,6 @@ For more information, see: :ref:`4.4-compatibility-projection-restrictions` - .. _4.4-rel-notes-projection-meta-keyword: .. _4.4-rel-notes-agg-meta-keyword: @@ -1032,7 +1032,7 @@ use of :setting:`system certificate store .. seealso:: - - :doc:`/core/security-transport-encryption` + :doc:`/core/security-transport-encryption` OCSP Stapling/Must Staple ````````````````````````` @@ -1456,7 +1456,7 @@ For more complete documentation, see: .. seealso:: - :ref:`index-operations`. + :ref:`index-operations` Deprecation of ``geoHaystack`` Index and ``geoSearch`` Command @@ -1598,10 +1598,8 @@ For more information on sorting and index use, see .. seealso:: - - - | :method:`cursor.allowDiskUse()` - | :limit:`Memory Limits on Sort Operations ` + - :method:`cursor.allowDiskUse()` + - :limit:`Memory Limits on Sort Operations ` ``find`` Can Use Temporary Files To Support Large Non-Indexed Sorts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1631,10 +1629,8 @@ for your preferred .. seealso:: - - - | :limit:`Memory Limits On Sort Operations ` - | :ref:`sort-index-use` + - :limit:`Memory Limits On Sort Operations ` + - :ref:`sort-index-use` Collection Namespace Limit ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1689,8 +1685,6 @@ set` and if set to ``false``, returned an error when run on a .. seealso:: - - :ref:`compact` ``mongod --repair`` Behavior Change @@ -2197,7 +2191,7 @@ Known Issues - :issue:`SERVER-45042`: MongoDB Server Installation MSI for both Community and Enterprise no longer contain binaries for - the :db-tools:`MongoDB Database Tools <>`. For more information, + the :dbtools:`MongoDB Database Tools <>`. For more information, see :ref:`4.4-tools-compatibility`. - Unresolved diff --git a/source/tutorial/access-mongo-shell-help.txt b/source/tutorial/access-mongo-shell-help.txt index fc2c8f960d3..6eac2818d86 100644 --- a/source/tutorial/access-mongo-shell-help.txt +++ b/source/tutorial/access-mongo-shell-help.txt @@ -94,7 +94,7 @@ In the :binary:`~bin.mongo` shell: .. seealso:: - :ref:`4.0-compat-show-collections` + :ref:`4.0-compat-show-collections` - To see the help for methods available on the collection objects diff --git a/source/tutorial/aggregation-zip-code-data-set.txt b/source/tutorial/aggregation-zip-code-data-set.txt index 116157ba4de..b7ba20c72cd 100644 --- a/source/tutorial/aggregation-zip-code-data-set.txt +++ b/source/tutorial/aggregation-zip-code-data-set.txt @@ -121,7 +121,9 @@ The equivalent :term:`SQL` for this aggregation operation is: .. seealso:: - :pipeline:`$group`, :pipeline:`$match`, :group:`$sum` + - :pipeline:`$group` + - :pipeline:`$match` + - :group:`$sum` Return Average City Population by State --------------------------------------- @@ -177,7 +179,9 @@ following: .. seealso:: - :pipeline:`$group`, :group:`$sum`, :group:`$avg` + - :pipeline:`$group` + - :group:`$sum` + - :group:`$avg` Return Largest and Smallest Cities by State ------------------------------------------- diff --git a/source/tutorial/analyze-query-plan.txt b/source/tutorial/analyze-query-plan.txt index c2b25e4ac01..317067d1943 100644 --- a/source/tutorial/analyze-query-plan.txt +++ b/source/tutorial/analyze-query-plan.txt @@ -10,8 +10,6 @@ Analyze Query Performance :depth: 1 :class: singlecol -.. tabs-top:: - .. tabs-drivers:: tabs: @@ -565,13 +563,15 @@ in a very efficient query. .. seealso:: - :doc:`/core/query-optimization`, :doc:`/core/query-plans`, - :doc:`/tutorial/optimize-query-performance-with-indexes-and-projections`, - :doc:`/applications/indexes` + - :doc:`/core/query-optimization` + - :doc:`/core/query-plans` + - :doc:`/tutorial/optimize-query-performance-with-indexes-and-projections` + - :doc:`/applications/indexes` - id: compass content: | .. seealso:: + - :doc:`Query Optimization ` - :ref:`MongoDB Compass Documentation ` - `Compass Query Plan Documentation `_ diff --git a/source/tutorial/backup-sharded-cluster-metadata.txt b/source/tutorial/backup-sharded-cluster-metadata.txt index 51c2d43c01d..49bda458dc0 100644 --- a/source/tutorial/backup-sharded-cluster-metadata.txt +++ b/source/tutorial/backup-sharded-cluster-metadata.txt @@ -37,7 +37,7 @@ When you perform this procedure, the cluster remains operational .. seealso:: - :doc:`/core/backups`. + :doc:`/core/backups` .. [#read-only] While one of the three config servers is unavailable, diff --git a/source/tutorial/backup-with-filesystem-snapshots.txt b/source/tutorial/backup-with-filesystem-snapshots.txt index f16e4975700..03e97fe5992 100644 --- a/source/tutorial/backup-with-filesystem-snapshots.txt +++ b/source/tutorial/backup-with-filesystem-snapshots.txt @@ -24,8 +24,8 @@ additional system configuration outside of MongoDB. .. seealso:: - :doc:`/core/backups` and - :doc:`/tutorial/backup-and-restore-tools`. + - :doc:`/core/backups` + - :doc:`/tutorial/backup-and-restore-tools` .. _snapshots-overview: diff --git a/source/tutorial/change-hostnames-in-a-replica-set.txt b/source/tutorial/change-hostnames-in-a-replica-set.txt index f4664a8d18d..0420078c369 100644 --- a/source/tutorial/change-hostnames-in-a-replica-set.txt +++ b/source/tutorial/change-hostnames-in-a-replica-set.txt @@ -47,12 +47,10 @@ field. Use either of the following approaches: .. seealso:: - - - :ref:`Replica Set Reconfiguration Process - `, - :doc:`/tutorial/deploy-replica-set`, and - :doc:`/tutorial/expand-replica-set`. + - :ref:`Replica Set Reconfiguration Process + ` + - :doc:`/tutorial/deploy-replica-set` + - :doc:`/tutorial/expand-replica-set` .. _procedure-assumption-change-hostnames-replica-set: diff --git a/source/tutorial/clear-jumbo-flag.txt b/source/tutorial/clear-jumbo-flag.txt index 96e8c884d03..4b6a0bd5f2b 100644 --- a/source/tutorial/clear-jumbo-flag.txt +++ b/source/tutorial/clear-jumbo-flag.txt @@ -105,6 +105,4 @@ You can manually clear the flag using the following steps. .. seealso:: - - :dbcommand:`refineCollectionShardKey` diff --git a/source/tutorial/configure-audit-filters.txt b/source/tutorial/configure-audit-filters.txt index 5973de55b19..f7a8eda7271 100644 --- a/source/tutorial/configure-audit-filters.txt +++ b/source/tutorial/configure-audit-filters.txt @@ -301,10 +301,9 @@ The following example audits the :method:`~db.collection.find()`, .. seealso:: - - :doc:`/tutorial/configure-auditing`, - :doc:`/core/auditing`, - :doc:`/reference/audit-message` + - :doc:`/tutorial/configure-auditing` + - :doc:`/core/auditing` + - :doc:`/reference/audit-message` .. [#authorization-agnostic] You can enable :parameter:`auditAuthorizationSuccess` parameter without enabling ``--auth``; however, all operations will diff --git a/source/tutorial/configure-auditing.txt b/source/tutorial/configure-auditing.txt index 0207484adc9..5baf93f90af 100644 --- a/source/tutorial/configure-auditing.txt +++ b/source/tutorial/configure-auditing.txt @@ -236,5 +236,7 @@ into a human-readable form and output to the terminal: bsondump data/db/auditLog.bson .. seealso:: - :doc:`/tutorial/configure-audit-filters`, :doc:`/core/auditing`, - :doc:`/reference/audit-message` + + - :doc:`/tutorial/configure-audit-filters` + - :doc:`/core/auditing` + - :doc:`/reference/audit-message` diff --git a/source/tutorial/configure-replica-set-tag-sets.txt b/source/tutorial/configure-replica-set-tag-sets.txt index e0f4986a79e..8e4ee9de0c0 100644 --- a/source/tutorial/configure-replica-set-tag-sets.txt +++ b/source/tutorial/configure-replica-set-tag-sets.txt @@ -159,8 +159,7 @@ have been omitted for brevity): .. seealso:: - :method:`Mongo.setReadPref()` - + :method:`Mongo.setReadPref()` .. _configure-custom-write-concern: diff --git a/source/tutorial/configure-ssl.txt b/source/tutorial/configure-ssl.txt index c0a7ebbc212..a9fc6c6d75b 100644 --- a/source/tutorial/configure-ssl.txt +++ b/source/tutorial/configure-ssl.txt @@ -246,6 +246,7 @@ That is, clients must specify TLS/SSL connections. See connecting with TLS/SSL. .. seealso:: + You can also configure :binary:`~bin.mongod` and :binary:`~bin.mongos` using command-line options instead of the configuration file: @@ -365,6 +366,7 @@ certificate key file to the instance. See information on connecting with TLS/SSL. .. seealso:: + You can also configure :binary:`~bin.mongod` and :binary:`~bin.mongos` using command-line options instead of the configuration file: @@ -422,6 +424,7 @@ To prevent clients with revoked certificates from connecting to the :file:`/etc/ssl/revokedCertificates.pem` will not be able to connect. .. seealso:: + You can also configure the revoked certificate list using the command-line option. - For :binary:`~bin.mongod`, see :option:`--tlsCRLFile `. @@ -849,6 +852,7 @@ certificate key file to the instance. See information on connecting with TLS/SSL. .. seealso:: + You can also configure :binary:`~bin.mongod` and :binary:`~bin.mongos` using command-line options instead of the configuration file: @@ -900,6 +904,7 @@ To prevent clients with revoked certificates from connecting to the :file:`/etc/ssl/revokedCertificates.pem` will not be able to connect. .. seealso:: + You can also configure the revoked certificate list using the command-line option. - For :binary:`~bin.mongod`, see :option:`--sslCRLFile `. diff --git a/source/tutorial/configure-windows-netsh-firewall.txt b/source/tutorial/configure-windows-netsh-firewall.txt index 3fbfd42601d..ffabc4fa84d 100644 --- a/source/tutorial/configure-windows-netsh-firewall.txt +++ b/source/tutorial/configure-windows-netsh-firewall.txt @@ -26,7 +26,6 @@ practices and risk management for MongoDB, see .. seealso:: `Windows Firewall `_ - documentation from Microsoft. Overview diff --git a/source/tutorial/define-privilege.rst b/source/tutorial/define-privilege.rst index 4748ec9d65e..eea2abe8784 100644 --- a/source/tutorial/define-privilege.rst +++ b/source/tutorial/define-privilege.rst @@ -20,5 +20,3 @@ role creation. When creating a role, specify each privilege in its own :ref:`resource document ` in :data:`~admin.system.roles.privileges` array. - -For more information, see :doc:`/tutorial/define-roles`. diff --git a/source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt b/source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt index dc1cb00f906..c091f36d795 100644 --- a/source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt +++ b/source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt @@ -256,6 +256,5 @@ authentication, see .. seealso:: - :doc:`/core/sharded-cluster-components` - - :doc:`/core/sharded-cluster-requirements` + - :doc:`/core/sharded-cluster-components` + - :doc:`/core/sharded-cluster-requirements` diff --git a/source/tutorial/enable-authentication.txt b/source/tutorial/enable-authentication.txt index 5e1d29511f5..40888f252b9 100644 --- a/source/tutorial/enable-authentication.txt +++ b/source/tutorial/enable-authentication.txt @@ -52,6 +52,7 @@ instance running without access control and then enables access control. .. include:: /includes/steps/create-admin-then-enable-authentication.rst .. seealso:: + :doc:`/tutorial/manage-users-and-roles`. Additional Considerations diff --git a/source/tutorial/enforce-keyfile-access-control-in-existing-sharded-cluster.txt b/source/tutorial/enforce-keyfile-access-control-in-existing-sharded-cluster.txt index 4fadcf15663..08614d837b0 100644 --- a/source/tutorial/enforce-keyfile-access-control-in-existing-sharded-cluster.txt +++ b/source/tutorial/enforce-keyfile-access-control-in-existing-sharded-cluster.txt @@ -114,6 +114,5 @@ authentication, see .. seealso:: - :doc:`/core/sharded-cluster-components` - - :doc:`/core/sharded-cluster-requirements` + - :doc:`/core/sharded-cluster-components` + - :doc:`/core/sharded-cluster-requirements` diff --git a/source/tutorial/ensure-indexes-fit-ram.txt b/source/tutorial/ensure-indexes-fit-ram.txt index e0373b6d8c8..d6f1cefaa39 100644 --- a/source/tutorial/ensure-indexes-fit-ram.txt +++ b/source/tutorial/ensure-indexes-fit-ram.txt @@ -38,7 +38,8 @@ to fit in memory. See :ref:`indexing-right-handed`. .. seealso:: - :dbcommand:`collStats` and :method:`db.collection.stats()` + - :dbcommand:`collStats` command + - :method:`db.collection.stats()` shell method .. _indexing-right-handed: diff --git a/source/tutorial/implement-field-level-redaction.txt b/source/tutorial/implement-field-level-redaction.txt index c215220d7e4..542618b3e78 100644 --- a/source/tutorial/implement-field-level-redaction.txt +++ b/source/tutorial/implement-field-level-redaction.txt @@ -127,5 +127,6 @@ The aggregation operation returns the following "redacted" document for the user .. seealso:: - :expression:`$map`, :expression:`$setIsSubset`, - :expression:`$anyElementTrue` + - :expression:`$map` + - :expression:`$setIsSubset` + - :expression:`$anyElementTrue` diff --git a/source/tutorial/insert-documents.txt b/source/tutorial/insert-documents.txt index 707d1c940dd..04012b5a814 100644 --- a/source/tutorial/insert-documents.txt +++ b/source/tutorial/insert-documents.txt @@ -22,7 +22,7 @@ upper-right to set the language of the examples on this page. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers This page provides examples of insert operations in MongoDB. diff --git a/source/tutorial/install-mongodb-on-os-x.txt b/source/tutorial/install-mongodb-on-os-x.txt index 00313a21a2a..7ae747c8879 100644 --- a/source/tutorial/install-mongodb-on-os-x.txt +++ b/source/tutorial/install-mongodb-on-os-x.txt @@ -256,8 +256,7 @@ running instance. From a new terminal, issue the following: mongo -.. admonition:: macOS Prevents ``mongo`` From Opening - :class: note +.. note:: macOS Prevents ``mongo`` From Opening .. include:: /includes/extracts/macos-prevent-launch-mongo.rst diff --git a/source/tutorial/manage-indexes.txt b/source/tutorial/manage-indexes.txt index b6397510543..6ef4368f599 100644 --- a/source/tutorial/manage-indexes.txt +++ b/source/tutorial/manage-indexes.txt @@ -14,16 +14,11 @@ This page shows how to manage existing indexes. For instructions on creating indexes, refer to the specific index type pages. - View Existing Indexes --------------------- -.. tabs-top:: - .. include:: /includes/driver-view-existing-indexes-tabs.rst - - .. |things| replace:: collections and indexes .. |method| replace:: :method:`db.getCollectionNames()` and :method:`db.collection.getIndexes()` diff --git a/source/tutorial/manage-the-database-profiler.txt b/source/tutorial/manage-the-database-profiler.txt index c337fa7efc8..fd43cb1e755 100644 --- a/source/tutorial/manage-the-database-profiler.txt +++ b/source/tutorial/manage-the-database-profiler.txt @@ -326,9 +326,10 @@ set to ``0``. The ``slowms`` and ``slowOpSampleRate`` are also available to configure diagnostic logging for :binary:`~bin.mongos`. [#slow-oplogs]_ .. seealso:: - :setting:`~operationProfiling.mode`, - :setting:`~operationProfiling.slowOpThresholdMs`, and - :setting:`~operationProfiling.slowOpSampleRate`. + + - :setting:`~operationProfiling.mode` + - :setting:`~operationProfiling.slowOpThresholdMs` + - :setting:`~operationProfiling.slowOpSampleRate` .. _db-profiling-sharding: diff --git a/source/tutorial/map-reduce-examples.txt b/source/tutorial/map-reduce-examples.txt index 2e302c476f1..466dd5d64b8 100644 --- a/source/tutorial/map-reduce-examples.txt +++ b/source/tutorial/map-reduce-examples.txt @@ -10,8 +10,7 @@ Map-Reduce Examples :depth: 1 :class: singlecol -.. admonition:: Aggregation Pipeline as Alternative to Map-Reduce - :class: note +.. note:: Aggregation Pipeline as Alternative to Map-Reduce An :doc:`aggregation pipeline ` provides better performance and usability than a :doc:`map-reduce @@ -35,8 +34,6 @@ following examples use the :method:`db.collection.mapReduce()` method. .. seealso:: - - - :doc:`/tutorial/perform-incremental-map-reduce` - :doc:`/reference/map-reduce-to-aggregation-pipeline` diff --git a/source/tutorial/perform-incremental-map-reduce.txt b/source/tutorial/perform-incremental-map-reduce.txt index 29eaeae43ee..ef4904224c8 100644 --- a/source/tutorial/perform-incremental-map-reduce.txt +++ b/source/tutorial/perform-incremental-map-reduce.txt @@ -377,8 +377,6 @@ map-reduce example without defining custom functions: .. seealso:: - - - :ref:`$merge Examples ` - :doc:`/core/materialized-views` diff --git a/source/tutorial/project-fields-from-query-results.txt b/source/tutorial/project-fields-from-query-results.txt index c1b7bf8704d..d34777d4213 100644 --- a/source/tutorial/project-fields-from-query-results.txt +++ b/source/tutorial/project-fields-from-query-results.txt @@ -20,7 +20,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers By default, queries in MongoDB return all fields in matching documents. To limit the amount of data that MongoDB sends to applications, you can @@ -408,11 +408,8 @@ Starting in MongoDB 4.4, MongoDB enforces additional restrictions with regards to projections. See :limit:`Projection Restrictions` for details. - .. seealso:: - - - :ref:`find-projection` - :doc:`/tutorial/query-documents` diff --git a/source/tutorial/query-array-of-documents.txt b/source/tutorial/query-array-of-documents.txt index 8782d093945..2632679161f 100644 --- a/source/tutorial/query-array-of-documents.txt +++ b/source/tutorial/query-array-of-documents.txt @@ -22,7 +22,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. |query_operations| replace:: query operations on an array of nested documents diff --git a/source/tutorial/query-arrays.txt b/source/tutorial/query-arrays.txt index 073450d9cb7..cf62f407437 100644 --- a/source/tutorial/query-arrays.txt +++ b/source/tutorial/query-arrays.txt @@ -22,7 +22,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. |query_operations| replace:: query operations on array fields diff --git a/source/tutorial/query-documents.txt b/source/tutorial/query-documents.txt index b0edd5e902d..76b7a237e6d 100644 --- a/source/tutorial/query-documents.txt +++ b/source/tutorial/query-documents.txt @@ -23,7 +23,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. |query_operations| replace:: query operations diff --git a/source/tutorial/query-embedded-documents.txt b/source/tutorial/query-embedded-documents.txt index 9c9c951b8da..b3436adb62c 100644 --- a/source/tutorial/query-embedded-documents.txt +++ b/source/tutorial/query-embedded-documents.txt @@ -23,7 +23,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. |query_operations| replace:: query operations on embedded/nested documents diff --git a/source/tutorial/query-for-null-fields.txt b/source/tutorial/query-for-null-fields.txt index 98d7c670d2a..fbe27b9e2c9 100644 --- a/source/tutorial/query-for-null-fields.txt +++ b/source/tutorial/query-for-null-fields.txt @@ -18,7 +18,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers Different query operators in MongoDB treat ``null`` values differently. diff --git a/source/tutorial/remove-documents.txt b/source/tutorial/remove-documents.txt index 23d3348509d..dc75a125c19 100644 --- a/source/tutorial/remove-documents.txt +++ b/source/tutorial/remove-documents.txt @@ -22,7 +22,7 @@ upper-right to set the language of the following examples. ---------- -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. tabs-drivers:: diff --git a/source/tutorial/rotate-encryption-key.txt b/source/tutorial/rotate-encryption-key.txt index 32625224caa..70779892f03 100644 --- a/source/tutorial/rotate-encryption-key.txt +++ b/source/tutorial/rotate-encryption-key.txt @@ -16,7 +16,7 @@ Most regulatory requirements mandate that a managed key used to decrypt sensitive data must be rotated out and replaced with a new key once a year. -.. see:: Disambiguation +.. note:: Disambiguation To roll over database keys configured with AES256-GCM cipher afer a filesystem restore, see :option:`--eseDatabaseKeyRollover `, the secondaries will not be able to + <\>`, the secondaries will not be able to read the oplog fast enough to keep up with changes. To prevent this, request :doc:`write acknowledgement diff --git a/source/tutorial/unique-constraints-on-arbitrary-fields.txt b/source/tutorial/unique-constraints-on-arbitrary-fields.txt index 8b2eeac16fb..d74c8b6f04d 100644 --- a/source/tutorial/unique-constraints-on-arbitrary-fields.txt +++ b/source/tutorial/unique-constraints-on-arbitrary-fields.txt @@ -75,7 +75,9 @@ it on document insertion. If you need to enforce uniqueness on multiple fields, then each field would require its own proxy collection. -.. see:: The full documentation of: :method:`~db.collection.createIndex()` +.. see:: + + The full documentation of: :method:`~db.collection.createIndex()` and :dbcommand:`shardCollection`. Considerations diff --git a/source/tutorial/update-documents.txt b/source/tutorial/update-documents.txt index 9f30a20332f..e6576a77f80 100644 --- a/source/tutorial/update-documents.txt +++ b/source/tutorial/update-documents.txt @@ -26,7 +26,7 @@ upper-right to set the language of the following examples. ``inventory`` collection. To create and/or populate the ``inventory`` collection, run the following: -.. tabs-pillstrip:: languages +.. tabs-selector:: drivers .. tabs-drivers:: diff --git a/source/tutorial/upgrade-keyfile-to-x509.txt b/source/tutorial/upgrade-keyfile-to-x509.txt index 0f3103a29fd..7f49b043e65 100644 --- a/source/tutorial/upgrade-keyfile-to-x509.txt +++ b/source/tutorial/upgrade-keyfile-to-x509.txt @@ -157,6 +157,7 @@ cluster authentication, use the following rolling upgrade process: fork: true .. seealso:: + You can also configure :binary:`~bin.mongod` and :binary:`~bin.mongos` using command-line options instead of the configuration file: @@ -368,6 +369,7 @@ to x.509 membership authentication and TLS/SSL connections: fork: true .. seealso:: + You can also configure :binary:`~bin.mongod` and :binary:`~bin.mongos` using command-line options instead of the configuration file: diff --git a/source/tutorial/use-database-commands.txt b/source/tutorial/use-database-commands.txt index 44e3322a895..04d63a9526c 100644 --- a/source/tutorial/use-database-commands.txt +++ b/source/tutorial/use-database-commands.txt @@ -13,7 +13,7 @@ Use Database Commands :class: singlecol The MongoDB command interface provides access to all :term:`non CRUD -` database operations. Fetching server statistics, initializing a +` database operations. Fetching server statistics, initializing a replica set, and running an aggregation pipeline or map-reduce job are all accomplished with commands.