$ graphLookup（汇总）_MonogDB 中文网

MongoDB 中文手册

参考 > 参考 > 经营者 > 聚合管道阶段 > $ graphLookup（汇总）

在本页面

定义
注意事项
例子
额外资源

在版本3.4中更改。

定义¶

$graphLookup¶

对集合执行递归搜索，其中包含用于通过递归深度和查询过滤器限制搜索的选项。

在$graphLookup搜索过程总结如下：

输入文档进入$graphLookup聚合操作阶段。
$graphLookup将搜索定位到该from参数指定的集合（有关搜索参数的完整列表，请参见下文）。
对于每个输入文档，搜索均以指定的值开始startWith。
$graphLookup将startWith值与集合connectToField中其他文档中指定的字段匹配from。
对于每个匹配的文档，$graphLookup采用的值，connectFromField并检查from集合中的每个文档的匹配connectToField值。对于每个匹配项，$graphLookup将from集合中的匹配文档添加到由as 参数命名的数组字段中。

此步骤以递归方式继续进行，直到找不到更多匹配的文档，或者直到操作达到该maxDepth参数指定的递归深度为止。$graphLookup然后将数组字段附加到输入文档。$graphLookup 搜索完所有输入文档后，返回结果。

$graphLookup 具有以下原型形式：

复制

{
   $graphLookup: {
      from: <collection>,
      startWith: <expression>,
      connectFromField: <string>,
      connectToField: <string>,
      as: <string>,
      maxDepth: <number>,
      depthField: <string>,
      restrictSearchWithMatch: <document>
   }
}

$graphLookup 接收具有以下字段的文档：

领域	描述
`from`	`$graphLookup` 搜索操作的目标集合，将递归匹配 `connectFromField`到`connectToField`。该`from`集合无法分片，并且必须与操作中使用的任何其他集合位于同一数据库中。有关信息，请参见分片集合。
`startWith`	该表达式指定`connectFromField`开始递归搜索时使用的值。可选地，`startWith`可以是值的数组，每个值都分别经过遍历过程。
`connectFromField`	其值`$graphLookup`用于`connectToField`与集合中其他文档的递归匹配的字段名称。如果值是数组，则每个元素都将分别经过遍历过程。
`connectToField`	其他文档中与该`connectFromField` 参数指定的字段值相匹配的字段名。
`as`	添加到每个输出文档中的数组字段的名称。包含在`$graphLookup`阶段中遍历的文档。注意 `as`字段中返回的文档不保证任何顺序。
`maxDepth`	可选的。指定最大递归深度的非负整数。
`depthField`	可选的。要添加到搜索路径中每个已遍历文档的字段名称。该字段的值是文档的递归深度，用表示 `NumberLong`。递归深度值从零开始，因此第一次查找对应于零深度。
`restrictSearchWithMatch`	可选的。为递归搜索指定其他条件的文档。该语法与查询过滤器语法相同。注意您不能在此过滤器中使用任何聚合表达式。例如，查询文档如复制 { lastName: { $ne: "$lastName" } } 在这种情况下将无法找到`lastName`其`lastName` 值与输入文档的值不同的文档，因为`"$lastName"`它将充当字符串文字，而不是字段路径。

注意事项¶

分片集合¶

from无法分片中指定的集合。但是，可以对运行该aggregate()方法的集合进行分片。也就是说，在下面：

复制

db.collection.aggregate([
   { $graphLookup: { from: "fromCollection", ... } }
])

该collection可以分片。
在fromCollection不能分片。

要加入多个分片集合，请考虑：

修改客户端应用程序以执行手动查找，而不使用$graphLookup聚合阶段。
如果可能，请使用嵌入式数据模型来消除加入集合的需要。

最大深度¶

将maxDepth字段设置0为等效于非递归$graphLookup搜索阶段。

内存¶

该$graphLookup阶段必须保持在100 MIB内存限制之内。如果为操作指定了，则阶段将忽略该选项。如果有观察其他阶段的操作，选择在这些其他阶段的效果。allowDiskUse: trueaggregate()$graphLookupallowDiskUse: trueaggregate()allowDiskUse: true

有关更多信息，请参见聚集管道限制。

查看和整理¶

如果执行涉及多个视图的聚合（例如with $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操作在集合中的reportsTo和name字段上进行递归匹配employees，返回每个人的报告层次结构：

复制

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" : 3,
   "name" : "Ron",
   "reportsTo" : "Eliot",
   "reportingHierarchy" : [
      { "_id" : 1, "name" : "Dev" },
      { "_id" : 2, "name" : "Eliot", "reportsTo" : "Dev" }
   ]
}
{
   "_id" : 4,
   "name" : "Andrew",
   "reportsTo" : "Eliot",
   "reportingHierarchy" : [
      { "_id" : 1, "name" : "Dev" },
      { "_id" : 2, "name" : "Eliot", "reportsTo" : "Dev" }
   ]
}
{
   "_id" : 5,
   "name" : "Asya",
   "reportsTo" : "Ron",
   "reportingHierarchy" : [
      { "_id" : 1, "name" : "Dev" },
      { "_id" : 2, "name" : "Eliot", "reportsTo" : "Dev" },
      { "_id" : 3, "name" : "Ron", "reportsTo" : "Eliot" }
   ]
}
{
   "_id" : 6,
   "name" : "Dan",
   "reportsTo" : "Andrew",
   "reportingHierarchy" : [
      { "_id" : 1, "name" : "Dev" },
      { "_id" : 2, "name" : "Eliot", "reportsTo" : "Dev" },
      { "_id" : 4, "name" : "Andrew", "reportsTo" : "Eliot" }
   ]
}

下表提供了文档的遍历路径：{ "_id" : 5, "name" : "Asya", "reportsTo" : "Ron" }

起始值	该`reportsTo`文件的价值：复制 { ... "reportsTo" : "Ron" }
深度0	复制 { "_id" : 3, "name" : "Ron", "reportsTo" : "Eliot" }
深度1	复制 { "_id" : 2, "name" : "Eliot", "reportsTo" : "Dev" }
深度2	复制 { "_id" : 1, "name" : "Dev" }

输出生成层次结构。Asya -> Ron -> Eliot -> Dev

横跨多个集合¶

像一样$lookup，$graphLookup可以访问同一数据库中的另一个集合。

在以下示例中，数据库包含两个集合：

airports具有以下文件的集合：

复制

{ "_id" : 0, "airport" : "JFK", "connects" : [ "BOS", "ORD" ] }
{ "_id" : 1, "airport" : "BOS", "connects" : [ "JFK", "PWM" ] }
{ "_id" : 2, "airport" : "ORD", "connects" : [ "JFK" ] }
{ "_id" : 3, "airport" : "PWM", "connects" : [ "BOS", "LHR" ] }
{ "_id" : 4, "airport" : "LHR", "connects" : [ "PWM" ] }

travelers具有以下文件的集合：

复制

{ "_id" : 1, "name" : "Dev", "nearestAirport" : "JFK" }
{ "_id" : 2, "name" : "Eliot", "nearestAirport" : "JFK" }
{ "_id" : 3, "name" : "Jeff", "nearestAirport" : "BOS" }

对于travelers集合中的每个文档，以下聚合操作将查找集合中的nearestAirport值， airports然后将该connects 字段与该字段进行递归匹配airport。该操作将最大递归深度指定为2。

复制

db.travelers.aggregate( [
   {
      $graphLookup: {
         from: "airports",
         startWith: "$nearestAirport",
         connectFromField: "connects",
         connectToField: "airport",
         maxDepth: 2,
         depthField: "numConnections",
         as: "destinations"
      }
   }
] )

该操作返回以下结果：

复制

{
   "_id" : 1,
   "name" : "Dev",
   "nearestAirport" : "JFK",
   "destinations" : [
      { "_id" : 3,
        "airport" : "PWM",
        "connects" : [ "BOS", "LHR" ],
        "numConnections" : NumberLong(2) },
      { "_id" : 2,
        "airport" : "ORD",
        "connects" : [ "JFK" ],
        "numConnections" : NumberLong(1) },
      { "_id" : 1,
        "airport" : "BOS",
        "connects" : [ "JFK", "PWM" ],
        "numConnections" : NumberLong(1) },
      { "_id" : 0,
        "airport" : "JFK",
        "connects" : [ "BOS", "ORD" ],
        "numConnections" : NumberLong(0) }
   ]
}
{
   "_id" : 2,
   "name" : "Eliot",
   "nearestAirport" : "JFK",
   "destinations" : [
      { "_id" : 3,
        "airport" : "PWM",
        "connects" : [ "BOS", "LHR" ],
        "numConnections" : NumberLong(2) },
      { "_id" : 2,
        "airport" : "ORD",
        "connects" : [ "JFK" ],
        "numConnections" : NumberLong(1) },
      { "_id" : 1,
        "airport" : "BOS",
        "connects" : [ "JFK", "PWM" ],
        "numConnections" : NumberLong(1) },
      { "_id" : 0,
        "airport" : "JFK",
        "connects" : [ "BOS", "ORD" ],
        "numConnections" : NumberLong(0) } ]
}
{
   "_id" : 3,
   "name" : "Jeff",
   "nearestAirport" : "BOS",
   "destinations" : [
      { "_id" : 2,
        "airport" : "ORD",
        "connects" : [ "JFK" ],
        "numConnections" : NumberLong(2) },
      { "_id" : 3,
        "airport" : "PWM",
        "connects" : [ "BOS", "LHR" ],
        "numConnections" : NumberLong(1) },
      { "_id" : 4,
        "airport" : "LHR",
        "connects" : [ "PWM" ],
        "numConnections" : NumberLong(2) },
      { "_id" : 0,
        "airport" : "JFK",
        "connects" : [ "BOS", "ORD" ],
        "numConnections" : NumberLong(1) },
      { "_id" : 1,
        "airport" : "BOS",
        "connects" : [ "JFK", "PWM" ],
        "numConnections" : NumberLong(0) }
   ]
}

下表提供了递归搜索的遍历路径，最深处为2，其中起点airport是JFK：

起始值	集合中的`nearestAirport`值`travelers`：复制 { ... "nearestAirport" : "JFK" }
深度0	复制 { "_id" : 0, "airport" : "JFK", "connects" : [ "BOS", "ORD" ] }
深度1	复制 { "_id" : 1, "airport" : "BOS", "connects" : [ "JFK", "PWM" ] } { "_id" : 2, "airport" : "ORD", "connects" : [ "JFK" ] }
深度2	复制 { "_id" : 3, "airport" : "PWM", "connects" : [ "BOS", "LHR" ] }

随着查询过滤器¶

下面的示例使用一个集合，该集合包含一组文档，其中包含人的名字以及他们的朋友和爱好的数组。聚合操作会找到一个特定的人，并遍历她的联系网络，以找到golf在其兴趣中列出的人。

名为的集合people包含以下文档：

复制

{
  "_id" : 1,
  "name" : "Tanya Jordan",
  "friends" : [ "Shirley Soto", "Terry Hawkins", "Carole Hale" ],
  "hobbies" : [ "tennis", "unicycling", "golf" ]
}
{
  "_id" : 2,
  "name" : "Carole Hale",
  "friends" : [ "Joseph Dennis", "Tanya Jordan", "Terry Hawkins" ],
  "hobbies" : [ "archery", "golf", "woodworking" ]
}
{
  "_id" : 3,
  "name" : "Terry Hawkins",
  "friends" : [ "Tanya Jordan", "Carole Hale", "Angelo Ward" ],
  "hobbies" : [ "knitting", "frisbee" ]
}
{
  "_id" : 4,
  "name" : "Joseph Dennis",
  "friends" : [ "Angelo Ward", "Carole Hale" ],
  "hobbies" : [ "tennis", "golf", "topiary" ]
}
{
  "_id" : 5,
  "name" : "Angelo Ward",
  "friends" : [ "Terry Hawkins", "Shirley Soto", "Joseph Dennis" ],
  "hobbies" : [ "travel", "ceramics", "golf" ]
}
{
   "_id" : 6,
   "name" : "Shirley Soto",
   "friends" : [ "Angelo Ward", "Tanya Jordan", "Carole Hale" ],
   "hobbies" : [ "frisbee", "set theory" ]
 }

以下聚合操作分为三个阶段：

$match与具有name包含字符串的字段的文档匹配。返回一个输出文档。"Tanya Jordan"
$graphLookup将输出文档的friends 字段与name集合中其他文档的字段连接起来，以遍历连接网络。此阶段使用参数查找仅包含数组的文档。返回一个输出文档。Tanya Jordan'srestrictSearchWithMatchhobbiesgolf
$project调整输出文档的形状。列出的名称 connections who play