MongoDBでドキュメントに新しいフィールドを追加する方法（$addFields演算子の使い方）

MongoDBでは、$addFields 演算子を使うことで、既存のすべてのフィールドを保持したまま、ドキュメントに新しいフィールドを追加できます。この記事では、実際のコード例を通じて、その手順をわかりやすく解説します。

1. サンプルコレクションとドキュメントの作成

まずは、動作を確認するためのコレクションを作成しましょう。以下のクエリを実行して、サンプルドキュメントを挿入します。

> db.addFieldDemo.insertOne({"EmployeeId":101,"EmployeeName":"Larry","EmployeeDetails":{
    "EmployeeSalary":65000,"EmployeeCity":"New York","Message":"Hi"}});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5c7f654d8d10a061296a3c44")
}

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

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

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

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

{
    "_id" : ObjectId("5c7f654d8d10a061296a3c44"),
    "EmployeeId" : 101,
    "EmployeeName" : "Larry",
    "EmployeeDetails" : {
        "EmployeeSalary" : 65000,
        "EmployeeCity" : "New York",
        "Message" : "Hi"
    }
}

3. $addFields を使って新しいフィールドを追加する

ここからが本題です。aggregate() メソッド内で $addFields 演算子を使用すると、既存のフィールドをすべて残しつつ、新しいフィールドを追加できます。以下のクエリでは、ネストされた「EmployeeDetails.EmployeeSalary」の値を参照して、「EmployeeBasicSalary」という新しいフィールドをトップレベルに追加しています。

> db.addFieldDemo.aggregate([ { "$addFields": { "EmployeeBasicSalary":"$EmployeeDetails.EmployeeSalary" } } ]).pretty();

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

{
    "_id" : ObjectId("5c7f654d8d10a061296a3c44"),
    "EmployeeId" : 101,
    "EmployeeName" : "Larry",
    "EmployeeDetails" : {
        "EmployeeSalary" : 65000,
        "EmployeeCity" : "New York",
        "Message" : "Hi"
    },
    "EmployeeBasicSalary" : 65000
}

まとめ

出力結果を見ると、元のフィールド（EmployeeId、EmployeeName、EmployeeDetails）はそのまま維持され、新しく 「EmployeeBasicSalary」 フィールドが追加されていることが確認できます。

なお、$addFields は集計パイプライン上で一時的にフィールドを追加する演算子です。コレクション自体に永続的にフィールドを書き込みたい場合は、$merge や updateOne() と組み合わせて使用するか、update 操作で $set を使う方法も検討するとよいでしょう。