$sum（聚合）

在此页面上

定义

兼容性
语法
行为
示例

定义

$sum

5.0 版本中的更改。

计算并返回数字值的总和。$sum 忽略非数值。

$sum 可在以下阶段使用：

兼容性

可以使用 $sum 查找托管在以下环境中的部署：

MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本
MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

语法

当用作累加器时，$sum 的语法如下：

{ $sum: <expression> }

当不用作累加器时，$sum 的语法如下：

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

有关表达式的更多信息，请参阅表达式运算符。

行为

结果数据类型

当混合输入类型时，$sum 会将较小的输入类型提升为两者中较大的输入类型。当一个类型表示更广泛的值时，该类型被视为较大。数字类型从小到大的顺序为：integer → long → double → decimal

较大的输入类型也决定了结果类型，除非操作溢出，超出了较大数据类型所代表的范围。在溢出的情况下，$sum 按照以下顺序推送结果：

如果较大的输入类型为 integer，则结果类型将提升为 long。
如果较大的输入类型为 long，则结果类型将提升为 double。
如果较大的类型是 double 或 decimal，则溢出结果表示为 + 或 - 无穷大。没有对结果进行类型推送。

非数字或不存在的字段

如果用于同时包含数字值和非数字值的字段，$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 值。以下操作尝试在 qty 上执行 $sum：

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 }。

提示

另请参阅：

$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 }

以下示例在 $project 阶段使用 $sum 来计算测验总分数、实验总分数以及期末和期中考试的总分数：

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 中的新增功能。

创建cakeSales集合，其中包含加利福尼亚州 ( CA ) 和华盛顿州 ( WA ) 的蛋糕销售情况：

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 }
] )

此示例在 $setWindowFields 阶段使用 $sum 输出每个 state 售出的蛋糕的总和 quantity：

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

定义

兼容性

语法

行为