DOCSP-26462 query optimization process - replica state (#7114)

Author: jmd-mongo

source/core/query-plans.txt

@@ -155,12 +155,12 @@ Plan Cache Debug Info Size Limit
 --------------------------------
 
 Starting in MongoDB 5.0, the
-:doc:`plan cache </core/query-plans>` will save full ``plan cache``
-entries only if the cumulative size of the ``plan caches`` for all
-collections is lower than 0.5 GB. When the cumulative size of the
-``plan caches`` for all collections exceeds this threshold, additional
-``plan cache`` entries are stored without the following debug
-information:
+:ref:`plan cache <query-plans-query-optimization>` will save full 
+``plan cache`` entries only if the cumulative size of the 
+``plan caches`` for all collections is lower than 0.5 GB. When the 
+cumulative size of the ``plan caches`` for all collections exceeds this 
+threshold, additional ``plan cache`` entries are stored without the 
+following debug information:
 
 - :ref:`createdFromQuery <plancachestats-createdFromQuery>`
 - :ref:`cachedPlan <plancachestats-cachedPlan>`
@@ -219,13 +219,13 @@ Availability
 
 The ``queryHash`` and ``planCacheKey`` are available in:
 
-- :doc:`explain() output </reference/explain-results>` fields:
+- :ref:`explain() output <explain-results>` fields:
   :data:`queryPlanner.queryHash <explain.queryPlanner.queryHash>` and
   :data:`queryPlanner.planCacheKey <explain.queryPlanner.planCacheKey>`
 
-- :doc:`profiler log messages </tutorial/manage-the-database-profiler>`
-  and :doc:`diagnostic log messages (i.e. mongod/mongos log
-  messages)</reference/log-messages>` when logging slow queries.
+- :ref:`profiler log messages <database-profiler>`
+  and :ref:`diagnostic log messages (i.e. mongod/mongos log
+  messages)<log-messages-ref>` when logging slow queries.
 
 - :pipeline:`$planCacheStats` aggregation stage (*New in MongoDB 4.2*)
 

source/core/read-preference-hedge-option.txt

@@ -7,7 +7,7 @@ Hedged Read Option
 .. default-domain:: mongodb
 
 You can specify the use of :ref:`hedged reads <mongos-hedged-reads>` for 
-non-``primary`` :doc:`read preferences </core/read-preference>` on sharded 
+non-``primary`` :ref:`read preferences <read-preference>` on sharded 
 clusters.
 
 With hedged reads, the :binary:`~bin.mongos` instances can route read

source/core/read-preference-mechanics.txt

@@ -77,12 +77,11 @@ Hedged Reads
 ````````````
 
 :binary:`~bin.mongos` supports :ref:`hedged reads <mongos-hedged-reads>` for 
-non-``primary`` :doc:`read preferences </core/read-preference>` modes. 
+non-``primary`` :ref:`read preference <read-preference>` modes. 
 That is, :binary:`~bin.mongos` can send an additional read to another member, 
 if available, to hedge the read operation if using non-``primary`` 
-:doc:`read preferences </core/read-preference>`. The additional read sent to 
-hedge the read operation uses the ``maxTimeMS`` value of
-:parameter:`maxTimeMSForHedgedReads`.
+read preferences. The additional read sent to hedge the read operation 
+uses the ``maxTimeMS`` value of :parameter:`maxTimeMSForHedgedReads`.
 
 .. include:: /includes/list-hedged-reads-operations.rst
 

source/core/sharding-shard-a-collection.txt

@@ -34,7 +34,7 @@ shard a collection:
      - Specify a document ``{ <shard key field1>: <1|"hashed">, ... }``
        where
 
-       - ``1`` indicates :doc:`range-based sharding </core/ranged-sharding>`
+       - ``1`` indicates :ref:`range-based sharding <sharding-ranged>`
 
        - ``"hashed"`` indicates :doc:`hashed sharding </core/hashed-sharding>`.
 

source/core/transactions-production-consideration.txt

@@ -140,7 +140,7 @@ Transactions and Security
 -------------------------
 
 - If running with :ref:`access control <authorization>`, you must
-  have :doc:`privileges </reference/built-in-roles>` for the
+  have :ref:`privileges <built-in-roles>` for the
   :ref:`operations in the transaction <transactions-operations>`.
 
 - If running with :ref:`auditing <auditing>`, operations in an

source/includes/fact-explain-results-categories.rst

@@ -5,7 +5,7 @@
 - ``command``, which details the command being explained;
 
 - :ref:`queryPlanner`, which details the plan selected by the
-  :doc:`query optimizer </core/query-plans>` and lists the rejected
+  :ref:`query optimizer <read-operations-query-optimization>` and lists the rejected
   plans;
 
 - :ref:`executionStats`, which details the execution of the winning

source/includes/fact-explain-verbosity-executionStats.rst

@@ -1,4 +1,4 @@
-MongoDB runs the :doc:`query optimizer </core/query-plans>` to choose
+MongoDB runs the :ref:`query optimizer <read-operations-query-optimization>` to choose
 the winning plan, executes the winning plan to completion, and returns
 statistics describing the execution of the winning plan.
 

source/includes/fact-explain-verbosity-queryPlanner.rst

@@ -1,4 +1,4 @@
-MongoDB runs the :doc:`query optimizer </core/query-plans>` to choose
+MongoDB runs the :ref:`query optimizer <read-operations-query-optimization>` to choose
 the winning plan for the operation under evaluation. |explain| returns
 the :data:`~explain.queryPlanner` information for the evaluated
 |operation|.

source/includes/getMore-slow-queries.rst

@@ -2,4 +2,4 @@ Starting in MongoDB 5.1, when a :dbcommand:`getMore` command is logged
 as a :ref:`slow query <log-message-slow-ops>`, the :ref:`queryHash
 <query-hash>` and :ref:`planCacheKey <plan-cache-key>` fields are added
 to the :ref:`slow query log message <log-message-slow-ops>` and the
-:doc:`profiler log message </tutorial/manage-the-database-profiler>`.
+:ref:`profiler log message <database-profiler>`.

source/reference/command/connectionStatus.txt

@@ -66,7 +66,7 @@ field:
 
      - Optional. Set ``showPrivileges`` to true to instruct
        :dbcommand:`connectionStatus` to return the full set of
-       :doc:`privileges </reference/privilege-actions>` that
+       :ref:`privileges <security-user-actions>` that
        currently-authenticated users possess.
 
        By default, this field is ``false``.

source/reference/command/planCacheSetFilter.txt

@@ -107,7 +107,7 @@ The command has the following fields:
          ]``.
        - Index names. For example, ``[ "x_1", ... ]``.
 
-       The :doc:`query optimizer </core/query-plans>` uses either a
+       The :ref:`query optimizer <read-operations-query-optimization>` uses either a
        collection scan or the index arrays for the query plan. If the
        specified indexes do not exist or are :doc:`hidden
        </core/index-hidden>`, the optimizer uses a collection scan.

source/reference/command/refineCollectionShardKey.txt

@@ -109,7 +109,7 @@ The command takes the following fields:
 
        For the suffix fields, set the field values to either:
 
-       - ``1`` for :doc:`ranged based sharding </core/ranged-sharding>`
+       - ``1`` for :ref:`range-based sharding <sharding-ranged>`
 
        - ``"hashed"`` to specify a :ref:`hashed shard key
          <hashed-shard-keys>` *if* no other field in the shard key has

source/reference/command/reshardCollection.txt

@@ -89,7 +89,7 @@ The command takes the following fields:
 
        Set the field values to either:
 
-       - ``1`` for :doc:`ranged based sharding </core/ranged-sharding>`
+       - ``1`` for :ref:`range-based sharding <sharding-ranged>`
 
        - ``"hashed"`` to specify a
          :ref:`hashed shard key <hashed-shard-keys>`.

source/reference/command/shardCollection.txt

@@ -92,7 +92,7 @@ The command takes the following fields:
 
        Set the field values to either:
 
-       - ``1`` for :doc:`ranged based sharding </core/ranged-sharding>`
+       - ``1`` for :ref:`range-based sharding <sharding-ranged>`
 
        - ``"hashed"`` to specify a
          :ref:`hashed shard key <hashed-shard-keys>`.

source/reference/explain-results.txt

@@ -144,7 +144,7 @@ documentation for that version.
 ~~~~~~~~~~~~~~~~
 
 :data:`explain.queryPlanner` information details the plan selected by
-the :doc:`query optimizer </core/query-plans>`.
+the :ref:`query optimizer <read-operations-query-optimization>`.
 
 These examples may combine the output structures of MongoDB's classic
 and slot-based execution engines. They are not meant to be 
@@ -238,7 +238,7 @@ representative. Your output may differ significantly.
 .. data:: explain.queryPlanner
 
    Contains information on the selection of the query plan by the
-   :doc:`query optimizer </core/query-plans>`.
+   :ref:`query optimizer <read-operations-query-optimization>`.
 
    .. data:: explain.queryPlanner.namespace
 

source/reference/glossary.txt

@@ -121,7 +121,7 @@ Glossary
       operations.
 
    bounded collection scan
-      A plan used by the :doc:`query optimizer </core/query-plans>` that
+      A plan used by the :ref:`query optimizer <read-operations-query-optimization>` that
       excludes documents with specific field value ranges. For
       example, if a range of date field values is outside of a specified
       date range, the documents in that range are excluded from the

source/reference/method/Mongo.setReadPref.txt

@@ -85,7 +85,7 @@ Parameters
        Hedged reads are available for sharded clusters. To use hedged reads, 
        the :binary:`~bin.mongos` must have :parameter:`enabled support 
        <readHedgingMode>` for hedged reads (the default) and the 
-       non-``primary`` :doc:`read preferences </core/read-preference>` must 
+       non-``primary`` :ref:`read preference <read-preference>` must 
        enable the use of hedged reads.
 
        Read preference :readmode:`nearest` enables the use of hedged
@@ -170,7 +170,7 @@ Specify Hedged Read
 ~~~~~~~~~~~~~~~~~~~
 
 For sharded clusters, you can enable :ref:`hedged reads <mongos-hedged-reads>` 
-for non-primary :doc:`read preferences </core/read-preference>`. To use hedged 
+for non-primary :ref:`read preferences <read-preference>`. To use hedged 
 reads, the :binary:`~bin.mongos` must have :parameter:`enabled support
 <readHedgingMode>` for hedged reads (the default) and the
 non-``primary`` :ref:`read preferences <read-preference>` must

source/reference/method/cursor.hint.txt

@@ -22,7 +22,7 @@ Definition
 
 
    Call this method on a query to override MongoDB's default index
-   selection and :doc:`query optimization process </core/query-plans>`.
+   selection and :ref:`query optimization process <read-operations-query-optimization>`.
    Use :method:`db.collection.getIndexes()` to return the list of
    current indexes on a collection.
 

source/reference/method/cursor.readPref.txt

@@ -150,7 +150,7 @@ Specify Hedged Read
 ~~~~~~~~~~~~~~~~~~~
 
 For sharded clusters, you can enable :ref:`hedged reads <mongos-hedged-reads>` 
-for non-primary :doc:`read preferences </core/read-preference>`. To use hedged 
+for non-primary :ref:`read preference <read-preference>`. To use hedged 
 reads, the :binary:`~bin.mongos` must have :parameter:`enabled support
 <readHedgingMode>` for hedged reads (the default) and the
 non-``primary`` :ref:`read preferences <read-preference>` must

source/reference/method/db.collection.find.txt

@@ -158,7 +158,7 @@ cursor handling mechanism for the :driver:`driver language
 Read Concern
 ~~~~~~~~~~~~
 
-To specify the :doc:`read concern </reference/read-concern>` for
+To specify the :ref:`read concern <read-concern>` for
 :method:`db.collection.find()`, use the :method:`cursor.readConcern()`
 method.
 

source/reference/method/rs.add.txt

@@ -148,7 +148,7 @@ Add a Priority 0 Member to a Replica Set
 
 The following operation adds a :binary:`~bin.mongod` instance, running on
 the host ``mongodb4.example.net`` and accessible on the default port
-``27017``, as a :doc:`priority 0 </core/replica-set-priority-0-member>`
+``27017``, as a :ref:`priority 0 <replica-set-secondary-only-members>`
 secondary member:
 
 .. code-block:: javascript

source/reference/method/sh.reshardCollection.txt

@@ -51,7 +51,7 @@ Definition
 
           Set the field values to either:
 
-          - ``1`` for :doc:`ranged based sharding </core/ranged-sharding>`
+          - ``1`` for :ref:`range-based sharding <sharding-ranged>`
           - ``"hashed"`` to specify a
             :ref:`hashed shard key <hashed-shard-keys>`.
 

source/reference/method/sh.shardCollection.txt

@@ -64,7 +64,7 @@ Definition
 
           Set the field value to either:
 
-          - ``1`` for :doc:`ranged based sharding </core/ranged-sharding>`
+          - ``1`` for :ref:`range-based sharding <sharding-ranged>`
 
           - ``"hashed"`` to specify a
             :ref:`hashed shard key <hashed-shard-keys>`.

source/reference/mongodb-defaults.txt

@@ -29,7 +29,7 @@ Read Concern
 Default Read Concern
 ~~~~~~~~~~~~~~~~~~~~
 
-The :red:`default` :doc:`read concern </reference/read-concern>` is as
+The :red:`default` :ref:`read concern <read-concern>` is as
 follows:
 
 .. list-table::
@@ -86,7 +86,7 @@ Specify Read Concern: MongoDB Drivers
          Transactions`` tab.
 
       Using the :driver:`MongoDB drivers </>`, you can override the default 
-      :doc:`read concern </reference/read-concern>` and set read concern for operations 
+      :ref:`read concern <read-concern>` and set read concern for operations 
       at the following levels:
 
       .. list-table::

source/release-notes/4.2.txt

@@ -2059,7 +2059,7 @@ see :doc:`/core/query-plans`.
 
 - The ``queryHash`` and ``planCacheKey`` are available in:
 
-  - :doc:`profiler entry </tutorial/manage-the-database-profiler>`
+  - :ref:`profiler entry <database-profiler>`
     fields :data:`~system.profile.queryHash` and
     :data:`~system.profile.planCacheKey` the logged query operations.
 

source/tutorial/evaluate-operation-performance.txt

@@ -59,7 +59,7 @@ Starting in MongoDB 4.2, the explain output includes:
   with the same :term:`query shape`.
 
 - :data:`~explain.queryPlanner.planCacheKey` to provide more insight
-  into the :doc:`query plan cache </core/query-plans>` for slow queries.
+  into the :ref:`query plan cache <read-operations-query-optimization>` for slow queries.
 
 
 For more information, see :doc:`/reference/explain-results`,