$sum (聚合)
定义
变更在版本5.0.
计算并返回数值值的总和。$sum忽略非数值值。
$sum在这些阶段可用
$setWindowFields(从MongoDB 5.0开始可用)
兼容性
您可以使用$sum在以下环境中部署
MongoDB Atlas:云中MongoDB部署的完全托管服务
MongoDB Enterprise:基于订阅的自托管MongoDB版本
MongoDB Community:源代码可用的免费使用和自托管MongoDB版本
语法
{ $sum: <expression> }
当不作为累加器使用时,$sum具有以下语法
{ $sum: [ <expression1>, <expression2> ... ] }
有关表达式更多信息,请参阅表达式运算符。
行为
结果数据类型
当输入类型混合时,$sum将较小的输入类型提升为两种类型中较大的类型。类型的大小取决于它表示的值范围。从最小到最大的数值类型顺序是:整数 → 长整型 → 双精度浮点型 → 十进制
输入类型中较大的一个还决定了结果类型,除非操作溢出并且超出了由较大数据类型所表示的范围。在溢出的情况下,$sum会按照以下顺序提升结果:
非数字或不存在字段
如果用于包含数字和非数字值的字段,$sum会忽略非数字值,并返回数字值的总和。
如果用于集合中任何文档中不存在的字段,$sum将返回该字段的0。
如果所有操作数都是非数字、非数组或包含null值,$sum返回0。有关$sum如何处理数组的详细信息,请参阅数组操作数。
数组操作数
在 $group 阶段,如果表达式解析为数组,$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 }处使用。
在$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.
创建一个包含加利福尼亚州(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 阶段,以输出每个 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将sumQuantityForState字段设置为使用$sum在 文档 窗口中运行的quantity值的总和该 窗口 包含从
unbounded下限到输出中当前文档之间的文档。这意味着$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 }