更新区域键范围

定义

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 传入的最小和最大边界匹配，则不会删除任何内容。

只有在连接到 mongos 实例时才发布 updateZoneKeyRange。

mongosh 提供了两个辅助方法

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

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

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

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

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

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

安全

对于运行着身份验证的分片集群，您必须以以下任一用户身份进行身份验证：

• 具有在config数据库中指定操作权限的用户

  • 在config.shards集合上执行find

  • 在config.tags集合上执行find、update和remove

  或者，也可以是

• 具有在集群资源上执行enableSharding权限的用户。

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

示例

假设有一个分片集合exampledb.collection，其分片键为{ a : 1 }，以下操作在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"
   }
)