createIdIndex()

语法

db.collectionspace.collection.createIdIndex([options])

在 SequoiaDB 中创建集合时可以根据需要将 AutoIndexId 置为 false。这样集合将不会创建默认的“$id”索引，同时数据的更新、删除操作将被禁止。本方法可以恢复“$id”索引，同时开放更新和删除功能。

类别

SdbCollection

参数

参数名参数类型默认值描述是否必填
optionsJSON—-可选项否

options 参数详细说明如下：

属性名值类型默认值描述
SortBufferSizeint64创建索引时使用的排序缓存的大小（单位：MB），取值为 0 时表示不使用排序缓存

返回值

无

错误

错误码可能的原因解决方法
-247$id 索引已经存在-
-291存在一个相同定义的索引删除定义冲突的索引

如果出错则抛异常，并输出错误信息，可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。 关于错误处理可以参考常见错误处理指南。

常见错误可参考错误码。

示例

  • 使用默认参数构建 $id 索引:

    1. > db.sample.employee.createIdIndex()

  • 构建 $id 索引时指定排序缓存大小:

    1. > db.sample.employee.createIdIndex( { SortBufferSize: 128 } )