DOCS-13315: 4.4 init sync operations restrictions

kay-kim · kay-kim · commit d8ec51dabed7 · 2020-06-24T08:57:42.000-04:00
diff --git a/source/includes/extracts-4.4-changes.yaml b/source/includes/extracts-4.4-changes.yaml
@@ -479,4 +479,39 @@ content: |
      :ref:`forceJumbo <movechunk-forceJumbo>` to allow for the
      migration of chunks that are too large to move. The chunks may or
      may not be labeled :ref:`jumbo <jumbo-chunk>`.
+---
+ref: 4.4-changes-repl-state-restrictions
+content: |
+
+   Starting in MongoDB 4.4, to run on a replica set member, the
+   following operations require the member to be in
+   :replstate:`PRIMARY` or :replstate:`SECONDARY` state.
+   
+   - :dbcommand:`listDatabases`
+   - :dbcommand:`listCollections`
+   - :dbcommand:`listIndexes`
+   - :dbcommand:`distinct`
+   - :dbcommand:`dbStats`
+   - :dbcommand:`collStats`
+
+   If the member is in another state, such as :replstate:`STARTUP2`,
+   the operation errors.
+
+   In previous versions, the operations can also be run when the member
+   is in :replstate:`STARTUP2`. However, the operations wait
+   until the member transitions to :replstate:`RECOVERING`.
+
+---
+ref: 4.4-changes-repl-state-restrictions-operation
+content: |
+
+   Starting in MongoDB 4.4, to run on a replica set member,
+   |operations| operations require the member to be in
+   :replstate:`PRIMARY` or :replstate:`SECONDARY` state. If the member
+   is in another state, such as :replstate:`STARTUP2`, the
+   operation errors.
+
+   In previous versions, the operations can also be run when the member
+   is in :replstate:`STARTUP2`. However, the operations wait
+   until the member transitions to :replstate:`RECOVERING`.
 ...
diff --git a/source/reference/command/collStats.txt b/source/reference/command/collStats.txt
@@ -114,6 +114,12 @@ information on indexes currently being built. For details, see:
 - :data:`collStats.totalIndexSize`
 - :data:`collStats.indexSizes`
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`collStats`
 
 Example
 -------
diff --git a/source/reference/command/dbStats.txt b/source/reference/command/dbStats.txt
@@ -76,6 +76,13 @@ Accuracy after Unexpected Shutdown
 
 .. include:: /includes/fact-unexpected-shutdown-accuracy.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`dbStats`
+
 .. _dbstats-output:
 
 Output
diff --git a/source/reference/command/distinct.txt b/source/reference/command/distinct.txt
@@ -143,6 +143,12 @@ Client Disconnection
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`distinct`
 
 Examples
 --------
diff --git a/source/reference/command/listCollections.txt b/source/reference/command/listCollections.txt
@@ -150,6 +150,13 @@ Client Disconnection
 
 .. |operation| replace:: :dbcommand:`listCollections`
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`listCollections`
+
 Required Access
 ---------------
 
diff --git a/source/reference/command/listDatabases.txt b/source/reference/command/listDatabases.txt
@@ -194,6 +194,15 @@ Client Disconnection
 
 .. |operation| replace:: :dbcommand:`listDatabases`
 
+
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`listDatabases`
+
+
 Examples
 --------
 
diff --git a/source/reference/command/listIndexes.txt b/source/reference/command/listIndexes.txt
@@ -74,6 +74,13 @@ Client Disconnection
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`listIndexes`
+
 Output
 ------
 
diff --git a/source/reference/method/db.collection.dataSize.txt b/source/reference/method/db.collection.dataSize.txt
@@ -25,3 +25,9 @@ db.collection.dataSize()
    This method provides a wrapper around the :data:`~collStats.size`
    output of the :dbcommand:`collStats` (i.e.
    :method:`db.collection.stats()`) command.
+
+   .. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+   .. |operations| replace:: :dbcommand:`collStats`
+
+   
diff --git a/source/reference/method/db.collection.distinct.txt b/source/reference/method/db.collection.distinct.txt
@@ -131,6 +131,12 @@ Client Disconnection
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`distinct`
 
 Examples
 --------
diff --git a/source/reference/method/db.collection.getIndexes.txt b/source/reference/method/db.collection.getIndexes.txt
@@ -41,6 +41,13 @@ Client Disconnection
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`listIndexes`
+
 Required Access
 ---------------
 
diff --git a/source/reference/method/db.collection.stats.txt b/source/reference/method/db.collection.stats.txt
@@ -150,6 +150,13 @@ Accuracy after Unexpected Shutdown
 
 .. include:: /includes/fact-unexpected-shutdown-accuracy.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`collStats`
+
 Index Filter Behavior
 ~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/source/reference/method/db.collection.storageSize.txt b/source/reference/method/db.collection.storageSize.txt
@@ -28,3 +28,7 @@ db.collection.storageSize()
    Provides a wrapper around the :data:`~collStats.storageSize` field
    of the :dbcommand:`collStats` (i.e. :method:`db.collection.stats()`)
    output. 
+
+   .. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+   .. |operations| replace:: :dbcommand:`collStats`
diff --git a/source/reference/method/db.collection.totalIndexSize.txt b/source/reference/method/db.collection.totalIndexSize.txt
@@ -27,3 +27,7 @@ db.collection.totalIndexSize()
    :data:`~collStats.totalIndexSize` output of the
    :dbcommand:`collStats` (i.e. :method:`db.collection.stats()`)
    operation.
+
+   .. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+   .. |operations| replace:: :dbcommand:`collStats`
diff --git a/source/reference/method/db.collection.totalSize.txt b/source/reference/method/db.collection.totalSize.txt
@@ -32,3 +32,7 @@ db.collection.totalSize()
    The value returned is the sum of
    :method:`db.collection.storageSize()` and
    :method:`db.collection.totalIndexSize()` in bytes.
+
+   .. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+   .. |operations| replace:: :dbcommand:`collStats`
diff --git a/source/reference/method/db.getCollectionInfos.txt b/source/reference/method/db.getCollectionInfos.txt
@@ -147,6 +147,12 @@ Client Disconnection
 
 .. |operation| replace:: :method:`db.getCollectionInfos()`
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`listCollections`
 
 Example
 -------
diff --git a/source/reference/method/db.getCollectionNames.txt b/source/reference/method/db.getCollectionNames.txt
@@ -45,6 +45,13 @@ Client Disconnection
 
 .. |operation| replace:: :method:`db.getCollectionNames()`
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`listCollections`
+
 Example
 -------
 
diff --git a/source/reference/method/db.stats.txt b/source/reference/method/db.stats.txt
@@ -93,6 +93,13 @@ Accuracy after Unexpected Shutdown
 
 .. include:: /includes/fact-unexpected-shutdown-accuracy.rst
 
+Replica Set Member State Restriction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
+
+.. |operations| replace:: :dbcommand:`dbStats`
+
 Example
 -------
 
diff --git a/source/release-notes/4.4-compatibility.txt b/source/release-notes/4.4-compatibility.txt
@@ -56,6 +56,11 @@ Replica Configuration Document Changes
 
 .. include:: /includes/extracts/4.4-replSetGetConfig-term-field.rst
 
+Initial Sync Restrictions on Operations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/4.4-changes-repl-state-restrictions.rst
+
 Projection Compatibility Changes
 --------------------------------
 
