MongoDBで配列内の要素数をカウントする方法（$size演算子の使い方）

MongoDBで配列の要素数を取得するには？

MongoDBで配列フィールドに含まれるアイテム（要素）の数を数えたい場合は、集計フレームワーク（aggregation）の $size 演算子を使用します。$size は、指定した配列に含まれる要素の総数を数値として返してくれる便利な演算子です。

基本構文

$size 演算子を使った基本的な構文は以下のとおりです。

db.yourCollectionName.aggregate({$project:{anyFieldName:{$size:"$yourArrayName"}}}).pretty();

この構文では、$project ステージを使って新しいフィールド（anyFieldName の部分）を作成し、その値として対象の配列（yourArrayName）の要素数を $size で計算しています。

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

実際の動作を確認するために、まずドキュメントを含むコレクションを作成しましょう。以下のクエリで「getSizeOfArray」というコレクションに学生データを挿入します。

> db.getSizeOfArray.insertOne({"StudentId":1,"StudentName":"Larry","StudentMarks":[87,34,56,77,89,90]});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5c6ebc536fd07954a4890680")
}
> db.getSizeOfArray.insertOne({"StudentId":2,"StudentName":"Sam","StudentMarks":[90,76,56]});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5c6ebc6b6fd07954a4890681")
}
> db.getSizeOfArray.insertOne({"StudentId":3,"StudentName":"Carol","StudentMarks":[90,76]});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5c6ebc7a6fd07954a4890682")
}

登録したドキュメントの確認

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

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

実行結果は以下のとおりです。各ドキュメントには「StudentMarks」という配列フィールドがあり、それぞれ異なる数の点数が格納されていることがわかります。

{
    "_id" : ObjectId("5c6ebc536fd07954a4890680"),
    "StudentId" : 1,
    "StudentName" : "Larry",
    "StudentMarks" : [
        87,
        34,
        56,
        77,
        89,
        90
    ]
}
{
    "_id" : ObjectId("5c6ebc6b6fd07954a4890681"),
    "StudentId" : 2,
    "StudentName" : "Sam",
    "StudentMarks" : [
        90,
        76,
        56
    ]
}
{
    "_id" : ObjectId("5c6ebc7a6fd07954a4890682"),
    "StudentId" : 3,
    "StudentName" : "Carol",
    "StudentMarks" : [
        90,
        76
    ]
}

$size演算子で配列の要素数をカウントする

それでは、配列内のアイテム数をカウントするクエリを実行してみましょう。「StudentMarks」配列の要素数を「NumberOfItemsInArray」という新しいフィールドとして出力します。

> db.getSizeOfArray.aggregate({$project:{NumberOfItemsInArray:{$size:"$StudentMarks"}}}).pretty();

実行結果は以下のとおりです。

{ "_id" : ObjectId("5c6ebc536fd07954a4890680"), "NumberOfItemsInArray" : 6 }
{ "_id" : ObjectId("5c6ebc6b6fd07954a4890681"), "NumberOfItemsInArray" : 3 }
{ "_id" : ObjectId("5c6ebc7a6fd07954a4890682"), "NumberOfItemsInArray" : 2 }

このように、各ドキュメントごとに配列の要素数が正しく出力されました。Larry のドキュメントでは6個、Sam では3個、Carol では2個という結果になっています。

補足：$size演算子使用時の注意点

• $size 演算子は引数として配列フィールドのみを受け付けます。配列以外のフィールドを指定するとエラーになります。
• 配列フィールドが存在しないドキュメントに対して $size を適用するとエラーになるため、必要に応じて $ifNull 演算子などと組み合わせてデフォルト値を設定すると安全です。

以上のように、MongoDBの $size 演算子を使えば、配列内のアイテム数を簡単かつ効率的にカウントできます。データ分析やレポート作成の際にぜひ活用してください。