diff --git a/source/reference/command/updateZoneKeyRange.txt b/source/reference/command/updateZoneKeyRange.txt index f20a8b9e521..ed9631e3fc0 100644 --- a/source/reference/command/updateZoneKeyRange.txt +++ b/source/reference/command/updateZoneKeyRange.txt @@ -46,61 +46,67 @@ Definition .. list-table:: :header-rows: 1 :widths: 20 20 80 - + * - Parameter - + - Type - + - Description - + * - ``updateZoneKeyRange`` - + - string - + - The namespace of the collection to associate with the range. - + The collection must be sharded for the command to succeed. - - - + + + * - ``min`` - + - document - + - The inclusive lower bound of the range of :term:`shard key` values. - + Specify each field of the shard key in the form of `` : ``. The value must be of the same BSON type or types as the shard key. - - - + + .. note:: + + To use hashed sharding, the field value needs to be of type + :bsontype:`NumberLong `. + * - ``max`` - + - document - + - The exclusive upper bound of the range of :term:`shard key` values. - + Specify each field of the shard key in the form of `` : ``. The value must be of the same BSON type or types as the shard key. - - - + + .. note:: + + To use hashed sharding, the field value needs to be of type + :bsontype:`NumberLong `. + * - ``zone`` - + - string - + - The name of the zone to associate with the range bounded by the ``min`` and ``max``. - + If the value does not match an existing zone, the command fails. - + Specify ``null`` to remove the association between the range with lower bounds of ``min`` and upper bound of ``max`` and the ``updateZoneKeyRange`` collection. The values of ``min`` and ``max`` must match exactly the target range. - - - + + + If no zone range matches the minimum and maximum bounds passed to diff --git a/source/reference/method/sh.updateZoneKeyRange.txt b/source/reference/method/sh.updateZoneKeyRange.txt index 0ebbe9c937b..a48d1f799cb 100644 --- a/source/reference/method/sh.updateZoneKeyRange.txt +++ b/source/reference/method/sh.updateZoneKeyRange.txt @@ -27,54 +27,60 @@ Definition .. list-table:: :header-rows: 1 :widths: 20 20 80 - + * - Parameter - + - Type - + - Description - + * - ``namespace`` - + - string - + - The :term:`namespace` of the sharded collection associate with the ``zone``. - + The collection must be sharded for the operation to succeed. - - - + + + * - ``minimum`` - + - document - + - The inclusive lower bound of the range of :term:`shard key` values. - + Specify each field of the shard key in the form of `` : ``. The value must be of the same BSON type or types as the shard key. - - - + + .. note:: + + To use hashed sharding, the field value needs to be of type + :bsontype:`NumberLong `. + * - ``maximum`` - + - document - + - The exclusive upper bound of the range of :term:`shard key` values. - + Specify each field of the shard key in the form of `` : ``. The value must be of the same BSON type or types as the shard key. - - - + + .. note:: + + To use hashed sharding, the field value needs to be of type + :bsontype:`NumberLong `. + * - ``zone`` - + - string - + - The name of the zone to associate with the range of shard key values bounded by ``minimum`` and ``maximum``. - - - + + + Only issue :method:`sh.updateZoneKeyRange()` when connected to a