MongoDBで配列内の空のオブジェクトを削除する方法｜$pull演算子の使い方を解説

MongoDBでは、$pull演算子を使用することで、配列内に含まれる空のオブジェクト（フィールドを持たない要素）を簡単に削除できます。この記事では、実際のコード例を通じて、その手順をわかりやすく解説します。

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

まず、空のオブジェクトを含むドキュメントを持つコレクションを作成しましょう。insertOne()メソッドを使って、以下のようにデータを挿入します。

> db.removeEmptyObjectsDemo.insertOne(
    {
       "_id" :101,
       "LoginDate" :new ISODate(),
       "UserDetails" : [
          {
             "UserName" : "John"
          },
          {
          },
          {
             "UserName" : "Sam"
          }
       ]
    }
);
{ "acknowledged" : true, "insertedId" : 101 }

この例では、UserDetails配列の中に、UserNameフィールドを持たない空のオブジェクトが1つ混在しています。

2. ドキュメントの確認

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

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

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

{
   "_id" : 101,
   "LoginDate" : ISODate("2019-05-25T04:46:29.505Z"),
   "UserDetails" : [
      {
         "UserName" : "John"
      },
      {
      },
      {
         "UserName" : "Sam"
      }
   ]
}

UserDetails配列の中に、何もフィールドを持たない空のオブジェクト { } が存在していることが確認できます。

3. 空のオブジェクトを削除するクエリ

ここで本題の、配列内の空のオブジェクトを削除するクエリです。$pull演算子と$exists演算子を組み合わせて使用します。

> db.removeEmptyObjectsDemo.update(
{},
{ "$pull": { "UserDetails": { "UserName": { "$exists": false } } } },
{ "multi": true }
);
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1 })

クエリのポイント

• $pull: 指定した条件に一致する要素を配列から取り除きます。
• { "UserName": { "$exists": false } }: 「UserNameフィールドが存在しない」要素、つまり空のオブジェクトを対象とします。
• multi: true: 条件に一致するすべてのドキュメントに対して更新を適用します。

なお、MongoDBの新しいバージョンではupdate()は非推奨となっているため、代わりにupdateMany()を使用することが推奨されます。

> db.removeEmptyObjectsDemo.updateMany(
{},
{ "$pull": { "UserDetails": { "UserName": { "$exists": false } } } }
);

4. 削除結果の確認

再度find()メソッドでドキュメントを確認してみましょう。

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

実行結果は以下の通りです。空のオブジェクトが正常に削除されていることがわかります。

{
   "_id" : 101,
   "LoginDate" : ISODate("2019-05-25T04:46:29.505Z"),
   "UserDetails" : [
      {
         "UserName" : "John"
      },
      {
         "UserName" : "Sam"
      }
   ]
}

まとめ

MongoDBで配列内の空のオブジェクトを削除するには、$pull演算子と$exists: falseの条件を組み合わせるのが効果的です。この手法を使えば、特定のフィールドを持たない不要な要素だけをピンポイントで除去でき、データの整合性を保ちながらコレクションをクリーンに維持できます。