$graphLookup
聚合阶段在一个集合中执行递归搜索,可以使用选项来控制递归搜索的深度和条件。
$graphLookup
搜索过程总结如下:
- 输入文档进入
$graphLookup
聚合阶段。 $graphLookup
的搜索目标是from
参数指定的集合(搜索参数的完整列表见下文)。- 对于每个输入文档,搜索都从
startWith
指定的值开始。 graphLookup
使用startWith
的值匹配由from
指定的集合和connectToField
指定的字段的值。- 对于每个匹配文档,
$graphLookup
拿connectFromField
的值来检查每个from
参数指定的集合下的connectToField
参数指定的字段的值,然后将匹配上的from
集合的文档放到由as
参数指定的数组中。
然后该步骤继续递归直到没有匹配的文档或操作达到由maxDepth
参数指定的递归深度。然后$graphLookup
把数组字段添加到输入文档。在完成所有的文档搜索后返回结果。
语法
{
$graphLookup: {
from: <collection>,
startWith: <expression>,
connectFromField: <string>,
connectToField: <string>,
as: <string>,
maxDepth: <number>,
depthField: <string>,
restrictSearchWithMatch: <document>
}
}
参数字段解释:
字段 | 描述 |
---|---|
from |
$graphLookup 操作搜索的目标集合,递归匹配connectFromField 和connnectToField 字段的值,from 指定的集合必须与当前集合在同一个数据库,并且不可以是同一个集合 |
startWith |
可选,表达式,connectFromField 字段进行递归搜索的起始值。startWith 的值也可以是数组,其每个值都会被遍历处理 |
connectFromField |
指定一个字段名,其值用于递归搜索匹配。与集合中其他文档connectToField 相对应,如果其值是数组,则会在遍历时单独处理每个元素 |
connectToField |
其他文档中的字段名称,用于匹配connectFromField 参数指定的字段值 |
as |
添加到每个输出文档中的数组字段名称。包含在$graphLook 阶段遍历的所有文档(注意,数组元素的顺序不保证) |
maxDepth |
可选,正整数,指定最大的递归深度 |
depthField |
可选,要添加到搜索路径中每个遍历文档的字段名称。该字段的值是文档的递归深度,长整数。递归深度值从零开始,因此第一次查找对应的深度为零 |
restrictSearchWithMatch |
可选,文档类型。为递归搜索指定额外的条件,其语法与查询过滤语法相同。可以在过滤条件中使用所有的聚合表达式,如:{ lastName: { $ne: "$lastName" } } ,该表达式无法在该上下文中查找lastName 值与输入文档的lastName 值不同的文档,因为“$lastName”将充当字符串文本,而不是字段路径 |
使用
分片集合
从MongoDB 5.1开始,可以在from
参数中指定分片集合,但不能在事务中使用分片集合。
最大递归深度
将maxDepth
字段设置为0
相当于一个非递归的$graphLookup
搜索阶段
内存
$graphLookup
阶段有100M内存的限制,如果想突破这个限制,可以为聚合指定allowDiskUse: true
,该设置也会影响到$graphLookup
中使用的其他聚合阶段。
视图和集合
如果执行涉及多个视图的聚合,如使用$lookup
或$graphLookup
,视图必须有相同的集合。
举例
单个集合
employees
集合有下面的文档:
{
"_id" : 1, "name" : "Dev" }
{
"_id" : 2, "name" : "Eliot", "reportsTo" : "Dev" }
{
"_id" : 3, "name" : "Ron", "reportsTo" : "Eliot" }
{
"_id" : 4, "name" : "Andrew", "reportsTo" : "Eliot" }
{
"_id" : 5, "name" : "Asya", "reportsTo" : "Ron" }
{
"_id" : 6, "name" : "Dan", "reportsTo" : "Andrew" }
下面的$graphLookup
递归匹配employees
集合中reportsTo
和name
字段,返回每个人的报告层次结构:
db.employees.aggregate( [
{
$graphLookup: {
from: "employees",
startWith: "$reportsTo",
connectFromField: "reportsTo",
connectToField: "name",
as: "reportingHierarchy"
}
}
] )
操作返回下面的结果:
{
"_id" : 1,
"name" : "Dev",
"reportingHierarchy" : [ ]
}
{
"_id" : 2,
"name" : "Eliot",
"reportsTo" : "Dev",
"reportingHierarchy" : [
{
"_id" : 1, "name" : "Dev" }
]
}
{
"_id" :