MongoDBの$push演算子を使って条件に一致する配列要素を更新する方法

MongoDBでは、$push演算子と位置指定演算子（$）を組み合わせることで、クエリ条件に一致した配列内の要素だけを対象に、新しい値を追加・更新できます。この記事では、実際のサンプルコードを通じて、その手順を順番に解説していきます。

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

まず、insertOne()メソッドを使用して、「UserDetails」という配列フィールドを持つドキュメントを含むコレクションを作成しましょう。

> db.updateArrayElementDemo.insertOne(
   {
      "UserDetails":
      [
         {
            "UserName":"Chris",
            "UserAge":23
         }
      ]
   }
);
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5ce9029378f00858fb12e90d")
}

2. 登録されたドキュメントの確認

find()メソッドとpretty()を組み合わせることで、コレクション内のすべてのドキュメントを見やすい形式で表示できます。

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

実行すると、次のような出力が得られます。

{
   "_id" : ObjectId("5ce9029378f00858fb12e90d"),
   "UserDetails" : [
      {
         "UserName" : "Chris",
         "UserAge" : 23
      }
   ]
}

3. $pushで条件に一致する配列要素を更新する

ここからが本題です。UserAgeが23である配列要素を検索条件として指定し、その要素に対して$push演算子で「UserCountryName」という新しいフィールドを追加してみます。

ポイントは、更新ドキュメント内で使われている「$」（位置指定演算子）です。これは、クエリ条件に最初に一致した配列要素を指し示すものであり、これにより「どの配列要素を更新すればよいか」をMongoDBが自動的に判別してくれます。

db.updateArrayElementDemo.update(
   {"UserDetails.UserAge": 23},
   {"$push": {"UserDetails.$.UserCountryName": "US"}}
);
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1 })

実行結果のWriteResultを見ると、nMatched : 1（1件が条件に一致）、nModified : 1（1件が更新された）ことが分かります。つまり、意図した通りの更新が正しく行われたということです。

4. 更新後のドキュメントを確認する

もう一度find()メソッドを実行して、ドキュメントがどのように変化したのかを確認してみましょう。

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

出力は以下のようになります。

{
   "_id" : ObjectId("5ce9029378f00858fb12e90d"),
   "UserDetails" : [
      {
         "UserName" : "Chris",
         "UserAge" : 23,
         "UserCountryName" : [
             "US"
         ]
      }
   ]
}

まとめ

このように、$push演算子と位置指定演算子（$）を組み合わせれば、配列全体を置き換えることなく、条件に一致した特定の配列要素に対してのみ新しい値を追加できます。ネストされた配列データを扱う際に非常に便利なテクニックなので、ぜひ覚えておきましょう。