唯一索引

在本页面

唯一索引确保索引字段不会存储重复值;例如，强制索引字段的唯一性。默认情况下，MongoDB在创建集合期间在 _id 字段上创建一个唯一的索引。

新的内部格式

从MongoDB 4.2开始，对于4.2（或更高版本）的 featureCompatibilityVersion （ fCV ），MongoDB使用一种新的内部格式来存储与早期MongoDB版本不兼容的唯一索引。新格式适用于现有的唯一索引以及新创建/重建的唯一索引。

创建唯一索引

要创建一个唯一的索引，使用 db.collection.createIndex() 方法，并将 unique 选项设置为 true 。

db.collection.createIndex( <key and index type specification>, { unique: true } )

例如，要在 members 集合的 user_id 字段上创建一个唯一的索引，在 mongo shell中使用以下操作:

db.members.createIndex( { "user_id": 1 }, { unique: true } )

您还可以在复合索引上强制执行唯一约束。如果您在复合索引上使用唯一约束，那么MongoDB将对索引键值的_组合_执行惟一性。

例如，要在 members 集合的 groupNumber ， lastname 和 firstname 字段上创建一个唯一的索引，在 mongo shell中使用以下操作:

db.members.createIndex( { groupNumber: 1, lastname: 1, firstname: 1 }, { unique: true } )

创建的索引强制 groupNumber 、 lastname 和 firstname 值的_组合_的唯一性。

再举一个例子，考虑一个包含以下文档的集合:

{ _id: 1, a: [ { loc: "A", qty: 5 }, { qty: 10 } ] }

创建一个独特的复合 multikey 索引在 a.loc 和 a.qty :

db.collection.createIndex( { "a.loc": 1, "a.qty": 1 }, { unique: true } )

唯一索引允许将以下文档插入到集合中，因为索引强制 a.loc 和 a.qty 值组合的唯一性：

db.collection.insert( { _id: 2, a: [ { loc: "A" }, { qty: 5 } ] } )
db.collection.insert( { _id: 3, a: [ { loc: "A", qty: 10 } ] } )

也可以看看：

如果集合已经包含了违反索引的唯一约束的数据，MongoDB不能在指定的索引字段上创建一个唯一索引。

不能在 hashed索引上指定唯一的约束。

对于复制集和分片集群，使用滚动过程创建唯一索引需要在过程中停止对集合的所有写操作。如果不能在过程中停止对集合的所有写操作，则不要使用滚动过程。相反，在集合上建立你的唯一索引:

唯一约束适用于集合中的不同文档。也就是说，唯一索引防止_单独的_文档对索引键具有相同的值。

因为约束适用于单独的文档,一个独特的多键索引,一个文档可能数组元素,导致重复索引键值,只要文档不重复的索引键值的另一个文档。在本例中，重复索引条目只插入索引一次。

例如，考虑一个包含以下文档的集合:

{ _id: 1, a: [ { loc: "A", qty: 5 }, { qty: 10 } ] }
{ _id: 2, a: [ { loc: "A" }, { qty: 5 } ] }
{ _id: 3, a: [ { loc: "A", qty: 10 } ] }

在 a.loc 和 a.qty 上创建唯一的复合多键索引：

db.collection.createIndex( { "a.loc": 1, "a.qty": 1 }, { unique: true } )

如果集合中的其他文档的索引 key value 为 { "a.loc": "B", "a.qty": null } ，则唯一索引允许将以下文档插入到集合中。

db.collection.insert( { _id: 4, a: [ { loc: "B" }, { loc: "B" } ] } )

如果文档在唯一索引中没有索引字段的值，索引将为该文档存储空值。由于唯一的约束，MongoDB将只允许一个没有索引字段的文档。如果有多个文档没有索引字段的值或缺少索引字段，索引构建将失败，并出现重复键错误。

例如，一个集合在 x 上有一个唯一的索引:

db.collection.createIndex( { "x": 1 }, { unique: true } )

如果集合中没有包含缺少 x 字段的文档，唯一索引允许插入没有 x 字段的文档:

db.collection.insert( { y: 1 } )

但是，如果集合中已经包含了一个没有字段 x 的文档，则在插入一个没有字段 x 的文档时出现唯一的索引错误:

db.collection.insert( { z: 1 } )

由于违反了字段 x 值的唯一约束，操作无法插入文档:

WriteResult({