MongoDB聚合运算符：$sum

$sum聚合运算符返回数值的合计值，计算式 $sum会忽略非数值的值。

$sum适用于以下阶段：

• $addFields阶段（从MongoDB3.4开始支持）
• $bucket阶段
• $budketAuto阶段
• $group阶段
• $match阶段的$expr表达式
• $replaceRoot阶段（从MongoDB3.4开始支持）
• $replaceWith阶段（从MongoDB4.2开始支持）
• $set阶段（从MongoDB4.2开始支持）
• $setWindowFields阶段（从MongoDB5.0开始支持）

语法

当$sum用作累加器时，语法为：

{ $sum: <expression> }

当$sum用于非累加器时，语法为：

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

使用

返回的数据类型

结果将与输入具有相同的类型，除非无法用该类型准确表示，在这些情况下：

• 如果结果可表示为64位整数，则32位整数将转换为64位整数。
• 如果结果无法表示为64位整数，则32位整数将转换为双精度型。
• 如果结果不能表示为64位整数，则64位整数将转换为double。

非数值或缺失字段的处理

• 如果用于同时包含数字值和非数字值的字段，$sum忽略非数字值并返回数字值的总和。
• 如果用于集合中任何文档中都不存在的字段，则$sum会为该字段返回0。
• 如果所有操作数都是非数字，则$sum返回0。

数组操作数

在$group阶段，如果表达式解析为数组，$sum会将操作数视为非数字值，对于其他支持的阶段：

• 当使用单个表达式作为操作数，如果表达式解析为数组，则$sum会遍历数组，对数字元素进行操作，返回累加值。
• 当使用表达式列表作为操作数，如果表达式解析为数组，$sum不会遍历数组，而是将数组视为非数字值。

举例

应用于$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 }

在$group阶段可以使用{$sum:1}平替$count。

应用于$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阶段

使用下面的脚本创建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 输出每个州蛋糕销售数量的合计：

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对分区内文档进行由小到大的排序，orderDate最早的排在第一个。
• output使用$sum将窗口内文档的quantity合计值赋予sumQuantityForState字段。窗口包含无界下限和输出中的当前文档之间的文档，这意味着$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 }