$ lookup（汇总）_MonogDB 中文网

MongoDB 中文手册

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

在本页面

定义
句法
考虑
例子

定义¶

$lookup¶: 3.2版中的新功能。

对同一数据库中的未分片集合执行左外部联接，以从“联接”集合中过滤文档以进行处理。该$lookup阶段向每个输入文档添加一个新的数组字段，其元素是“ joined”集合中的匹配文档。该$lookup阶段将这些经过重整的文档传递到下一个阶段。

语法¶

该$lookup阶段具有以下语法：

平等匹配¶

为了在输入文档中的字段与“ joined”集合的文档中的字段之间执行相等匹配，该 $lookup阶段具有以下语法：

复制

{
   $lookup:
     {
       from: <collection to join>,
       localField: <field from the input documents>,
       foreignField: <field from the documents of the "from" collection>,
       as: <output array field>
     }
}

该$lookup文件包含以下字段：

领域	描述
从	在同一数据库中指定要执行联接的集合。该`from`收集不能被分片。有关详细信息，请参见分片收集限制。
localField	指定从输入文档到`$lookup`阶段的字段。`$lookup`执行上的平等匹配`localField`到 `foreignField`从的文档`from` 集合。如果输入文档不包含 `localField`，`$lookup`则将字段视为具有值以`null`用于匹配。
foreignField	指定`from` 集合中文档中的字段。`$lookup`执行上的平等匹配`foreignField`到`localField`从输入文件。如果`from`集合中的文档不包含`foreignField`，`$lookup`则将值视为`null`匹配目的。
如	指定要添加到输入文档中的新数组字段的名称。新的数组字段包含`from`集合中的匹配文档。如果输入文档中已经存在指定的名称，则现有字段将被覆盖。

该操作将对应于以下伪SQL语句：

复制

SELECT *, <output array field>
FROM collection
WHERE <output array field> IN (SELECT *
                               FROM <collection to join>
                               WHERE <foreignField>= <collection.localField>);

请参阅以下示例：

使用$ lookup执行单一平等加入
将$ lookup与数组配合使用
将$ lookup与$ mergeObjects一起使用

加盟条件和不相关子查询¶

3.6版的新功能。

为了在两个集合之间执行不相关的子查询，并允许除单个相等匹配之外的其他联接条件，该 $lookup阶段具有以下语法：

复制

{
   $lookup:
     {
       from: <collection to join>,
       let: { <var_1>: <expression>, …, <var_n>: <expression> },
       pipeline: [ <pipeline to execute on the collection to join> ],
       as: <output array field>
     }
}

该$lookup文件包含以下字段：

领域	描述
从	在同一数据库中指定要执行联接的集合。该`from`收集不能被分片。有关详细信息，请参见分片收集限制。
让	可选的。指定在管道字段阶段中使用的变量。使用变量表达式访问从文档输入到`$lookup`阶段的字段。该管道不能直接访问输入文档字段。相反，请先为输入文档字段定义变量，然后在中的阶段中引用变量`pipeline`。注意要在管道阶段引用变量，请使用`"$$<variable>"`语法。该让变量可以通过阶段在访问管道，包括额外的`$lookup`嵌套的阶段`pipeline`。一个`$match`阶段需要使用的 `$expr`操作员访问的变量。 `$expr`允许在`$match`语法内部使用聚合表达式。如果不使用`$expr`运算符，`$match` 则可以引用文档中的字段，但不能访问let 子句定义的变量。`$lookup` 流水线 `$match`中的其他（非）阶段不需要操作员访问变量。`$expr`
管道	指定要在联接的集合上运行的管道。该 `pipeline`决定从加入集合生成的文件。要返回所有文档，请指定一个空管道 `[]`。该`pipeline`可以不包括`$out`阶段或`$merge`阶段。在`pipeline`不能直接访问输入文档字段。相反，请先为输入文档字段定义变量，然后在中的阶段中引用变量`pipeline`。注意要在管道阶段引用变量，请使用`"$$<variable>"`语法。该让变量可以通过阶段在访问管道，包括额外的`$lookup`嵌套的阶段`pipeline`。一个`$match`阶段需要使用的 `$expr`操作员访问的变量。 `$expr`允许在`$match`语法内部使用聚合表达式。如果不使用`$expr`运算符，`$match` 则可以引用文档中的字段，但不能访问let 子句定义的变量。`$lookup` 流水线 `$match`中的其他（非）阶段不需要操作员访问变量。`$expr`
如	指定要添加到输入文档中的新数组字段的名称。新的数组字段包含`from`集合中的匹配文档。如果输入文档中已经存在指定的名称，则现有字段将被覆盖。

该操作将对应于以下伪SQL语句：

复制

SELECT *, <output array field>
FROM collection
WHERE <output array field> IN (SELECT <documents as determined from the pipeline>
                               FROM <collection to join>
                               WHERE <pipeline> );

请参阅以下示例：

使用$ lookup指定多个联接条件
不相关子查询

注意事项¶

查看和整理¶

如果执行涉及多个视图的聚合（例如with $lookup或）$graphLookup，则这些视图必须具有相同的排序规则。

限制¶

在版本4.2中更改：您不能$out在$merge 阶段中包含或$lookup阶段。也就是说，在为联接的集合指定管道时，您不能在该pipeline字段中包括任何阶段。

复制

{
  $lookup:
    {
       from: <collection to join>,
       let: { <var_1>: <expression>, …, <var_n>: <expression> },
       pipeline: [ <pipeline to execute on the joined collection> ],  // Cannot include $out or $merge
       as: <output array field>
    }
}

分片收集限制¶

在$lookup阶段，from收集不能被分片。但是，可以对运行该aggregate()方法的集合进行分片。也就是说，在下面：

复制

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

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

这样，要将分片集合与未分片集合连接在一起，可以在分片集合上运行聚合并查找未分片集合；例如：

复制

db.shardedCollection.aggregate([
   { $lookup: { from: "unshardedCollection", ... } }
])

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

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

例子¶

使用¶执行单等联接`$lookup`

orders使用以下文档创建一个集合：

复制

db.orders.insert([
   { "_id" : 1, "item" : "almonds", "price" : 12, "quantity" : 2 },
   { "_id" : 2, "item" : "pecans", "price" : 20, "quantity" : 1 },
   { "_id" : 3  }
])

inventory使用以下文档创建另一个集合：

复制

db.inventory.insert([
   { "_id" : 1, "sku" : "almonds", description: "product 1", "instock" : 120 },
   { "_id" : 2, "sku" : "bread", description: "product 2", "instock" : 80 },
   { "_id" : 3, "sku" : "cashews", description: "product 3", "instock" : 60 },
   { "_id" : 4, "sku" : "pecans", description: "product 4", "instock" : 70 },
   { "_id" : 5, "sku": null, description: "Incomplete" },
   { "_id" : 6 }
])

在下面的聚合操作orders系列外，从文件orders从文件 inventory使用的字段集合item从 orders收集和sku从外地inventory 收集：

复制

db.orders.aggregate([
   {
     $lookup:
       {
         from: "inventory",
         localField: "item",
         foreignField: "sku",
         as: "inventory_docs"
       }
  }
])

该操作返回以下文档：

复制

{
   "_id" : 1,
   "item" : "almonds",
   "price" : 12,
   "quantity" : 2,
   "inventory_docs" : [
      { "_id" : 1, "sku" : "almonds", "description" : "product 1", "instock" : 120 }
   ]
}
{
   "_id" : 2,
   "item" : "pecans",
   "price" : 20,
   "quantity" : 1,
   "inventory_docs" : [
      { "_id" : 4, "sku" : "pecans", "description" : "product 4", "instock" : 70 }
   ]
}
{
   "_id" : 3,
   "inventory_docs" : [
      { "_id" : 5, "sku" : null, "description" : "Incomplete" },
      { "_id" : 6 }
   ]
}

该操作将对应于以下伪SQL语句：

复制

SELECT *, inventory_docs
FROM orders
WHERE inventory_docs IN (SELECT *
FROM inventory
WHERE sku= orders.item);

使用`$lookup`与阵列¶

从MongoDB 3.4开始，如果localField是一个数组，则可以将数组元素与标量foreignField进行匹配，而无需 $unwind舞台。

例如，classes使用以下文档创建一个示例集合：

复制

db.classes.insert( [
   { _id: 1, title: "Reading is ...", enrollmentlist: [ "giraffe2", "pandabear", "artie" ], days: ["M", "W", "F"] },
   { _id: 2, title: "But Writing ...", enrollmentlist: [ "giraffe1", "artie" ], days: ["T", "F"] }
])

members使用以下文档创建另一个集合：

复制

db.members.insert( [
   { _id: 1, name: "artie", joined: new Date("2016-05-01"), status: "A" },
   { _id: 2, name: "giraffe", joined: new Date("2017-05-01"), status: "D" },
   { _id: 3, name: "giraffe1", joined: new Date("2017-10-01"), status: "A" },
   { _id: 4, name: "panda", joined: new Date("2018-10-11"), status: "A" },
   { _id: 5, name: "pandabear", joined: new Date("2018-12-01"), status: "A" },
   { _id: 6, name: "giraffe2", joined: new Date("2018-12-01"), status: "D" }
])

以下聚合操作将classes 集合中的文档与members集合相结合，在members 字段上与字段匹配name：

复制

db.classes.aggregate([
   {
      $lookup:
         {
            from: "members",
            localField: "enrollmentlist",
            foreignField: "name",
            as: "enrollee_info"
        }
   }
])

该操作返回以下内容：

复制

{
   "_id" : 1,
   "title" : "Reading is ...",
   "enrollmentlist" : [ "giraffe2", "pandabear", "artie" ],
   "days" : [ "M", "W", "F" ],
   "enrollee_info" : [
      { "_id" : 1, "name" : "artie", "joined" : ISODate("2016-05-01T00:00:00Z"), "status" : "A" },
      { "_id" : 5, "name" : "pandabear", "joined" : ISODate("2018-12-01T00:00:00Z"), "status" : "A" },
      { "_id" : 6, "name" : "giraffe2", "joined" : ISODate("2018-12-01T00:00:00Z"), "status" : "D" }
   ]
}
{
   "_id" : 2,
   "title" : "But Writing ...",
   "enrollmentlist" : [ "giraffe1", "artie" ],
   "days" : [ "T", "F" ],
   "enrollee_info" : [
      { "_id" : 1, "name" : "artie", "joined" : ISODate("2016-05-01T00:00:00Z"), "status" : "A" },
      { "_id" : 3, "name" : "giraffe1", "joined" : ISODate("2017-10-01T00:00:00Z"), "status" : "A" }
   ]
}

`$lookup`与¶一起使用`$mergeObjects`

在版本3.6中进行了更改： MongoDB 3.6添加了$mergeObjects运算符以将多个文档组合为一个文档

orders使用以下文档创建一个集合：

复制

db.orders.insert([
   { "_id" : 1, "item" : "almonds", "price" : 12, "quantity" : 2 },
   { "_id" : 2, "item" : "pecans", "price" : 20, "quantity" : 1 }
])

items使用以下文档创建另一个集合：

复制

db.items.insert([
  { "_id" : 1, "item" : "almonds", description: "almond clusters", "instock" : 120 },
  { "_id" : 2, "item" : "bread", description: "raisin and nut bread", "instock" : 80 },
  { "_id" : 3, "item" : "pecans", description: "candied pecans", "instock" : 60 }
])

以下操作首先使用$lookup阶段通过item字段将两个集合合并，然后 $mergeObjects在中$replaceRoot使用合并来自items和的合并文档orders：

复制

db.orders.aggregate([
   {
      $lookup: {
         from: "items",
         localField: "item",    // field in the orders collection
         foreignField: "item",  // field in the items collection
         as: "fromItems"
      }
   },
   {
      $replaceRoot: { newRoot: { $mergeObjects: [ { $arrayElemAt: [ "$fromItems", 0 ] }, "$$ROOT" ] } }
   },
   { $project: { fromItems: 0 } }
])

该操作返回以下文档：

复制

{ "_id" : 1, "item" : "almonds", "description" : "almond clusters", "instock" : 120, "price" : 12, "quantity" : 2 }
{ "_id" : 2, "item" : "pecans", "description" : "candied pecans", "instock" : 60, "price" : 20, "quantity" : 1 }

使用¶指定多个联接条件`$lookup`

在版本3.6中进行了更改： MongoDB 3.6添加了对在联接的集合上执行管道的支持，从而允许指定多个联接条件以及不相关的子查询。

orders使用以下文档创建一个集合：

复制

MongoDB 中文手册

$ lookup（汇总）

定义¶

语法¶

平等匹配¶

加盟条件和不相关子查询¶

注意事项¶

查看和整理¶

限制¶

分片收集限制¶

例子¶

使用¶执行单等联接$lookup

使用$lookup与阵列¶

$lookup与¶一起使用$mergeObjects

使用¶指定多个联接条件$lookup

使用¶执行单等联接`$lookup`

使用`$lookup`与阵列¶

`$lookup`与¶一起使用`$mergeObjects`

使用¶指定多个联接条件`$lookup`