カスタム_id値を使用したMongoDBのアップサート：ドキュメントが存在しない場合に挿入する方法

MongoDBでカスタムの_id値を使用してドキュメントを挿入するには、insert()メソッドを使用します。ただし、同じカスタム_id値を持つドキュメントがすでにコレクション内に存在する場合、挿入操作は失敗し、エラーが表示されます。

insert()でカスタム_idを指定した場合の挙動

まず、ドキュメントを含むコレクションを作成してみましょう。以下の例では、同じ_id値を持つドキュメントを再度追加しようとした結果、エラーが発生する様子を確認できます。

> db.customIdDemo.insert({"_id":1,"StudentName":"John"});
WriteResult({ "nInserted" : 1 })
> db.customIdDemo.insert({"_id":1,"StudentName":"Carol"});
WriteResult({
   "nInserted" : 0,
   "writeError" : {
      "code" : 11000,
      "errmsg" : "E11000 duplicate key error collection: admin.customIdDemo index: _id_ dup key: { : 1.0 }"
   }
})
> db.customIdDemo.insert({"_id":2,"StudentName":"Carol"});
WriteResult({ "nInserted" : 1 })
> db.customIdDemo.insert({"_id":2,"StudentName":"Carol"});
WriteResult({
   "nInserted" : 0,
   "writeError" : {
      "code" : 11000,
      "errmsg" : "E11000 duplicate key error collection: admin.customIdDemo index: _id_ dup key: { : 2.0 }"
   }
})
> db.customIdDemo.insert({"_id":3,"StudentName":"Chris"});
WriteResult({ "nInserted" : 1 })

上記の出力から、_id値が1と2のドキュメントを再度挿入しようとした際に、E11000「duplicate key error（重複キーエラー）」が発生していることがわかります。これは、_idフィールドがコレクション内で一意である必要があるためです。

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

find()メソッドを使用して、コレクション内のすべてのドキュメントを表示するクエリは以下のとおりです。

> db.customIdDemo.find().pretty();

このクエリを実行すると、次の出力が得られます。

{ "_id" : 1, "StudentName" : "John" }
{ "_id" : 2, "StudentName" : "Carol" }
{ "_id" : 3, "StudentName" : "Chris" }

upsertオプションでドキュメントが存在しない場合のみ挿入する

「ドキュメントが存在しない場合は挿入し、存在する場合は更新する」というアップサート（upsert）処理を行いたい場合は、update()メソッドやreplaceOne()メソッドに「upsert: true」オプションを指定します。

> db.customIdDemo.update(
...    { "_id" : 1 },
...    { $set : { "StudentName" : "John Smith" } },
...    { upsert : true }
... );
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1 })

> db.customIdDemo.update(
...    { "_id" : 4 },
...    { $set : { "StudentName" : "David" } },
...    { upsert : true }
... );
WriteResult({ "nMatched" : 0, "nUpserted" : 1, "nModified" : 0 })

この例では、_idが1のドキュメントはすでに存在するため更新され（nModified: 1）、_idが4のドキュメントは存在しないため新規挿入（nUpserted: 1）されます。これにより、重複キーエラーを回避しながら、カスタム_id値を使った柔軟なデータ管理が可能になります。

まとめ

単純なinsert()では、同じ_id値を持つドキュメントの再挿入はできず、E11000エラーが発生します。しかし、upsert: trueオプションを活用することで、「存在しない場合のみ挿入し、存在する場合は更新する」という処理を安全かつ効率的に実現できます。