MongoDBのupdate()と$pull演算子で配列から特定の要素を削除する方法

MongoDBでは、配列フィールドから特定の要素を削除したい場面がよくあります。そんなときに便利なのが、update()メソッドと$pull演算子の組み合わせです。この記事では、実際のコード例を通して、その使い方をわかりやすく解説します。

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

まず、配列フィールドを持つドキュメントを含むコレクションを作成します。ここでは「UserMessage」という配列フィールドを持つドキュメントを挿入してみましょう。

> db.removingAnArrayElementDemo.insertOne({"UserMessage":["Hi","Hello","Bye"]});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5cef97bdef71edecf6a1f6a4")
}

2. 挿入したドキュメントの確認

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

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

出力結果

{
   "_id" : ObjectId("5cef97bdef71edecf6a1f6a4"),
   "UserMessage" : [
      "Hi",
      "Hello",
      "Bye"
   ]
}

3. $pull演算子で配列要素を削除する

それでは、$pull演算子を使って、配列から「Hello」という要素を削除してみましょう。第一引数には対象ドキュメントを特定する条件（_idなど）を指定し、第二引数の$pullで削除したい値を指定します。

> db.removingAnArrayElementDemo.update(
   {_id:ObjectId("5cef97bdef71edecf6a1f6a4")},
   { "$pull": { "UserMessage": "Hello" } }
);
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1 })

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

4. 削除後のドキュメントを再確認

もう一度find()メソッドでドキュメントを確認すると、「Hello」が配列から取り除かれていることがわかります。

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

出力結果

{
   "_id" : ObjectId("5cef97bdef71edecf6a1f6a4"),
   "UserMessage" : [
      "Hi",
      "Bye"
   ]
}

補足：新しいバージョンでの推奨メソッド

MongoDB 5.0以降では、update()メソッドは非推奨となっており、代わりにupdateOne()やupdateMany()の使用が推奨されています。同じ処理は以下のように書き換えられます。

> db.removingAnArrayElementDemo.updateOne(
   {_id:ObjectId("5cef97bdef71edecf6a1f6a4")},
   { "$pull": { "UserMessage": "Hello" } }
);

$pull演算子は、指定した値に一致するすべての要素を配列から削除できる強力なツールです。条件式（$gteや$inなど）と組み合わせれば、より柔軟な削除操作も可能になります。ぜひ活用してみてください。