MongoDBでlimit（制限）を使いながらドキュメントの総数を取得する方法

MongoDBでは、$facet演算子を利用することで、limit（制限）をかけたデータの取得と、コレクション内のドキュメント総数のカウントを、1回の集計クエリで同時に行うことができます。ページネーション機能を実装する際に非常に便利なテクニックです。ここでは、具体的なコード例を通じてその方法を解説します。

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

まず、仕組みを理解するために、ドキュメントを含むコレクションを作成します。コレクションを作成するクエリは以下の通りです。

> db.totalDocumentDemo.insertOne({"InstructorId":100,"InstructorName":"Larry","InstructorFavouriteSubject":["Java","MongoDB","Python"]});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c76e6701e9c5dd6f1f78274")
}
> db.totalDocumentDemo.insertOne({"InstructorId":200,"InstructorName":"Sam","InstructorFavouriteSubject":["SQL Server","C#","Javascript"]});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c76e69c1e9c5dd6f1f78275")
}

続いて、find()メソッドを使ってコレクション内のすべてのドキュメントを表示します。クエリは以下の通りです。

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

出力結果

{
   "_id" : ObjectId("5c76e6701e9c5dd6f1f78274"),
   "InstructorId" : 100,
   "InstructorName" : "Larry",
   "InstructorFavouriteSubject" : [
      "Java",
      "MongoDB",
      "Python"
   ]
}
{
   "_id" : ObjectId("5c76e69c1e9c5dd6f1f78275"),
   "InstructorId" : 200,
   "InstructorName" : "Sam",
   "InstructorFavouriteSubject" : [
      "SQL Server",
      "C#",
      "Javascript"
   ]
}

$facet演算子でドキュメント総数を取得する

ここからが本題です。コレクション内のドキュメント総数を取得するには、以下のようにaggregate()メソッドと$facet演算子を組み合わせます。$facetの内部では、$matchですべてのドキュメントを取得するサブパイプライン（Alldata）と、$countで総件数をカウントするサブパイプライン（totalDocument）を並行して実行しています。

> db.totalDocumentDemo.aggregate([
...   {
...     $facet:{
...       Alldata:[{$match:{}}],
...       totalDocument: [{ $count: 'totalDocument' }]
...     }
...   }
... ]).pretty();

以下は実行結果です。「Alldata」にはすべてのドキュメントが格納され、「totalDocument」にはドキュメントの総数が出力されます。

出力結果

{
   "Alldata" : [
      {
         "_id" : ObjectId("5c76e6701e9c5dd6f1f78274"),
         "InstructorId" : 100,
         "InstructorName" : "Larry",
         "InstructorFavouriteSubject" : [
            "Java",
            "MongoDB",
            "Python"
         ]
      },
      {
         "_id" : ObjectId("5c76e69c1e9c5dd6f1f78275"),
         "InstructorId" : 200,
         "InstructorName" : "Sam",
         "InstructorFavouriteSubject" : [
            "SQL Server",
            "C#",
            "Javascript"
         ]
      }
   ],
   "totalDocument" : [
      {
         "totalDocument" : 2
      }
   ]
}

まとめ

$facet演算子を使えば、単一の集計パイプラインの中で複数のサブパイプラインを並行処理できるため、「条件に一致する全データの取得」と「ドキュメント総数のカウント」を同時に実現できます。上記の出力例ではtotalDocumentの値が「2」となっており、コレクション内に2件のドキュメントが存在することが確認できます。limitやskipと組み合わせることで、ページネーション実装時に必要となる「表示対象データ」と「総件数」を効率よく取得できるでしょう。