updateZoneKeyRange

定义

updateZoneKeyRange

updateZoneKeyRange管理命令可以创建或删除范围分分片键与区域之间的关联。

您可以在未分片的集合或不存在的集合上运行updateZoneKeyRange数据库命令及其助手sh.updateZoneKeyRange()和sh.addTagRange() 。

提示

在 mongosh 中，该命令也可通过 sh.updateZoneKeyRange() 辅助方法运行。

辅助方法对 mongosh 用户来说很方便，但它们返回的信息级别可能与数据库命令不同。如果不追求方便或需要额外的返回字段，请使用数据库命令。

要运行 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>
   }
)

命令字段

该命令接受以下字段：

行为

如果没有区域范围与传递给updateZoneKeyRange的最小和最大边界匹配，则不会删除任何内容。

仅在连接到 实例时发出updateZoneKeyRange mongos。

mongosh 提供了两种辅助方法：

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

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

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

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

删除范围与区域之间的关联时， updateZoneKeyRange不会删除区域。 使用removeShardFromZone命令删除区域和分片之间的关联。

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

安全性

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

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

  • find config.shards集合上的

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

  或者，

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

clusterAdmin或clusterManager内置角色具有发出updateZoneKeyRange的适当权限。 有关更多信息，请参阅基于角色的访问控制的文档页面。

例子

给定分片键为{ 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
   }
)

虽然{ a : 0 }和{ a : 10 }的范围包含现有范围，但它不是精确匹配，因此updateZoneKeyRange不会删除任何内容。

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