From 7ac7e0c822924a5c7c9d29b83465e9e9b9b45a3c Mon Sep 17 00:00:00 2001 From: Enrique Sanchez Date: Thu, 8 May 2025 16:48:02 -0600 Subject: [PATCH 1/6] DOCSP-43405-msg-oplogReplay-find-command --- source/reference/command/find.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index d551d3aea88..9548fe4c3e3 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -74,6 +74,11 @@ The :dbcommand:`find` command has the following syntax: } ) +.. note:: + Since MongoDB 4.4, the :dbcommand:`find` command ignores the + ``oplogReplay`` flag. However, if the ``oplogReplay`` flag is set, + the server accepts it for backwards compatibility, but has no effect. + .. _find-cmd-fields: Command Fields @@ -421,7 +426,6 @@ When using :ref:`Stable API ` V1, the following - ``max`` - ``min`` - ``noCursorTimeout`` -- ``oplogReplay`` - ``returnKey`` - ``showRecordId`` - ``tailable`` From 62b587d97cb267cc5f2473bc9568cf2b56e72f16 Mon Sep 17 00:00:00 2001 From: Enrique Sanchez Date: Tue, 13 May 2025 16:42:57 -0600 Subject: [PATCH 2/6] DOCSP-49963-fixed-headings-query-plan --- source/core/query-plans.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index 310d67fb99e..508b6a1e139 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -43,7 +43,7 @@ The following diagram illustrates the query planner logic: .. _cache-entry-state: Plan Cache Entry State -~~~~~~~~~~~~~~~~~~~~~~ +------------------- Each plan cache query shape is associated with one of three states in the cache: @@ -128,7 +128,7 @@ changes to the plan cache. Query Plan and Cache Information --------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To view the query plan information for a given query, you can use :method:`db.collection.explain()` or the :method:`cursor.explain()` . @@ -141,7 +141,7 @@ To view plan cache information for a collection, you can use the .. _query-plans-plan-cache-flushes: Plan Cache Flushes ------------------- +'''''''''''''''''''' The query plan cache does not persist if a :binary:`~bin.mongod` restarts or shuts down. In addition: @@ -165,7 +165,7 @@ Users can also: :ref:`query-hash-plan-cache-key` Plan Cache Debug Info Size Limit --------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Starting in MongoDB 5.0, the :ref:`plan cache ` will save full @@ -228,7 +228,7 @@ If one of the indexes were dropped, or if a new index ``{ x: 1, a: 1 change. Availability -~~~~~~~~~~~~ +'''''''''''''' The ``planCacheShapeHash`` and ``planCacheKey`` are available in: From 72253455e071bb65477d3998e377a429776563f3 Mon Sep 17 00:00:00 2001 From: Enrique Sanchez Date: Thu, 15 May 2025 10:45:33 -0600 Subject: [PATCH 3/6] DOCSP-49963-Fixed-headings-query-plan --- source/core/query-plans.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index 508b6a1e139..77b2e1787cb 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -43,7 +43,7 @@ The following diagram illustrates the query planner logic: .. _cache-entry-state: Plan Cache Entry State -------------------- +---------------------- Each plan cache query shape is associated with one of three states in the cache: @@ -128,7 +128,7 @@ changes to the plan cache. Query Plan and Cache Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------------- To view the query plan information for a given query, you can use :method:`db.collection.explain()` or the :method:`cursor.explain()` . @@ -165,7 +165,7 @@ Users can also: :ref:`query-hash-plan-cache-key` Plan Cache Debug Info Size Limit -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------------- Starting in MongoDB 5.0, the :ref:`plan cache ` will save full @@ -228,7 +228,7 @@ If one of the indexes were dropped, or if a new index ``{ x: 1, a: 1 change. Availability -'''''''''''''' +~~~~~~~~~~~~ The ``planCacheShapeHash`` and ``planCacheKey`` are available in: From c00fd4179170a00566d29d5db99bc44380f19095 Mon Sep 17 00:00:00 2001 From: Enrique Sanchez Date: Thu, 15 May 2025 10:53:23 -0600 Subject: [PATCH 4/6] Revert "DOCSP-43405-msg-oplogReplay-find-command" This reverts commit 7ac7e0c822924a5c7c9d29b83465e9e9b9b45a3c. --- source/reference/command/find.txt | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index 9548fe4c3e3..d551d3aea88 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -74,11 +74,6 @@ The :dbcommand:`find` command has the following syntax: } ) -.. note:: - Since MongoDB 4.4, the :dbcommand:`find` command ignores the - ``oplogReplay`` flag. However, if the ``oplogReplay`` flag is set, - the server accepts it for backwards compatibility, but has no effect. - .. _find-cmd-fields: Command Fields @@ -426,6 +421,7 @@ When using :ref:`Stable API ` V1, the following - ``max`` - ``min`` - ``noCursorTimeout`` +- ``oplogReplay`` - ``returnKey`` - ``showRecordId`` - ``tailable`` From 9af986d3665ee692efe77fd45b5212ac768fe282 Mon Sep 17 00:00:00 2001 From: Enrique Sanchez Date: Thu, 15 May 2025 11:15:06 -0600 Subject: [PATCH 5/6] DOCSP-49963-headings-h3-fixed --- source/core/query-plans.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index 77b2e1787cb..de9df3a0bcb 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -141,7 +141,7 @@ To view plan cache information for a collection, you can use the .. _query-plans-plan-cache-flushes: Plan Cache Flushes -'''''''''''''''''''' +'''''''''''''''''' The query plan cache does not persist if a :binary:`~bin.mongod` restarts or shuts down. In addition: From d0036958cce1a985952a245fa6741706caf77ab9 Mon Sep 17 00:00:00 2001 From: Enrique Sanchez Date: Thu, 15 May 2025 15:48:56 -0600 Subject: [PATCH 6/6] DOCSP-49963-headings-h2-fixed --- source/core/query-plans.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index de9df3a0bcb..d66bf55728c 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -141,7 +141,7 @@ To view plan cache information for a collection, you can use the .. _query-plans-plan-cache-flushes: Plan Cache Flushes -'''''''''''''''''' +------------------ The query plan cache does not persist if a :binary:`~bin.mongod` restarts or shuts down. In addition: