MongoDBで一意のインデックスを設定する方法

MongoDBで一意のインデックスを設定するには

MongoDBで一意の（ユニークな）インデックスを設定するには、インデックス作成時に unique: true オプションを指定します。一意インデックスを設定すると、そのフィールドに同じ値を持つドキュメントのコレクションへの挿入が禁止され、データの重複を防ぐことができます。

以下では、サンプルコレクションを作成し、実際に一意インデックスの動作を確認していきます。

一意インデックスの作成

まず、ensureIndex() メソッドに unique: true を指定して、一意インデックスを作成します。

> db.demo257.ensureIndex({Name:1},{unique:true});
{
   "createdCollectionAutomatically" : true,
   "numIndexesBefore" : 1,
   "numIndexesAfter" : 2,
   "ok" : 1
}

上記の出力から、コレクションが自動的に作成され（createdCollectionAutomatically: true）、インデックス数が1から2に増えたことがわかります。

ドキュメントの挿入と重複エラーの確認

次に、Name フィールドに異なる値を持つドキュメントを挿入してみます。

> db.demo257.insertOne({Name:"Chris"});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5e47a5e51627c0c63e7dba91")
}
> db.demo257.insertOne({Name:"Bob"});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5e47a5e81627c0c63e7dba92")
}

ここまでは正常に挿入できています。しかし、すでに存在する "Chris" という同じ値を挿入しようとすると、一意インデックスによりエラーが発生します。

> db.demo257.insertOne({Name:"Chris"});
2020-02-15T13:33:54.064+0530 E QUERY    [js] WriteError: E11000 duplicate key error collection: test.demo257 index: Name_1 dup key: { : "Chris" } :
WriteError({
   "index" : 0,
   "code" : 11000,
   "errmsg" : "E11000 duplicate key error collection: test.demo257 index: Name_1 dup key: { : \"Chris\" }",
   "op" : {
      "_id" : ObjectId("5e47a5ea1627c0c63e7dba93"),
      "Name" : "Chris"
   }
})
WriteError@src/mongo/shell/bulk_api.js:461:48
Bulk/mergeBatchResults@src/mongo/shell/bulk_api.js:841:49
Bulk/executeBatch@src/mongo/shell/bulk_api.js:906:13
Bulk/this.execute@src/mongo/shell/bulk_api.js:1150:21
DBCollection.prototype.insertOne@src/mongo/shell/crud_api.js:252:9
@(shell):1:1

E11000 duplicate key error は、一意インデックスが設定されたフィールドに重複した値を挿入しようとした際に発生する代表的なエラーです。このように、一意インデックスによって重複データの登録が確実に防止されます。

find()メソッドで登録済みドキュメントを確認する

find() メソッドを使って、コレクション内のすべてのドキュメントを表示します。

> db.demo257.find();

このクエリを実行すると、以下のような出力が得られます。

{ "_id" : ObjectId("5e47a5e51627c0c63e7dba91"), "Name" : "Chris" }
{ "_id" : ObjectId("5e47a5e81627c0c63e7dba92"), "Name" : "Bob" }

重複挿入しようとした「Chris」の2件目は保存されておらず、「Chris」と「Bob」の2件のみが登録されていることが確認できます。

補足：createIndex()の使用を推奨

なお、ensureIndex() は現在非推奨（deprecated）となっており、最新のMongoDBでは代わりに createIndex() を使用することが推奨されています。書き方はほぼ同じです。

> db.demo257.createIndex({Name:1},{unique:true});

ユーザーのメールアドレスや会員IDなど、重複が許されないフィールドには、あらかじめ一意インデックスを設定しておくことで、アプリケーション側のチェックに頼らずともデータベースレベルで整合性を保つことができます。