$合并（汇总）_MonogDB 中文网

{ $merge: {
     into: <collection> -or- { db: <db>, coll: <collection> },
     on: <identifier field> -or- [ <identifier field1>, ...],  // Optional
     let: <variables>,                                         // Optional
     whenMatched: <replace|keepExisting|merge|fail|pipeline>,  // Optional
     whenNotMatched: <insert|discard|fail>                     // Optional
} }

例如：

复制

{ $merge: { into: "myOutput", on: "_id", whenMatched: "replace", whenNotMatched: "insert" } }

如果使用所有默认选项$merge（包括写入同一数据库中的集合），则可以使用简化形式：

复制

{ $merge: <collection> } // Output collection is in the same database

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

领域描述

进入

输出集合。请指定：

集合名称以字符串形式输出到运行聚合的同一数据库中的集合。例如：

into: "myOutput"
文档中的数据库和集合名称，以输出到指定数据库中的集合。例如：

into: { db:"myDB", coll:"myOutput" }

注意

如果输出集合不存在，请$merge 创建该集合：
- 对于副本集或独立集，如果输出数据库不存在，则$merge 还将创建该数据库。
- 对于分片群集，指定的输出数据库必须已经存在。
输出集合不能与要聚合的集合相同。
输出集合不能出现在管道的任何其他阶段。
输出集合可以是分片集合。

上

可选的。充当文档唯一标识符的一个或多个字段。标识符确定结果文档是否与输出集中的现有文档匹配。请指定：

单个字段名称作为字符串。例如：

on: "_id"
数组中字段的组合。例如：

on: [ "date", "customerId" ]

数组中字段的顺序无关紧要，并且您不能多次指定同一字段。

对于指定的一个或多个字段：

聚合结果文档必须包含在中指定on的on字段，除非该字段是该 _id字段。如果_id结果文档中缺少该字段，则MongoDB会自动添加它。
指定的一个或多个字段不能包含null或数组值。

$merge需要一个唯一的索引，索引的键对应于on标识符字段。尽管索引键规范的顺序无关紧要，但唯一索引必须仅包含on字段作为其键。

该指数还必须具有相同的排序规则作为聚集的排序规则。
唯一索引可以是稀疏索引。
对于已经存在的输出集合，相应的索引必须已经存在。

on的默认值取决于输出集合：

如果输出集合不存在，则on 标识符必须为并且默认为该_id字段。相应的唯一_id索引将自动创建。

小费

要对不存在的集合使用不同的on标识符字段，您可以通过在所需字段上创建唯一索引来首先创建集合。有关示例，请参见关于不存在的输出集合的部分。
如果现有的输出集合未分片，则on 标识符默认为该_id字段。
如果现有输出集合是分片集合，则 on标识符默认为所有分片键字段和该_id字段。如果指定其他 on标识符，则on必须包含所有分片键字段。

何时匹配

可选的。对于$merge集合中指定的字段，结果文档和集合中的现有文档是否具有相同值的行为。

您可以指定：

预定义的操作字符串之一：

行动	描述
“更换”	用匹配的结果文档替换输出集合中的现有文档。执行替换时，替换文档不能导致`_id`值的修改，或者，如果对输出集合进行了分片，则不能对分片键值进行修改。否则，该操作将导致错误。小费为避免此错误，如果on 字段不包括该`_id`字段，请`_id`在聚合结果中删除该字段以避免该错误，例如前`$unset` 级等。
“ keepExisting”	将现有文档保留在输出集合中。
“合并”（默认）	合并匹配的文档（类似于 `$mergeObjects`运算符）。如果结果文档包含现有文档中没有的字段，则将这些新字段添加到现有文档中。如果结果文档包含现有文档中的字段，请用结果文档中的值替换现有的字段值。例如，如果输出集合具有文档： `{ _id: 1, a: 1, b: 1 }` 并且聚合结果有文件： `{ _id: 1, b: 5, z: 1 }` 然后，合并的文档为： `{ _id: 1, a: 1, b: 5, z: 1 }` 执行合并时，合并的文档不能导致`_id`值的修改，或者，如果将输出集合分片，则不能导致分片键值的修改。否则，该操作将导致错误。小费为避免此错误，如果on 字段不包括该`_id`字段，请`_id`在聚合结果中删除该字段以避免该错误，例如前`$unset` 级等。
“失败”	停止聚合操作并使其失败。对先前文档中的输出集合所做的任何更改都不会还原。

聚合管道，用于更新集合中的文档。

[ <stage1>, <stage2> ... ]

管道只能包括以下阶段：
- $addFields 及其别名 $set
- $project 及其别名 $unset
- $replaceRoot 及其别名 $replaceWith
管道无法修改on字段的值。例如，如果您在字段上匹配month，则管道无法修改该month字段。

whenMatched pipeline可以使用来直接访问输出集合中现有文档的字段$<field>。

要访问聚合结果文档中的字段，请使用以下任一方法：
- $$new用于访问字段的内置变量，即 $$new.<field>。$$new仅当省略let规范时，该变量才可用。
  
  注意
  
  从MongoDB 4.2.2开始，该$$new变量已保留，并且不能被覆盖。
- let 字段中的用户定义变量，即$$<uservariable>.<field>。

让

可选的。指定可在whenMatched管道中使用的变量

用变量名和值表达式指定一个文档：

{ <var_1>: <expression>, ..., <var_n>: <expression> }

如果未指定，则默认为;。即 whenMatched管道可以访问变量。{ new: "$$ROOT" }$$new

注意

从MongoDB 4.2.2开始，该$$new变量已保留，并且不能被覆盖。

要访问whenMatched管道中的let变量，请使用双美元符号（$$）前缀和变量名。$$<variable>

whenNotMatched

可选的。$merge结果文档与out集合中的现有文档不匹配的行为。

您可以指定预定义的操作字符串之一：

行动	描述
“插入”（默认）	将文档插入到输出集合中。
“丢弃”	丢弃文件；即`$merge`不将文档插入输出集合。
“失败”	停止聚合操作并使其失败。已经写入输出集合的任何更改都不会还原。

注意事项¶

`_id`现场生成¶

如果_id聚合管道结果中的文档中不存在该字段，那么该$merge阶段将自动生成该字段。

例如，在以下聚合管道中，从传递到的文档中$project排除该_id字段$merge。当$merge这些文件写入"newCollection"，$merge产生了新的_id领域和价值。

复制

db.sales.aggregate( [
   { $project: { _id: 0 } },
   { $merge : { into : "newCollection" } }
] )

如果输出集合不存在，则创建一个新集合¶

$merge如果指定的输出集合不存在，则该操作将创建一个新集合。

当$merge将第一个文档写入集合时，将创建输出集合，并且该集合立即可见。
如果聚合失败，$merge则不会回滚错误之前由之前完成的所有写操作。

注意

对于副本集或独立集，如果输出数据库不存在，则$merge还将创建该数据库。

对于分片群集，指定的输出数据库必须已经存在。

如果输出集合不存在，则$merge要求on标识符为该_id字段。要将on不存在的其他字段值用于不存在的集合，可以先通过在所需字段上创建唯一索引来首先创建该集合。例如，如果输出集合 newDailySales201905不存在，并且您要将salesDate字段指定为on标识符：

复制

db.newDailySales201905.createIndex( { salesDate: 1 }, { unique: true } )

db.sales.aggregate( [
   { $match: { date: { $gte: new Date("2019-05-01"), $lt: new Date("2019-06-01") } } },
   { $group: { _id: { $dateToString: { format: "%Y-%m-%d", date: "$date" } }, totalqty: { $sum: "$quantity" } } },
   { $project: { _id: 0, salesDate: { $toDate: "$_id" }, totalqty: 1 } },
   { $merge : { into : "newDailySales201905", on: "salesDate" } }
] )

输出到分片集合¶

该$merge阶段可输出到分片集合。对输出集合进行分片后，$merge将使用该_id字段和所有分片键字段作为默认的标识符。如果覆盖默认值，则on标识符必须包含所有分片键字段：

复制

{ $merge: {
   into: "<shardedColl>" or { db:"<sharding enabled db>", coll: "<shardedColl>" },
   on: [ "<shardkeyfield1>", "<shardkeyfield2>",... ], // Shard key fields and any additional fields
   let: <variables>,                                         // Optional
   whenMatched: <replace|keepExisting|merge|fail|pipeline>,  // Optional
   whenNotMatched: <insert|discard|fail>                     // Optional
} }

例如，在具有的数据库中，使用该方法创建一个新的分片集合，并将字段作为分片键。sharding enabledsh.shardCollection()newrestaurantspostcode

复制

sh.enableSharding("exampledb");     // Sharding must be enabled in the database
sh.shardCollection(
   "exampledb.newrestaurants",      // Namespace of the collection to shard
   { postcode: 1 },                 // Shard key
);

该newrestaurants集合将包含按月（新开幕的餐厅信息文件date场）和邮政编码（片键）; 具体来说，开标识符是（字段的顺序无关紧要）。因为需要唯一的索引，且索引的键对应于on标识符字段，所以创建唯一索引（字段的顺序无关紧要）：[1]["date", "postcode"]$merge

复制

use exampledb
db.newrestaurants.createIndex( { postcode: 1, date: 1 }, { unique: true } )

restaurants创建分片集合和唯一索引后，您可以用于$merge将聚合结果输出到该集合，并在以下示例中进行匹配：[ "date", "postcode" ]

复制

use exampledb

db.openings.aggregate([
   { $group: {
      _id: { date: { $dateToString: { format: "%Y-%m", date: "$date" } }, postcode: "$postcode" },
      restaurants: { $push: "$restaurantName" } } },
   { $project: { _id: 0, postcode: "$_id.postcode", date: "$_id.date", restaurants: 1 } },
   { $merge: { into: "newrestaurants", "on": [ "date", "postcode" ], whenMatched: "replace", whenNotMatched: "insert" } }
])

[1]	在以下情况下，该`sh.shardCollection()`方法还可以在分片键上创建唯一索引：分片键基于范围；集合为空；并且分片键上的唯一索引尚不存在。`{ unique: true }` 在上面的示例中，由于`on`标识符是分片键和另一个字段，因此需要单独的操作来创建相应的索引。

替换文档（`$merge`）vs替换集合（`$out`）¶

$merge如果聚合结果包含一个或多个基于on 规范匹配的文档，则可以替换输出集合中的现有文档。这样，$merge如果聚合结果包括集合中所有现有文档的匹配文档，并且您为 whenMatched指定了“替换”，则可以替换现有集合中的所有文档。

但是，要替换现有集合而不考虑聚合结果，请$out改用。

现有文档和分片`_id`键值¶

该$merge如果错误$merge在更改现有文档的结果_id值。

小费

为避免此错误，如果on字段不包括该_id字段，请_id在聚合结果中删除该字段以避免该错误，例如前 $unset级等。

此外，对于分片集合，$merge如果它导致现有文档的分片键值发生更改，也会出错。

$merge错误之前之前完成的所有写操作都不会回滚。

独特的指标约束¶

如果$mergefor on字段使用的唯一索引在聚合过程中被丢弃，则不能保证该聚合将被终止。如果聚合继续，则不能保证文档没有重复的on字段值。

如果$merge尝试编写违反输出集合上任何唯一索引的文档，则操作错误；例如：

插入违反唯一索引（而不是 on字段上的索引）的不匹配文档。
如果集合中有匹配的文档，则失败。具体来说，该操作尝试插入匹配文档，该文档违反了 on字段上的唯一索引。
用违反唯一索引（而不是 on字段上的索引）的新文档替换现有文档。
合并匹配的文档，导致文档违反唯一字段索引，而不是 on字段上的索引。

`whenMatched`管道行为¶

从MongoDB 4.2.2开始，如果以下所有条件对于一个$merge阶段均成立：

whenMatched的值是一个聚合管道，
whenNotMatched的值是 insert和
输出集中没有匹配的文档，

$merge 将文档直接插入到输出集合中。

在MongoDB 4.2.2之前，当$merge满足阶段的这些条件时，将使用空的输入文档执行whenMatched字段中指定的管道。来自管道的结果文档将插入到输出集合中。

也可以看看

4.2.2发行说明

与¶的比较`$out`

$merge和$out比较

随着的引入$merge，MongoDB提供了$merge和的两个阶段，$out用于将聚合管道的结果写入集合。以下总结了这两个阶段的功能：

`$merge`	`$out`
从MongoDB 4.2开始可用	从MongoDB 2.6开始可用
可以输出到相同或不同数据库中的集合。	只能输出到同一数据库中的集合。
如果输出集合尚不存在，则创建一个新集合。	如果输出集合尚不存在，则创建一个新集合。
可以将结果（插入新文档，合并文档，替换文档，保留现有文档，使操作失败，使用自定义更新管道处理文档）合并到现有集合中。另请参见“ 替换文档”（$ merge）与“替换集合”（$ out）。	如果输出集合已经存在，则将其完全替换。
可以输出到分片集合。输入集合也可以分片。	无法输出到分片集合。但是，输入分片可以分片。
对应于SQL语句： `MERGE`。 `INSERT INTO T2 SELECT FROM T1`。 `SELECT INTO T2 FROM T1`。创建/刷新实例化视图。	对应于SQL语句： `INSERT INTO T2 SELECT FROM T1`。 `SELECT INTO T2 FROM T1`。

限制¶

限制条件	描述
输出集合	输出集合不能与要聚合的集合相同。输出集合不能是出现在管道其他任何阶段的集合。例如，聚合管道不能包含`$lookup` 阶段或

MongoDB 中文手册

$合并（汇总）

定义¶

语法¶

注意事项¶

_id现场生成¶

如果输出集合不存在，则创建一个新集合¶

输出到分片集合¶

替换文档（$merge）vs替换集合（$out）¶

现有文档和分片_id键值¶

独特的指标约束¶

whenMatched管道行为¶

与¶的比较$out

限制¶

`_id`现场生成¶

替换文档（`$merge`）vs替换集合（`$out`）¶

现有文档和分片`_id`键值¶

`whenMatched`管道行为¶

与¶的比较`$out`