sh.shardCollection()

定义

sh.shardCollection(namespace, key, unique, options)

使用 key 作为 分片键以对集合进行分片。分片键决定了 MongoDB 如何在各分片之间分发集合的文档。

注意

在 6.0 版本中进行了更改。

从 MongoDB 6.0 开始，对集合分片无需首先运行 sh.enableSharding() 方法来配置数据库。

重要

mongosh 方法

本页面提供 mongosh 方法的相关信息。这不是数据库命令或特定语言驱动程序（例如 Node.js）的相关文档。

有关数据库命令，请参阅 shardCollection 命令。

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

sh.shardCollection() 采用以下参数：

Parameter	类型	说明
namespace	字符串	要分片的集合的命名空间，格式为 "<database>.<collection>"。
key	文档	指定一个或多个字段用作分片键的文档。 { <field1>: <1|"hashed">, ... } 将字段值设置为以下任一项： 1 用于基于范围的分片 "hashed" 以指定哈希分片键。 分片键必须有索引支持。除非集合为空，否则索引必须在 shardCollection 命令之前存在。如果集合为空，并且尚不存在可以支持分片键的索引，MongoDB 会在对集合进行分片之前创建索引。 另请参阅分片键索引
unique	布尔	可选。指定 true 以确保基础索引执行唯一约束。默认为 false。 使用哈希分片键时，不能指定 true。 对于传统mongo shell ，如果指定 options文档，则必须显式指定 unique 的值。 当您指定options文档时， mongosh不需要unique 。
options	文档	可选。包含可选字段的文档，包括 numInitialChunks 和 collation。

options 参数支持以下选项：

Parameter	类型	说明
numInitialChunks	整型	可选。指定使用哈希分片键对空集合进行分片时最初创建的最小数据段数。然后，MongoDB 在集群中创建并均衡数据段。numInitialChunks 参数必须小于每个分片 8192 个数据段。默认为每个分片 2 个数据段。 如果集合不为空或分片键不包含哈希字段，则操作将返回错误。 如果使用 presplitHashedZones: true 进行分片，MongoDB 会尝试将指定数量的数据块平均分配到集群中的各区域。 如果使用 presplitHashedZones: false 进行分片或省略分片，并且没有为空集合定义区域和区域范围，则 MongoDB 会尝试在集群中的分片上平均分配指定数量的数据块。 如果使用 presplitHashedZones: false 进行分片或省略分片，并且已为空集合定义了区域和区域范围，numInitialChunks 将不起作用。
collation	文档	可选。如果向 shardCollection 指定的集合采用默认排序规则，则必须包含附带“{locale: "simple" }”的排序规则文档，否则 shardCollection 命令将失败。对于其字段支持分片键模式的索引，必须至少有一个索引采用简易排序规则。
presplitHashedZones	布尔	可选。指定 true 以基于为集合定义的区域和区域范围来执行空集合或不存在集合的初始数据段创建和分发。仅用于哈希分片。 shardCollection() 和 presplitHashedZones: true 返回错误，如果满足以下任一条件： 分片键不包含哈希字段（即不是单个字段的哈希索引或复合哈希索引）。 集合没有定义的区域或区域范围。 定义的区域范围不符合要求。
时间序列	文档	可选。指定此选项可创建新的分片时间序列集合。 要对现有的时间序列集合进行分片，请省略此参数。 当指定给 shardCollection 的集合是时间序列集合并且未指定 timeseries 选项时，MongoDB 将使用定义现有时间序列集合的值来填充 timeseries 字段。 有关详细语法，请参阅时间序列选项。

Considerations

示例

sh.shardCollection("records.people", { zipcode: 1 } )

sh.shardCollection(
  "phonebook.contacts",
  { last_name: "hashed" },
  false,
  {
    numInitialChunks: 5,
    collation: { locale: "simple" }
  }
)