$sum（集計）

項目一覧

定義

互換性
構文
動作
例

定義

$sum

バージョン 5.0 での変更。

数値の合計を計算して返します。$sum は数値以外の値を無視します。

$sum は、次のステージで使用できます。

$addFields
$bucket
$bucketAuto
$group
$expr 式を含む $match ステージ
$project
$replaceRoot
$replaceWith
$set
$setWindowFields （MongoDB 5.0 以降で使用可能）

互換性

次の環境でホストされる配置には $sum を使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

アキュムレータとして使用する場合、$sum は次の構文をとります。

{ $sum: <expression> }

アキュムレータとして使用されていない場合、$sum は次の構文をとります。

{ $sum: [ <expression1>, <expression2> ... ]  }

式の詳細については、「式演算子」を参照してください。

動作

結果のデータ型

結果は、その型で正確に表現できない場合を除き、入力と同じ型になります。この場合、以下のとおり動作します。

結果が 64 ビット整数として表現可能な場合は、32 ビット整数は 64 ビット整数に変換されます。
結果が 64 ビット整数として表現不可能な場合は、32 ビット整数は double に変換されます。
結果が 64 ビット整数として表現不可能な場合は、64 ビット整数は double に変換されます。

数値以外の値のフィールドまたは存在しないフィールド

数値と数値以外の値の両方を含むフィールドで使用される場合、$sum は数値以外の値を無視し、数値の合計を返します。

コレクション内のどのドキュメントにも存在しないフィールドで使用された場合、 $sumはそのフィールドの0を返します。

すべてのオペランドが数値以外、配列以外、またはnull値を含む場合、 $sumは0を返します。 $sumが配列を処理する方法の詳細については、配列オペランドを参照してください。

配列オペランド

$groupステージでは、式の結果が配列となる場合、 $sumはオペランドを数値以外の値として扱います。

サポートされている他のステージでは、次のようになります。

単一の式をオペランドとして使用し、その式が配列に変換されると、 $sumは配列内を走査して配列の数値要素に対して操作を実行し、単一の値を返します。
式のリストをオペランドとして使用する場合に、式のいずれかが配列に変換されると、 $sumは配列内を走査せず、代わりに配列を数値以外の値として扱います。

例、 $groupステージで使用されない場合、次のようになります。

$sumオペランドが[ 2, 2 ]の場合、 $sumは配列要素を追加し、 4を返します。
$sumオペランドが[ 2, [ 3, 4 ] ]の場合、 $sumは2を返します。これは、ネストされた配列[ 3, 4 ]を数値以外の値として扱うためです。

例

`$group`ステージで使用

以下のドキュメントを持つsalesコレクションを考えてみましょう。

{ "_id" : 1, "item" : "abc", "price" : 10, "quantity" : 2, "date" : ISODate("2014-01-01T08:00:00Z") }
{ "_id" : 2, "item" : "jkl", "price" : 20, "quantity" : 1, "date" : ISODate("2014-02-03T09:00:00Z") }
{ "_id" : 3, "item" : "xyz", "price" : 5, "quantity" : 5, "date" : ISODate("2014-02-03T09:05:00Z") }
{ "_id" : 4, "item" : "abc", "price" : 10, "quantity" : 10, "date" : ISODate("2014-02-15T08:00:00Z") }
{ "_id" : 5, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T09:05:00Z") }

date フィールドの日付および年ごとにドキュメントをグループ化し、次の操作では $sum アキュムレータを使用して各ドキュメントグループの合計額と件数を計算します。

db.sales.aggregate(
   [
     {
       $group:
         {
           _id: { day: { $dayOfYear: "$date"}, year: { $year: "$date" } },
           totalAmount: { $sum: { $multiply: [ "$price", "$quantity" ] } },
           count: { $sum: 1 }
         }
     }
   ]
)

この操作は次の結果を返します。

{ "_id" : { "day" : 46, "year" : 2014 }, "totalAmount" : 150, "count" : 2 }
{ "_id" : { "day" : 34, "year" : 2014 }, "totalAmount" : 45, "count" : 2 }
{ "_id" : { "day" : 1, "year" : 2014 }, "totalAmount" : 20, "count" : 1 }

存在しないフィールドで$sumを使用すると、 0の値が返されます。次の操作は、$sum 上のqty を試行します。

db.sales.aggregate(
   [
     {
       $group:
         {
           _id: { day: { $dayOfYear: "$date"}, year: { $year: "$date" } },
           totalAmount: { $sum: "$qty" },
           count: { $sum: 1 }
         }
     }
   ]
)

この操作では以下が返されます。

{ "_id" : { "day" : 46, "year" : 2014 }, "totalAmount" : 0, "count" : 2 }
{ "_id" : { "day" : 34, "year" : 2014 }, "totalAmount" : 0, "count" : 2 }
{ "_id" : { "day" : 1, "year" : 2014 }, "totalAmount" : 0, "count" : 1 }

$count 集計アキュムレータは、$group ステージで{ $sum : 1 } の代わりに使用できます。

Tip

以下も参照してください。

$count (aggregation accumulator)

`$project`ステージで使用

コレクション students には次のドキュメントが含まれています。

{ "_id": 1, "quizzes": [ 10, 6, 7 ], "labs": [ 5, 8 ], "final": 80, "midterm": 75 }
{ "_id": 2, "quizzes": [ 9, 10 ], "labs": [ 8, 8 ], "final": 95, "midterm": 80 }
{ "_id": 3, "quizzes": [ 4, 5, 5 ], "labs": [ 6, 5 ], "final": 78, "midterm": 70 }

次の例では、ステージのを使用して、クイズの合計スコア、ラボ$sum $projectスコアの合計、最終と中間者の合計を計算します。

db.students.aggregate([
   {
     $project: {
       quizTotal: { $sum: "$quizzes"},
       labTotal: { $sum: "$labs" },
       examTotal: { $sum: [ "$final", "$midterm" ] }
     }
   }
])

この操作の結果、次のドキュメントが作成されます。

{ "_id" : 1, "quizTotal" : 23, "labTotal" : 13, "examTotal" : 155 }
{ "_id" : 2, "quizTotal" : 19, "labTotal" : 16, "examTotal" : 175 }
{ "_id" : 3, "quizTotal" : 14, "labTotal" : 11, "examTotal" : 148 }

`$setWindowFields`ステージで使用

バージョン 5.0 で追加

カリフォルニア州（CA）とワシントン州（WA）のケーキ販売を含む cakeSales コレクションを作成します。

db.cakeSales.insertMany( [
   { _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"),
     state: "CA", price: 13, quantity: 120 },
   { _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"),
     state: "WA", price: 14, quantity: 140 },
   { _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"),
     state: "CA", price: 12, quantity: 145 },
   { _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"),
     state: "WA", price: 13, quantity: 104 },
   { _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"),
     state: "CA", price: 41, quantity: 162 },
   { _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"),
     state: "WA", price: 43, quantity: 134 }
] )

この例では、$sum $setWindowFieldsステージのquantity を使用して、各で販売されたケーキのstate の合計を出力します。

db.cakeSales.aggregate( [
   {
      $setWindowFields: {
         partitionBy: "$state",
         sortBy: { orderDate: 1 },
         output: {
            sumQuantityForState: {
               $sum: "$quantity",
               window: {
                  documents: [ "unbounded", "current" ]
               }
            }
         }
      }
   }
] )

この例では、次のことが行われます。

partitionBy: "$state" はコレクション内のドキュメントを state で分割します。CA と WA のパーティションがあります。
sortBy: { orderDate: 1 } は、各パーティション内のドキュメントを orderDate で昇順（1）に並べ替えるので、最も古い orderDate が最初になります。

output はドキュメントウィンドウ内で実行される $sum を使用してsumQuantityForState フィールドを quantity 値の合計に設定します。
ウィンドウには、 unbounded下限とcurrentドキュメントの間にあるドキュメントが出力されます。つまり、 $sumは、パーティションの先頭から現在のドキュメントまでのドキュメントのquantity値の合計を返します。

この出力では、CA と WA の quantity 値の合計が sumQuantityForState フィールドに表示されます。

{ "_id" : 4, "type" : "strawberry", "orderDate" : ISODate("2019-05-18T16:09:01Z"),
  "state" : "CA", "price" : 41, "quantity" : 162, "sumQuantityForState" : 162 }
{ "_id" : 0, "type" : "chocolate", "orderDate" : ISODate("2020-05-18T14:10:30Z"),
  "state" : "CA", "price" : 13, "quantity" : 120, "sumQuantityForState" : 282 }
{ "_id" : 2, "type" : "vanilla", "orderDate" : ISODate("2021-01-11T06:31:15Z"),
  "state" : "CA", "price" : 12, "quantity" : 145, "sumQuantityForState" : 427 }
{ "_id" : 5, "type" : "strawberry", "orderDate" : ISODate("2019-01-08T06:12:03Z"),
  "state" : "WA", "price" : 43, "quantity" : 134, "sumQuantityForState" : 134 }
{ "_id" : 3, "type" : "vanilla", "orderDate" : ISODate("2020-02-08T13:13:23Z"),
  "state" : "WA", "price" : 13, "quantity" : 104, "sumQuantityForState" : 238 }
{ "_id" : 1, "type" : "chocolate", "orderDate" : ISODate("2021-03-20T11:30:05Z"),
  "state" : "WA", "price" : 14, "quantity" : 140, "sumQuantityForState" : 378 }

戻る

$subtract

$switch

定義

互換性

構文

動作