enableSharding()
语法
db.collectionspace.collection.enableSharding(<options>)
类别
Collection
修改集合的属性开启分区属性。
参数
- ( Object, 必填 )
通过options
参数可以修改集合属性,如指定集合的分区键等。可组合使用 options
的如下选项:
ShardingKey
( Object ):分区键。(必填)
格式:
-
- "hash":hash 分区。(默认值)
"range":范围分区。格式:
ShardingType : "hash" | "range"
集合只能存在于一个数据组中
格式:
AutoSplit
( Bool ):标识是否开启自动切分功能
格式:AutoSplit : true | false
EnsureShardingIndex
( Bool ):标识是否创建分区索引- 默认值是 trueNote:*
- 分区集合不能修改与分区相关的属性。
- EnsureShardingIndex 和 AutoSplit 仅对当前该次操作生效,仅当修改分区属性,如 ShardingKey 等时有效
返回值
成功:无。
失败:抛出异常。
函数常见异常如下:
当异常抛出时,可以通过获取错误码,或通过获取错误信息。可以参考常见错误处理指南了解更多内容。
版本
v2.10及以上版本。
示例
- 创建一个普通集合,然后将该集合修改为分区集合: