聚合管道快速参考
在本页面
db.collection.aggregate( [ { <stage> }, ... ] )
阶段 | 描述 |
---|---|
向文档添加新字段。类似于$project,$addFields重塑了流中的每个文档;具体而言,通过向输出文档添加新字段,该文档包含输入文档和新添加字段中的现有字段。 $set 是$addFields 的别名。 | |
根据指定的表达式和存储区边界,将传入的文档分组,称为bucket。 | |
根据指定的表达式将传入的文档分类为特定数量的组(称为bucket)。自动确定bucket边界,以便将文档均匀地分配到指定数量 的bucket中。 | |
返回有关集合或视图的统计信息。 | |
返回聚合管道此阶段的文档数量计数。 | |
对集合执行递归搜索。对于每个输出文档,添加一个新的数组字段,该字段包含该文档的递归搜索的遍历结果。 | |
按指定的标识符表达式对文档进行分组,并将累加器表达式(如果指定)应用于每个组。使用所有输入文档并为每个不同的组输出一个 文档。输出文档只包含标识符字段和累积字段(如果指定的话)。 | |
返回有关集合的每个索引的使用情况的统计信息。 | |
将未修改的前 n 个文档传递给管道,其中 n 是指定的限制。对于每个输入文档,输出一个文档(对于前 n 个文档)或零文档(在前 n 个文档之后)。 | |
列出足以传播到 system.sessions 集合的所有会话。 | |
对同一数据库中的另一个集合执行左外连接,从“已连接”集合中过滤文档以进行处理。 | |
将聚合管道的结果文档写入集合。这个阶段可以将结果合并到一个输出集合中(插入新文档、合并文档、替换文档、保留现有文档、操作失败、使用自定义更新管道处理文档)。要使用 $merge 阶段,它必须是管道中的最后一个阶段。 version 4.2 中的新功能 | |
返回集合的计划缓存信息。 | |
从输入中随机选择指定数量的文档。 | |
跳过前 n 个文档,其中 n 是指定的跳过编号,并将其余未修改的文档传递给管道。对于每个输入文档,输出零文档(对于前 n 个文档)或一个文档(如果在前 n 个文档之后)。 | |
按指定的排序键重新排序文档。只有顺序改变;文件保持不变。对于每个输入文档,输出一个文档。 | |
根据指定表达式的值对传入文档进行分组,然后计算每个不同组中的文档计数。 | |
执行两个集合的并集;例如,将来自两个集合的管道结果组合成一个结果集。 version 4.4 中的新功能 | |
解析输入文档中的数组字段,为每个元素输出一个文档。每个输出文档用一个元素 值替换数组。对于每个输入文档,输出n个文档,其中n是数组元素的数量,对于空数组可以为零。 |
db.aggregate( [ { <stage> }, ... ] )
阶段 | 描述 |
---|---|
返回有关 MongoDB 部署的活动 and/or 休眠操作的信息。 | |
从MongoDB 4.2开始,你可以使用聚合管道更新:
对于更新,管道可以包括以下阶段:
[success] 也可以看看
聚合表达式使用字段路径来访问输入文档中的字段。要指定字段路径,请在字段名或虚线字段名(如果字段在嵌入的文档中)前加上美元符号$。例如,“
$user
”指定用户字段的字段路径,“$user.name
”指定“user.name
”字段的字段路径。变量 | 通过$$访问 | 简介/描述 |
---|---|---|
$$NOW | 返回当前的日期时间值,该值在部署 的所有成员之间是相同的,并在整个聚合管道中保持不变。(4.2 + 版本中可用) | |
$$CLUSTER_TIME | 返回当前时间戳值,该值在部署的所有成员之间是相同的,并在整个聚合管道中保持不变。仅用于复制集和分片集群。(4.2 + 版本中可用) | |
$$ROOT | 引用根文档,即:顶级文档。 | |
$$CURRENT | ||
$$REMOVE | 允许有条件地排除字段。(3.6 + 版本中可用) | |
$$DESCEND | ||
$$PRUNE | ||
$$KEEP |
Literals 可以是任何类型。但是,MongoDB将以美元符号
$
开头的字符串字面值作为字段的路径,并将表达式对象中的数值/布尔字面值作为投影标志。为了避免解析文字,可以使用$literal表达式。表达式对象具有以下形式:
{ <field1>: <expression1>, ... }
在这个部分
运算符表达式与采用带参数的函数类似。通常,这些表达式有一个数组参数 并具有以下形式:
{ <operator>: [ <argument1>, <argument2> ... ] }
如果操作符接受单个参数,则可以省略指定参数列表的外部数组:
{ <operator>: <argument> }
算术表达式对数字执行数学运算。一些算术表达式也可以支持日期算术。
名称 | 描述 |
---|---|
返回数字的绝对值。 | |
添加 numbers 以返回总和,或添加 numbers 和 date 以返回新的 date。如果添加 numbers 和 date,则将 numbers 视为毫秒。接受任意数量的参数表达式,但最多只能有一个表达式解析为 date。 | |
返回大于或等于指定数字的最小整数。 | |
返回将第一个数除以第二个数的结果。接受两个参数表达式。 | |
将 e 提高到指定的 指数。 | |
返回小于或等于指定数字的最大整数。 | |
计算数字的自然对数。 | |
计算指定基数中的数字的对数。 | |
计算以10为底的对数。 | |
返回第一个数字除以第二个数字的余数。接受两个参数表达式。 | |
将数字相乘返回乘积。接受任意数量的参数表达式。 | |
将数字提高到指定的指数。 | |
将数字四舍五入为整数或指定的小数位。 | |
计算平方根。 | |
返回从第一个值中减去第二个值的结果。如果这两个值是数字,返回差值。如果这两个值是日期,则返回差值(以毫秒为单位)。如果这两个值是日期和一个以毫秒为单位的数字,返回结果日期。接受两个参数表达式。如果这两个值是日期和数字,请首先指定 date 参数,因为从数字中减去 date 没有意义。 | |
将数字截断为整数或指定的小数位。 |
名称 | 描述 |
---|---|
返回指定的数组索引处的元素。 | |
将键值对的数组转换为文档。 | |
连接数组以返回连接的数组。 | |
选择 array 的子集以 return array 仅包含 match 过滤条件的元素。 | |
返回一个 boolean 值,指示指定的值是否在列表中。 | |
搜索列表以查找指定值的出现并返回第一个匹配项的数组索引。如果未找到子字符串,则返回 -1 。 | |
确定操作数是否为数组。返回 boolean 值。 | |
将子表达式应用于数组的每个元素,并按顺序返回结果值的数组。接受命名参数。 | |
将文档转换为表示键值对的文档的数组。 | |
根据用户定义的输入输出包含整数序列的数组。 | |
将表达式应用于数组中的每个元素,并将它们组合为单个值。 | |
返回元素顺序相反的数组。 | |
返回数组中的元素数。接受单个表达式作为参数。 | |
返回数组的子集。 | |
将两个数组合并在一起。 |
Boolean 表达式将其参数表达式计算为布尔值,并返回一个boolean值作为结果。
除了
false
布尔值之外,Boolean 表达式的计算结果如下:null
,0
和undefined
值。 Boolean 表达式将所有其他值计算为true
,包括非零数值和数组。名称 | 描述 |
---|---|
定义一个自定义累加器函数 version 4.4 新功能 | |
定义一个自定义函数 version 4.4 新功能 |
以下运算符返回数据元素的大小:
名称 | 描述 |
---|---|
返回给定字符串或二进制数据值内容的字节大小。 | |
返回编码为BSON的给定文档(例如:bsontype对象)的字节大小。 |
以下操作符返回 date 对象或 date 对象的组件:
名称 | 描述 |
---|---|
给出日期的组成部分,构造一个 BSON Date 对象。 | |
将 date/time 字符串转换为 date 对象。 | |
返回包含日期组成部分的文档。 | |
将 date 作为格式化的字符串返回。 | |
将 date 的月中某天返回为 1 到 31 之间的数字。 | |
将 date 的星期几返回为 1(星期日)和 7(星期六)之间的数字。 | |
将 date 的年中日期作为 1 到 366(闰年)之间的数字返回。 | |
将 date 的小时数作为 0 到 23 之间的数字返回。 | |
返回 ISO 8601 格式的工作日编号,范围从 1 (星期一)到7 (星期日)。 | |
返回 ISO 8601 格式的周数,范围从 1 到53 。 Week numbers 从1 开始,周(星期一到星期日)包含年份的第一个星期四。 | |
以 ISO 8601 格式返回年份编号。年份从第 1 周的星期一(ISO 8601)开始,结束于上周的星期日(ISO 8601)。 | |
返回 date 的毫秒数,作为 0 到 999 之间的数字。 | |
将 date 的分钟作为 0 到 59 之间的数字返回。 | |
将 date 的月份返回为 1(1 月)和 12(12 月)之间的数字。 | |
返回 date 的秒数,作为 0 到 60 之间的数字(闰秒)。 | |
将值转换为日期。 version 4.0 中的新功能。 | |
返回日期的周数,该数字介于0(一年的第一个星期日之前的部分周)和53(闰年)之间。 | |
将日期的年份作为数字返回(例: 2014)。 |
以下算术运算符可以使用日期操作数:
名称 | 描述 |
---|---|
将多个文档合并为一个文档。 version 3.6 中的新内容。 | |
将文档转换为表示键值对的文档的数组。 version 3.6 中的新内容。 |
Set 表达式对数组执行 set 操作,将数组视为集合。 Set 表达式忽略每个输入数组中的重复条目和元素的顺序。
如果 set 操作返回一个集合,则该操作会过滤掉结果中的重复项,以输出仅包含唯一条目的数组。输出数组中元素的顺序未指定。
如果集合包含嵌套的数组元素,则 set 表达式不会深入到嵌套的数组中,而是在最外层处计算数组。
名称 | 描述 |
---|---|
如果没有集合的元素计算为 false ,则返回true ,否则返回false 。接受单个参数表达式。 | |
如果集合中的任意一个元素求值为 true ,则返回true ;否则,返回false 。接受单个参数表达式。 | |
如果输入 sets 具有相同的不同元素,则返回 true 。接受两个或多个参数表达式。 | |
返回一个包含所有输入 sets 中出现的元素的集合。接受任意数量的参数表达式。 | |
返回包含出现在任何输入集合中的元素的集合。 |
名称 | 描述 |
---|---|
连接任意数量的 strings。 | |
将 date/time string 转换为 date object。 | |
将 date 作为格式化的 string 返回。 | |
搜索 string 以查找子字符串的出现并返回第一次出现的 UTF-8 字节索引。如果未找到子字符串,则返回 -1 。 | |
搜索 string 以查找子字符串的出现并返回第一次出现的 UTF-8 code 点索引。如果找不到子字符串,则返回 -1 | |
根据分隔符将 string 拆分为子字符串。返回子字符串的 array。如果在 string 中找不到分隔符,则返回包含原始 string 的 array。 | |
返回 string 中 UTF-8 编码字节的数量。 | |
执行 case-insensitive string 比较并返回:如果两个 strings 相等则返回 0 ,如果第一个 string 大于第二个,则返回1 ,如果第一个 string 小于第二个,则返回-1 。 | |
返回 string 的子字符串。从 string 中指定的 UTF-8 字节索引(zero-based)处的字符开始,并继续指定的字节数。 | |
将 string 转换为小写。接受单个参数表达式。 | |
将 string 转换为大写。接受单个参数表达式。 |
名称 | 描述 |
---|---|
访问文本搜索元数据。 |
名称 | 描述 |
---|---|
返回该字段的 BSON 数据类型。 |
[](s
名称 | 描述 |
---|---|
返回每个 group 的唯一表达式值的 array。 _Oray 元素的 Order 是未定义的。 | |
返回数值的平均值。忽略 non-numeric 值。 | |
从每个 group 的第一个文档返 回一个 value。仅当文档位于已定义的 order 中时才定义 Order。 | |
从每个 group 的最后一个文档返回一个 value。仅当文档位于已定义的 order 中时才定义 Order。 | |
返回每个 group 的最高表达式 value。 | |
返回通过组合每个 group 的输入文档创建的文档。 | |
返回每个 group 的最低表达式 value。 | |
返回每个 group 的表达式值的 array。 | |
返回输入值的总体标准偏差。 | |
返回输入值的 sample 标准偏差。 | |
返回数值的总和。忽略 non-numeric 值。 |
一些可用作$group阶段累加器的运算符也可用于$project和$addFields阶段,但不能用作累加器。在$project和$addFields阶段使用时,这些 operators 不会维护它们的 state,并且可以将单个参数或多个 arguments 作为输入。
更改了 version 3.2.
名称 | 描述 |
---|---|
返回每个文档的指定表达式或表达式列表的平均值。忽略 non-numeric 值。 | |
返回每个文档的指定表达式或表达式列表的最大值 | |
返回每个文档的指定表达式或表达式列表的最小值 | |
返回输入值的总体标准偏差。 | |
返回输入值的 sample 标准偏差。 | |
返回数值的总和。忽略 non-numeric 值。 |
名称 | 描述 |
---|---|
定义在子表达式范围内使用的变量,并返回子表达式的结果。接受命名参数。 接受任意数量的参数表达式。 |