MongoDBでレコードが存在しない場合にのみ挿入する方法（upsert活用ガイド）

MongoDBでレコードが存在しない場合にのみ挿入するには？

MongoDBでは、update()関数の「upsert」オプションを使うことで、対象のレコードが存在しない場合にのみ新規挿入を行うことができます。upsertは「update（更新）」と「insert（挿入）」を組み合わせた言葉で、条件に一致するドキュメントがあれば更新し、存在しなければ新しいドキュメントを挿入する便利な動作です。

ここでは、実際にサンプルコレクションを作成しながら、その仕組みを確認していきましょう。

1. コレクションの作成と初期データの登録

まず、insertOne()メソッドを使ってドキュメントを含むコレクションを作成します。クエリは以下の通りです。

> db.insertIfNotExistsDemo.insertOne({"StudentName":"Mike","StudentAge":21});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c7eec7b559dd2396bcfbfc2")
}
> db.insertIfNotExistsDemo.insertOne({"StudentName":"Sam","StudentAge":22});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c7eec97559dd2396bcfbfc3")
}

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

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

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

実行結果は以下の通りです。

{
   "_id" : ObjectId("5c7eec7b559dd2396bcfbfc2"),
   "StudentName" : "Mike",
   "StudentAge" : 21
}
{
   "_id" : ObjectId("5c7eec97559dd2396bcfbfc3"),
   "StudentName" : "Sam",
   "StudentAge" : 22
}

3. レコードが存在しない場合にのみ挿入するクエリ

次に、「David」という学生のレコードがまだ存在しない場合にだけ挿入するクエリを実行します。update()の第3引数に upsert=true を指定するのがポイントです。

> key = {"StudentName":"David"}
{ "StudentName" : "David" }
> value = {"StudentName":"David","StudentAge":26}
{ "StudentName" : "David", "StudentAge" : 26 }
> db.insertIfNotExistsDemo.update(key, value, upsert=true);

実行結果は以下の通りです。「nUpserted: 1」は、一致するドキュメントがなかったため、新規に1件挿入されたことを意味します。

WriteResult({
   "nMatched" : 0,
   "nUpserted" : 1,
   "nModified" : 0,
   "_id" : ObjectId("5c7eecd4c743760e97af8261")
})

4. 挿入結果の確認

もう一度すべてのドキュメントを表示して、正しく挿入されたか確認してみましょう。

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

実行結果：

{
   "_id" : ObjectId("5c7eec7b559dd2396bcfbfc2"),
   "StudentName" : "Mike",
   "StudentAge" : 21
}
{
   "_id" : ObjectId("5c7eec97559dd2396bcfbfc3"),
   "StudentName" : "Sam",
   "StudentAge" : 22
}
{
   "_id" : ObjectId("5c7eecd4c743760e97af8261"),
   "StudentName" : "David",
   "StudentAge" : 26
}

実行結果を見ると、「StudentName: David」「StudentAge: 26」のレコードが正常に挿入されていることがわかります。

補足：最新のMongoDBでの書き方

現在のMongoDBでは、非推奨となったupdate()の代わりにupdateOne()やupdateMany()を使用し、第3引数に { upsert: true } を指定する方法が推奨されています。また、挿入時のみフィールドを設定したい場合は $setOnInsert 演算子を併用すると、より安全にデータ操作が行えます。