updateZoneKeyRange（数据库命令）

定义

updateZoneKeyRange

The updateZoneKeyRange administrative command can either create or remove the association between a range of shard key values and a zone.

You can run updateZoneKeyRange database command and its helpers sh.updateZoneKeyRange() and sh.addTagRange() on an unsharded collection or a non-existing collection.

提示

In mongosh, this command can also be run through the sh.updateZoneKeyRange() helper method.

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

要运行 updateZoneKeyRange，请使用 db.runCommand( { <command> } ) 方法。

您必须在管理员数据库上运行addShardToZone 。

兼容性

此命令可用于以下环境中托管的部署：

• MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

语法

该命令具有以下语法：

db.adminCommand(
   {
     updateZoneKeyRange: <string>,
     min: <document>,
     max: <document>,
     zone: <string> | <null>
   }
)

命令字段

该命令接受以下字段：

行为

If no zone range matches the minimum and maximum bounds passed to updateZoneKeyRange, nothing is removed.

Only issue updateZoneKeyRange when connected to a mongos instance.

mongosh 提供了两种辅助方法：

• sh.updateZoneKeyRange() 用于向区域添加一系列分片键值。

• sh.removeRangeFromZone() 用于从区域中删除一系列分片键值。

您创建的分片键值范围的下边界和上边界不能与分片集合的现有范围重叠。 例如，给定1到10的现有范围，您无法创建5到20的新范围，因为新范围将与现有范围重叠。

一个区域可以有多个与之关联的数据范围，但一个范围最多只能与一个区域关联。

When removing the association between a range and a zone, updateZoneKeyRange does not remove the zone. Use the removeShardFromZone command to remove the association between a zone and a shard.

有关分片集群中区域的更多信息，请参阅区域手册页面。

安全性

对于使用身份验证运行的分片集群，您必须通过以下任一项身份验证：

• 其权限包括对config数据库中的各种集合执行指定操作的用户：

  • find config.shards集合上的

  • { find 、 update和remove 在 config.tags collection；

  或者，

• 权限包括对enableSharding 集群 资源的 的用户。

The clusterAdmin or clusterManager built-in roles have the appropriate permissions for issuing updateZoneKeyRange. See the documentation page for Role-Based Access Control for more information.

例子

给定分片键为{ a : 1 }的分片集合exampledb.collection ，以下操作在alpha区域上创建一个下限为1且上限为10的范围：

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1 },
      max : { a : 10 },
      zone : "alpha"
   }
)

以下操作通过将null传递给zone字段来删除之前创建的范围。

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1 },
      max : { a : 10 },
      zone : null
   }
)

min和max必须与目标范围的边界完全匹配。 以下操作尝试删除之前创建的范围，但将{ a : 0 }指定为min边界：

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 0 },
      max : { a : 10 },
      zone : null
   }
)

While the range of { a : 0 } and { a : 10 } encompasses the existing range, it is not an exact match and therefore updateZoneKeyRange does not remove anything.

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1, b : 1 },
      max : { a : 10, b : 10 },
      zone : "alpha"
   }
)