MongoDBで共通フィールドを持つすべてのドキュメントをグループ化する方法

MongoDBで共通フィールド（同じ値を持つフィールド）に基づいてドキュメントをグループ化したい場合、集計フレームワーク（Aggregation Framework）の $group ステージと $addToSet 演算子を組み合わせて使用します。この記事では、実際のコード例を通じてその手順をわかりやすく解説します。

$addToSet演算子とは

$addToSet は、グループ化の際に重複しない値だけを配列に追加するための演算子です。共通フィールドごとに関連するドキュメントの情報をまとめる際に非常に便利です。

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

まず、ドキュメントを含むコレクションを作成しましょう。ここでは「findDocumentWithCommonFieldsDemo」というコレクションに3件のドキュメントを挿入します。

> db.findDocumentWithCommonFieldsDemo.insertOne(
    {
       "UserId":1,
       "UserName":"Carol"
    }
);
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5cdf8ebebf3115999ed51200")
}
> db.findDocumentWithCommonFieldsDemo.insertOne(
    {
       "UserId":2,
       "UserName":"David"
    }
);
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5cdf8ebebf3115999ed51201")
}
>
> db.findDocumentWithCommonFieldsDemo.insertOne(
    {
       "UserId":1,
       "UserName":"Sam"
    }
);
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5cdf8ebebf3115999ed51202")
}

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

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

> db.findDocumentWithCommonFieldsDemo.find();

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

{ "_id" : ObjectId("5cdf8ebebf3115999ed51200"), "UserId" : 1, "UserName" : "Carol" }
{ "_id" : ObjectId("5cdf8ebebf3115999ed51201"), "UserId" : 2, "UserName" : "David" }
{ "_id" : ObjectId("5cdf8ebebf3115999ed51202"), "UserId" : 1, "UserName" : "Sam" }

ここで注目すべきは、「UserId」が1であるドキュメントが2件存在することです。これらをグループ化していくのが今回の目的です。

共通フィールドによるドキュメントのグループ化

それでは、aggregate()メソッドと$groupステージ、そして$addToSet演算子を使って、「UserId」という共通フィールドでドキュメントをグループ化してみましょう。

> db.findDocumentWithCommonFieldsDemo.aggregate({$group : {_id : "$UserId", "UserDetails": {$addToSet : "$UserName"}}});

このクエリを実行すると、次の出力が得られます。

{ "_id" : 2, "UserDetails" : [ "David" ] }
{ "_id" : 1, "UserDetails" : [ "Sam", "Carol" ] }

結果の解説

出力結果を見ると、_id フィールドにはグループ化のキーとなった「UserId」の値が格納され、UserDetails フィールドには同じUserIdを持つドキュメントの「UserName」が配列としてまとめられています。UserId が 1 のドキュメントは2件あるため、"Sam" と "Carol" の両方が配列に含まれています。

まとめ

MongoDBで共通フィールドを持つドキュメントをグループ化するには、aggregate()メソッド内で$groupステージを使用し、_idにグループ化のキーとなるフィールドを指定します。さらに、$addToSet演算子を使うことで、各グループに属するドキュメントの特定フィールドの値を重複なく配列として取得できます。なお、似た用途で使われる$push演算子との違いは、$addToSetが重複する値を自動的に排除する点です。データの性質に応じて使い分けるとよいでしょう。