MongoDBのコレクションに一意インデックス（ユニークインデックス）を設定する方法

MongoDBでは、コレクション内の特定フィールドに重複した値が登録されないようにするために、一意インデックス（ユニークインデックス）を作成できます。インデックス作成時に unique: true を指定することで、そのフィールドに一意制約が適用されます。

一意インデックスの作成手順

まず、ドキュメントを格納するためのコレクションに対して、createIndex() メソッドを使って一意インデックスを作成します。あわせて sparse: true を指定すると、該当フィールドを持たないドキュメントはインデックスの対象外になります。

> db.demo658.createIndex({FirstName:1},{unique:true,sparse:true});
{
    "createdCollectionAutomatically" : true,
    "numIndexesBefore" : 1,
    "numIndexesAfter" : 2,
    "ok" : 1
}

ドキュメントの挿入と重複チェック

次に、insertOne() メソッドでドキュメントを挿入してみましょう。まずは異なる「FirstName」を持つ2件のドキュメントを登録します。

> db.demo658.insertOne({"FirstName":"John","LastName":"Smith"});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5ea067144deddd72997713d9")
}
> db.demo658.insertOne({"FirstName":"Adam","LastName":"Smith"});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5ea0671c4deddd72997713da")
}

ここで、すでに存在する「John」という同じ値を持つドキュメントを挿入するとどうなるでしょうか。

> db.demo658.insertOne({"FirstName":"John","LastName":"Doe"});
2020-04-22T21:17:46.072+0530 E QUERY [js] WriteError: E11000 duplicate key error collection: onlinecustomertracker.demo658 index: FirstName_1 dup key: { : "John" } :
WriteError({
    "index" : 0,
    "code" : 11000,
    "errmsg" : "E11000 duplicate key error collection: onlinecustomertracker.demo658 index: FirstName_1 dup key: { : \"John\" }",
    "op" : {
        "_id" : ObjectId("5ea067224deddd72997713db"),
        "FirstName" : "John",
        "LastName" : "Doe"
    }
})
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（重複キーエラー）」が発生し、挿入は拒否されます。これにより、「FirstName」フィールドの一意性が保証されていることが確認できます。

登録済みドキュメントの確認

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

> db.demo658.find();

実行結果は以下のとおりです。重複エラーとなった3件目のドキュメントは登録されておらず、最初の2件のみが保存されています。

{ "_id" : ObjectId("5ea067144deddd72997713d9"), "FirstName" : "John", "LastName" : "Smith" }
{ "_id" : ObjectId("5ea0671c4deddd72997713da"), "FirstName" : "Adam", "LastName" : "Smith" }

まとめ

createIndex() で unique: true を指定することで、MongoDBのコレクションに一意インデックスを簡単に追加できます。データの整合性を保ちたいフィールド（メールアドレスやユーザーIDなど）には、この機能を活用すると効果的です。