createIndex()

语法

db.collectionspace.collection.createIndex(<name>,<indexDef>,[isUnique],[enforced],[sortBufferSize])

db.collectionspace.collection.createIndex(<name>,<indexDef>,[options])

为集合创建索引，提高查询速度。

参数描述

参数名参数类型描述是否必填
namestring索引名，同一个集合中的索引名必须唯一。是
indexDefJson 对象索引键，包含一个或多个指定索引字段与类型的对象。类型值 1 表示字段升序，-1 表示字段降序，"text" 则表示创建全文索引。是
isUniqueBoolean索引是否唯一，默认 false。设置为 true 时代表该索引为唯一索引。否
enforcedBoolean索引是否强制唯一，可选参数，在 isUnique 为 true 时生效，默认 false。设置为 true 时代表该索引在 isUnique 为 true 的前提下，不可存在一个以上全空的索引键。否
sortBufferSizeint创建索引时使用的排序缓存的大小，单位为MB。取值为0时表示不使用排序缓存。默认为64。否
optionsJson 对象可选项，详见 options 选项说明。否

options 选项

属性名参数类型描述默认值
UniqueBoolean索引是否唯一。false
EnforcedBoolean索引是否强制唯一。false
NotNullBoolean索引的任意一个字段是否允许为 null 或者不存在。false
SortBufferSizeint创建索引时使用的排序缓存的大小。64MB

Note:

  • 在唯一索引所指定的索引键字段上，集合中不可存在一条以上的记录完全重复。
  • 索引名限制、索引字段的最大数量、索引键的最大长度请参考限制。
  • 在集合记录数据量较大时（大于1000万条记录）适当增大排序缓存大小可以提高创建索引的速度。
  • 对于全文索引，参数 isUnique、enforced 及 sortBufferSize 无意义。

返回值

无返回值，出错抛异常，并输出错误信息，可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误信息码。

错误

错误码

示例

  • 在集合 bar 下为字段名 age 创建名为 ageIndex 的唯一索引，记录按 age 字段值的升序排序。
  1. > db.foo.bar.createIndex( "ageIndex", { age: 1 }, true )
  • 集合 bar 创建唯一索引，并且索引字段不允许为 null 或者不存在。
  1. > db.foo.bar.createIndex( "ab", { a: 1, b: 1 }, { Unique: true, NotNull: true } )
  2. >
  3. > // b 字段为 null，插入索引时报错
  4. > db.foo.bar.insert( { a: 1, b: null } )
  5. sdb.js:625 uncaught exception: -339
  6. Any field of index key should exist and cannot be null
  7. Takes 0.002531s.
  8. >
  9. > // b 字段不存在，插入索引时报错
  10. > db.foo.bar.insert( { a: 1 } )
  11. sdb.js:625 uncaught exception: -339
  12. Any field of index key should exist and cannot be null
  13. Takes 0.002531s.
  • 在集合 bar 中的 address 及 tags 字段上建立全文索引，用于对这两个字段进行全文检索。
  1. > db.foo.bar.createIndex( "addr_tags", { address: "text", tags: "text" } )