MongoDBで既存の配列に要素を追加する方法（$addToSet演算子の使い方）

MongoDBで既存の配列に新しい要素を追加するには、update()メソッドと組み合わせて$addToSet演算子を使用します。$addToSetは、指定した値が配列内に存在しない場合のみ追加するため、重複を防ぎながら安全に要素を追加できるのが特徴です。

1. サンプルコレクションの作成

まず、ドキュメントを含むコレクションを作成しましょう。以下のコマンドを実行します。

> db.pushElements.insertOne({"Comments":["Good","Awesome","Nice"]});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5cd682597924bb85b3f48953")
}

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

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

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

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

{
    "_id" : ObjectId("5cd682597924bb85b3f48953"),
    "Comments" : [
        "Good",
        "Awesome",
        "Nice"
    ]
}

3. $addToSetを使って配列に要素を追加する

それでは、既存の配列に新しい要素「Cool」を追加してみましょう。以下のようにupdate()メソッドと$addToSet演算子を組み合わせてクエリを実行します。

> db.pushElements.update(
    {_id:ObjectId("5cd682597924bb85b3f48953")},
    { "$addToSet":{"Comments":"Cool"} },
    upsert=true
);
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1 })

出力結果のnModified : 1は、1件のドキュメントが正常に更新されたことを示しています。

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

もう一度find()メソッドを実行して、ドキュメントが正しく更新されたか確認しましょう。

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

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

{
    "_id" : ObjectId("5cd682597924bb85b3f48953"),
    "Comments" : [
        "Good",
        "Awesome",
        "Nice",
        "Cool"
    ]
}

このように、「Cool」が配列の末尾に追加されていることがわかります。

$addToSetと$pushの違い

なお、MongoDBには配列への要素追加に使える$push演算子もあります。両者の主な違いは以下のとおりです。

• $addToSet：同じ値がすでに配列内に存在する場合は追加しない（重複防止）
• $push：重複があってもそのまま配列の末尾に追加する

重複したデータを避けたい場合は$addToSetを、意図的に同じ値を複数回追加したい場合は$pushを選択するとよいでしょう。