Docs 菜单
Docs 主页
/
MongoDB Manual
/
参考
/
mongosh 方法
/
分片

sh.shardCollection()

在此页面上

  • 定义
  • 兼容性
  • Considerations
  • 示例

定义

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

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

mongosh方法sh.shardCollection()会封装shardCollection命令。

重要

mongosh 方法

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

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

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

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

Parameter
类型
说明

namespace

字符串

要分片的集合的命名空间，格式为 "<database>.<collection>"。

key

文档

指定一个或多个字段用作分片键的文档。

{ <field1>: <1|"hashed">, ... }

将字段值设置为以下任一项：

分片键必须有索引支持。除非集合为空，否则索引必须在 shardCollection 命令之前存在。如果集合为空，并且尚不存在可以支持分片键的索引，MongoDB 会在对集合进行分片之前创建索引。

另请参阅分片键索引

unique

布尔

可选。指定 true 以确保基础索引执行唯一约束。默认为 false。

使用哈希分片键时，不能指定 true。

如果指定了 options 文件，则必须显式指定 unique 的值。

options

文档

可选。包含可选字段的文档，包括 numInitialChunks 和 collation。

options 参数支持以下选项：

Parameter
类型
说明

numInitialChunks

整型

可选。指定使用哈希分片键对空集合进行分片时最初创建的最小数据段数。然后，MongoDB 在集群中创建并均衡数据段。numInitialChunks 参数必须小于每个分片 8192 个数据段。默认为每个分片 2 个数据段。

如果集合不为空或分片键不包含哈希字段，则操作将返回错误。

  • 如果使用 presplitHashedZones: true 进行分片，则MongoDB会尝试在集群中的区域之间平均分配指定数量的数据段。

  • 如果使用分片 : false 或省略进行分片，并且没有为集合定义区域和区域范围，则MongoDB会尝试在集群中的分片之间平均分布式指定数量的数据段。

  • 如果使用分片 : false 或省略进行分片，并且已为集合定义了区域和区域范围，则numInitChunks 无效。

collation

文档

可选。如果指定给 shardCollection 的集合具有默认排序规则，则必须包含附带 { locale : "simple" } 的排序规则文档，否则 shardCollection 命令将失败。对于其字段支持分片键模式的索引，必须至少有一个索引采用简易排序规则。

presplitHashedZones

布尔

可选。指定 true 以基于为集合定义的区域和区域范围来执行空集合或不存在集合的初始数据段创建和分发。仅用于哈希分片。

shardCollection() 和 presplitHashedZones: true 返回错误，如果满足以下任一条件：

兼容性

此方法可用于以下环境中托管的部署：

重要

M 0 、M 2和 M 5集群不支持此命令。 有关更多信息，请参阅不支持的命令。

Considerations

集合被分片后，MongoDB 就不再提供对分片集合进行取消分片的方法。

分片键

虽然您可在后续更改分片键，但请务必仔细考虑分片键的选择，以免出现可扩展性与性能问题。

提示

另请参阅：

哈希分片键

哈希分片键使用哈希索引或复合哈希索引作为分片键。

使用表单 field: "hashed" 指定哈希分片键字段。

注意

如果在创建哈希分片键集合时正在进行块迁移，则初始块分布可能会不均匀，直到负载均衡器自动平衡集合。

提示

另请参阅：

哈希分片

区域分片和初始数据块分布

分片集合操作（即shardCollection 命令和 sh.shardCollection() 辅助程序）可以对空集合或不存在的集合执行初始数据块创建和分发，前提是已为该集合定义区域和区域范围。初始数据块分布允许更快地设置区域分片。在初始分布之后，负载均衡器将照例管理未来的数据块分布。

有关示例，请参阅为空集合或不存在的集合预先定义区域和区域范围。如果使用范围或单字段哈希分片键对集合进行分片，并且已为空集合定义了区域和区域范围，则 numInitialChunks 选项将不起作用。

要使用复合哈希索引对集合进行分片，请参阅使用复合哈希索引进行初始数据块分发。

使用复合哈希索引进行初始数据段分发

MongoDB 支持使用组合哈希索引对集合进行分片。在使用组合哈希分片键对空集合或不存在的集合进行分片时，需要满足额外的要求，MongoDB 才能执行初始数据块创建和分配。

如果已为空集合定义区域和区域范围且 presplitHashedZones 为 false，则 numInitialChunks 选项无效。

有关示例，请参阅为空集合或不存在的集合预先定义区域和区域范围。

提示

另请参阅：

初始数据段

唯一性

如果指定 unique: true：

  • 如果集合为空，sh.shardCollection() 将在分片键上创建唯一索引（如果这样的索引尚不存在）。

  • 如果集合不为空，则必须先创建索引，然后才能使用 sh.shardCollection()。

尽管可以有以分片键为前缀的唯一复合索引，但如果使用unique参数，则集合必须在分片键上有唯一索引。

另请参阅分片集合和唯一索引

排序规则

已在 3.4 版本中更改。

如果集合有默认排序规则，则 sh.shardCollection() 命令必须包含值为 { locale: "simple" } 的 collation 参数。对于具有默认排序规则的非空集合，您必须至少拥有一个具有简单排序规则且其字段支持分片键模式的索引。

无需为没有排序规则的集合指定 collation 选项。如果确实为没有排序规则的集合指定了排序规则选项，则它将不起作用。

写关注

mongos 使用 "majority"，执行 shardCollection 命令及其辅助函数 sh.shardCollection() 的写关注。

示例

简易用法

假设名为 records 的数据库中有一名为 people 的集合，以下命令将按 zipcode 字段对该集合进行分片：

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

用法以及选项

phonebook 数据库包含一个没有默认排序规则的集合 contacts。以下示例使用 sh.shardCollection() 对 phonebook.contacts 进行分片，详细信息如下：

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

提示

另请参阅：

后退

sh.setBalancerState

来年

sh.splitAt