DOCS-11585: mongos and metadata operations

Author: kay-kim

source/core/sharded-cluster-query-router.txt

@@ -293,3 +293,9 @@ to access individual shards.
 
 See :doc:`/tutorial/enable-authentication` for a tutorial on enabling
 adding users to an RBAC-enabled MongoDB deployment.
+
+Metadata Operations
+-------------------
+
+.. include:: /includes/extracts/mongos-operations-wc.rst
+

source/includes/apiargs-dbcommand-create-field.yaml

@@ -189,6 +189,8 @@ description: |
   for the operation. Omit to use the default write
   concern.
 
+  .. include:: /includes/extracts/mongos-operations-wc-create.rst
+
 optional: true
 arg_name: field
 type: document

source/includes/apiargs-dbcommand-renameCollection-field.yaml

@@ -40,6 +40,8 @@ description: |
   for the operation. Omit to use the default write
   concern.
 
+  .. include:: /includes/extracts/mongos-operations-wc-rename-collection.rst
+ 
 optional: true
 arg_name: field
 type: document

source/includes/apiargs-method-db.createCollection-options-param.yaml

@@ -280,4 +280,19 @@ description: |
 
 replacement:
    example: ":ref:`createCollection-collation-example`"
+---
+position: 15
+name: writeConcern
+description: |
+  A document that expresses the :doc:`write concern </reference/write-concern>`
+  for the operation. Omit to use the default write
+  concern.
+
+  .. include:: /includes/extracts/mongos-operations-wc-create.rst
+
+optional: true
+type: document
+interface: method
+operation: db.createCollection
+arg_name: field
 ...

source/includes/extracts-mongos-operations.yaml

@@ -0,0 +1,142 @@
+ref: mongos-operations-wc-move-primary
+content: |
+   
+   :binary:`~bin.mongos` uses :writeconcern:`"majority"` for
+   :dbcommand:`movePrimary`.
+
+---
+ref: mongos-operations-wc-drop
+content: |
+
+   When issued on a sharded cluster, :binary:`~bin.mongos` converts the
+   :doc:`write concern </reference/write-concern>` of the
+   :dbcommand:`drop` command and its helper
+   :method:`db.collection.drop()` to :writeconcern:`"majority"`.
+---
+ref: mongos-operations-wc-rename-collection
+content: |
+
+   When issued on a sharded cluster, :binary:`~bin.mongos` converts the
+   :doc:`write concern </reference/write-concern>` of the
+   :dbcommand:`renameCollection` command and its helper
+   :method:`db.collection.renameCollection()` to
+   :writeconcern:`"majority"`.
+
+   .. note::
+
+      You cannot rename a sharded collection. You can however rename an
+      unsharded collection in a sharded cluster.
+
+---
+ref: mongos-operations-wc-create
+content: |
+
+   When issued on a sharded cluster, :binary:`~bin.mongos` converts the
+   :doc:`write concern </reference/write-concern>` of the
+   :dbcommand:`create` command and its helper
+   :method:`db.createCollection()` to :writeconcern:`"majority"`.
+---
+ref: mongos-operations-wc-drop-database
+content: |
+
+   When issued on a sharded cluster, MongoDB converts the :doc:`write
+   concern </reference/write-concern>` of the :dbcommand:`dropDatabase`
+   command to :writeconcern:`"majority"`.
+
+---
+ref: mongos-operations-wc-shard-collection
+content: |
+
+   :binary:`~bin.mongos` uses :writeconcern:`"majority"` for the
+   :doc:`write concern </reference/write-concern>` of the
+   :dbcommand:`shardCollection` command and its helper
+   :method:`sh.shardCollection()`.
+
+--- 
+ref: mongos-operations-wc-enable-sharding
+content: |
+
+   :binary:`~bin.mongos` uses
+   :writeconcern:`"majority"` for the 
+   :dbcommand:`enableSharding` command and its helper
+   :method:`sh.enableSharding()`.
+---
+ref: mongos-operations-wc-add-shard
+content: |
+
+   :binary:`~bin.mongos`  uses
+   :writeconcern:`"majority"`  for the 
+   :dbcommand:`addShard` command and its helper
+   :method:`sh.addShard()`.
+
+---
+ref: mongos-operations-wc-remove-shard
+content: |
+
+   :binary:`~bin.mongos` converts the
+   :doc:`write concern </reference/write-concern>` of the
+   :dbcommand:`removeShard` command to :writeconcern:`"majority"`.
+
+---
+ref: mongos-operations-wc-fcv
+content: |
+   When issued on a sharded cluster, :binary:`~bin.mongos` converts the
+   :doc:`write concern </reference/write-concern>` of the
+   :dbcommand:`setFeatureCompatibilityVersion` command to :writeconcern:`"majority"`.
+---
+ref: mongos-operations-wc
+content: |
+   
+   :binary:`~bin.mongos` uses :writeconcern:`"majority"` for the
+   following operations that affect the sharded cluster metadata:
+
+   .. list-table::
+      :header-rows: 1
+
+      * - Command
+        - Method
+        - Note
+
+      * - :dbcommand:`addShard`
+        - :method:`sh.addShard()`
+        -
+
+      * - :dbcommand:`create`
+        - :method:`db.createCollection()`
+        -
+
+      * - :dbcommand:`drop`
+        - :method:`db.collection.drop()`
+        -
+
+      * - :dbcommand:`dropDatabase`
+
+        - :method:`db.dropDatabase()`
+
+        - Changed in MongoDB 3.6
+
+      * - :dbcommand:`enableSharding`
+        - :method:`sh.enableSharding()`
+        - 
+
+      * - :dbcommand:`movePrimary`
+        - 
+        - 
+
+      * - :dbcommand:`renameCollection`
+        - :method:`db.collection.renameCollection()`
+        - 
+
+      * - :dbcommand:`shardCollection`
+        - :method:`sh.shardCollection()`
+        -
+
+      * - :dbcommand:`removeShard`
+        - 
+        - 
+
+      * - :dbcommand:`setFeatureCompatibilityVersion`
+        - 
+        - 
+...
+

source/includes/steps-convert-replica-set-enable-sharding.yaml

@@ -21,6 +21,8 @@ action:
     code: |
       sh.enableSharding( "test" )
   - pre: |
+      .. include:: /includes/extracts/mongos-operations-wc-enable-sharding.rst
+
       The operation returns the status of the operation:
     language: sh
     code: |
@@ -77,6 +79,9 @@ action:
       use test
       sh.shardCollection( "test.test_collection", { "number" : 1 } )
   - pre: |
+  
+      .. include:: /includes/extracts/mongos-operations-wc-shard-collection.rst
+
       The method returns the status of the operation:
     language: sh
     code: |

source/includes/steps-shard-a-collection-ranged.yaml

@@ -34,6 +34,7 @@ ref: shard-database
 pre: |
   Issue the :method:`sh.enableSharding()` method, specifying the name of the 
   target database:
+
 action:
   - pre: |
     language: javascript
@@ -46,6 +47,9 @@ action:
     code: |
       db.runCommand( { enableSharding : <database> } )
 post: |
+  .. include:: /includes/extracts/mongos-operations-wc-enable-sharding.rst
+
+  
   Enabling sharding on a database does *not* begin the sharding process. 
   It only allows for collections within that database to be sharded.
 ---
@@ -84,4 +88,7 @@ action:
     language: javascript
     code: |
       sh.shardCollection( "<database>.<collection>", { <shard key> : <direction> } )
+post: |
+   .. include:: /includes/extracts/mongos-operations-wc-shard-collection.rst
+
 ...

source/reference/command/drop.txt

@@ -36,7 +36,8 @@ drop
         - Optional. A document expressing the :doc:`write concern
           </reference/write-concern>` of the :dbcommand:`drop` command.
           Omit to use the default write concern.
-  
+
+          .. include:: /includes/extracts/mongos-operations-wc-drop.rst
 
    The :binary:`~bin.mongo` shell provides the equivalent helper method
    :method:`db.collection.drop()`.
@@ -51,3 +52,6 @@ collection.
 
    This command obtains a write lock on the affected database and
    will block other operations until it has completed.
+
+
+

source/reference/command/dropDatabase.txt

@@ -39,6 +39,8 @@ Definition
           </reference/write-concern>` of the :dbcommand:`drop` command.
           Omit to use the default write concern.
 
+          .. include:: /includes/extracts/mongos-operations-wc-drop-database.rst
+
    The :binary:`~bin.mongo` shell also provides the helper method
    :method:`db.dropDatabase()`.
 
@@ -50,10 +52,11 @@ Behavior
 .. include:: /includes/fact-drop-database-users.rst
 
 .. versionchanged:: 3.6
-   
+
    :dbcommand:`dropDatabase` waits until all collections drops in the
    database have propagated to a majority of the replica set members.
 
+
 Example
 -------
 

source/reference/command/enableSharding.txt

@@ -26,6 +26,8 @@ enableSharding
    To run :dbcommand:`enableSharding`, connect to a :binary:`~bin.mongos`
    instance and run the command in the ``admin`` database.
 
+   .. include:: /includes/extracts/mongos-operations-wc-enable-sharding.rst
+
    :returns:
       A document that contains status of the operation.
 

source/reference/command/movePrimary.txt

@@ -56,6 +56,8 @@ operation, and such actions yield undefined behavior.
 :dbcommand:`movePrimary` may take significant time to complete, and
 you should plan for this unavailability.
 
+.. include:: /includes/extracts/mongos-operations-wc-move-primary.rst
+
 :dbcommand:`movePrimary` will fail if the destination shard contains a
 conflicting collection name.  This may occur if documents are written to an
 un-sharded collection while the collection is moved away, and later the original

source/reference/command/removeShard.txt

@@ -53,6 +53,11 @@ Chunk Balancing
 
 .. include:: /includes/fact-remove-shard-balance-order.rst
 
+Write Concern
+~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/mongos-operations-wc-remove-shard.rst
+
 Example
 -------
 
@@ -64,8 +69,8 @@ operation resembles the following:
    db.adminCommand( { removeShard : "bristol01" } )
 
 Replace ``bristol01`` with the name of the shard to remove. When you
-run :dbcommand:`removeShard`, the command returns immediately,
-with a message that resembles the following:
+run :dbcommand:`removeShard`, the command returns with a message that
+resembles the following:
 
 .. code-block:: javascript
 

source/reference/command/shardCollection.txt

@@ -34,7 +34,8 @@ Definition
          key: <shardkey>,
          unique: <boolean>,
          numInitialChunks: <integer>,
-         collation: { locale: "simple" }
+         collation: { locale: "simple" },
+         writeConcern: <document>
       }
 
    :dbcommand:`shardCollection` has the following fields:
@@ -89,6 +90,11 @@ See also :ref:`Sharded Collection and Unique Indexes
 
 .. include:: /includes/fact-shardCollection-collation.rst
 
+Write Concern
+~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/mongos-operations-wc-shard-collection.rst
+
 Example
 -------
 

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

@@ -49,6 +49,8 @@ Definition
           :method:`db.collection.drop()` operation. Omit to use the
           default write concern.
 
+          .. include:: /includes/extracts/mongos-operations-wc-drop.rst
+   
           .. versionadded:: 4.0
 
    :returns:
@@ -61,6 +63,7 @@ Behavior
 This method obtains a write lock on the affected database and
 will block other operations until it has completed.
 
+
 Example
 -------
 

source/reference/method/db.createCollection.txt

@@ -52,7 +52,8 @@ Definition
                                     indexOptionDefaults: <document>,
                                     viewOn: <string>,
                                     pipeline: <pipeline>,
-                                    collation: <document> } )
+                                    collation: <document>, 
+                                    writeConcern: <document>} )
 
    The :method:`db.createCollection()` method has the following parameters:
 

source/reference/method/db.dropDatabase.txt

@@ -13,7 +13,7 @@ db.dropDatabase()
 Definition
 ----------
 
-.. method:: db.dropDatabase()
+.. method:: db.dropDatabase(<option>)
 
    Removes the current database, deleting the associated data files.
 
@@ -27,6 +27,8 @@ command.
 
 .. include:: /includes/fact-drop-database-users.rst
 
+.. include:: /includes/extracts/mongos-operations-wc-drop.rst
+
 Example
 -------
 

source/reference/method/sh.addShard.txt

@@ -37,10 +37,11 @@ Definition
       .. |mongodb-package| replace:: :binary:`~bin.mongos`
       .. include:: /includes/note-deb-and-rpm-default-to-localhost.rst
 
-The :method:`sh.addShard()` method is a helper for the
-:dbcommand:`addShard` command.
-The :dbcommand:`addShard` command has additional options which are
-not available with this helper.
+   .. include:: /includes/extracts/mongos-operations-wc-add-shard.rst
+   
+   The :method:`sh.addShard()` method is a helper for the
+   :dbcommand:`addShard` command. The :dbcommand:`addShard` command has
+   additional options which are not available with this helper.
 
 Considerations
 --------------