MongoDBに現在の日時を挿入する方法【$setOnInsert演算子の使い方】

現在の日時をMongoDBに挿入する方法

MongoDBに現在の日時を挿入したい場合は、$setOnInsert演算子を使用します。この演算子は、upsert操作によって新しいドキュメントが挿入される際にのみ値を設定するため、作成日時や登録日時の記録に非常に便利です。

まずはサンプル用のコレクション「addCurrentDateTimeDemo」を作成し、ドキュメントをいくつか登録しておきましょう。以下のクエリを実行します。

>db.addCurrentDateTimeDemo.insertOne({"StudentName":"John","StudentAdmissionDate":new Date("2012-01-21") });
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c97ae45330fd0aa0d2fe49f")
}
>db.addCurrentDateTimeDemo.insertOne({"StudentName":"Carol","StudentAdmissionDate":new Date("2013-05-24") });
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c97ae54330fd0aa0d2fe4a0")
}
>db.addCurrentDateTimeDemo.insertOne({"StudentName":"Carol","StudentAdmissionDate":new Date("2019-07-26") });
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c97ae5f330fd0aa0d2fe4a1")
}

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

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

上記のクエリを実行すると、次のような出力が得られます。

{
   "_id" : ObjectId("5c97ae45330fd0aa0d2fe49f"),
   "StudentName" : "John",
   "StudentAdmissionDate" : ISODate("2012-01-21T00:00:00Z")
}
{
   "_id" : ObjectId("5c97ae54330fd0aa0d2fe4a0"),
   "StudentName" : "Carol",
   "StudentAdmissionDate" : ISODate("2013-05-24T00:00:00Z")
}
{
   "_id" : ObjectId("5c97ae5f330fd0aa0d2fe4a1"),
   "StudentName" : "Carol",
   "StudentAdmissionDate" : ISODate("2019-07-26T00:00:00Z")
}

それでは本題である、現在の日時を挿入するクエリを見ていきます。ここでは新しい学生レコードを追加しつつ、その中に現在の日時を設定しています。

> db.addCurrentDateTimeDemo.update( { _id: 1 }, { $set: { StudentName: "Robert" }, $setOnInsert: { StudentAdmissiondate: new Date() } }, { upsert: true } );
WriteResult({ "nMatched" : 0, "nUpserted" : 1, "nModified" : 0, "_id" : 1 })

このクエリでは_idが「1」のドキュメントを検索していますが、該当するドキュメントはまだ存在しません。そこでupsert: trueオプションにより新しいドキュメントが挿入され、$setOnInsertに指定した現在の日時が自動的に書き込まれます。WriteResultの「nUpserted : 1」は、新規に1件のドキュメントが挿入されたことを示しています。

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

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

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

{
   "_id" : ObjectId("5c97ae45330fd0aa0d2fe49f"),
   "StudentName" : "John",
   "StudentAdmissionDate" : ISODate("2012-01-21T00:00:00Z")
}
{
   "_id" : ObjectId("5c97ae54330fd0aa0d2fe4a0"),
   "StudentName" : "Carol",
   "StudentAdmissionDate" : ISODate("2013-05-24T00:00:00Z")
}
{
   "_id" : ObjectId("5c97ae5f330fd0aa0d2fe4a1"),
   "StudentName" : "Carol",
   "StudentAdmissionDate" : ISODate("2019-07-26T00:00:00Z")
}
{
   "_id" : 1,
   "StudentAdmissiondate" : ISODate("2019-03-24T16:21:21.269Z"),
   "StudentName" : "Robert"
}

出力結果をご覧ください。「2019-03-24T16:21:21.269Z」という現在の日時が、新しいドキュメントに正常に挿入されていることが確認できます。

$setOnInsert演算子を使う際のポイント

• 新規挿入時にのみ動作する： $setOnInsertは、upsert操作でドキュメントが新しく挿入される場合にだけフィールドを設定します。既存のドキュメントがマッチした場合、指定したフィールドは一切変更されません。
• new Date()で現在日時を取得できる： フィールドの値としてnew Date()を指定すれば、クエリ実行時点の現在の日時が自動的に記録されます。
• 最新バージョンではupdateOne()を推奨： update()メソッドは非推奨となっているため、MongoDBの新しいバージョンではupdateOne()またはupdateMany()への置き換えが推奨されています。引数の構造は同じなので、メソッド名を書き換えるだけでそのまま利用できます。

このように、$setOnInsertとupsertオプションを組み合わせることで、ドキュメントの作成日時を簡単かつ確実に記録できます。ログ管理や履歴管理など、タイムスタンプが必要な場面でぜひ活用してください。