MongoDB聚合：$out

$out阶段将聚合管道产生的文档写入到指定的集合，从MongoDB4.4开始，支持指定数据库。$out阶段必须放在聚合管道的最后，支持聚合结果任意大小的数据集。

警告：

如果指定的集合已经存在则会被替换。

语法

用法 1： 定数据库和集合名称

{ $out: { db: "<output-db>", coll: "<output-collection>" } }

• db 指定数据库的名称：

  • 对于标准的副本集，如果指定的数据库不存在，$out会自动创建。
  • 对于分片集群，指定的数据库必须已经存在。

• coll 指定集合的名称

用法 2：只指定集合名称

{ $out: "<output-collection>" } // 同一个数据库

直接为$out指定输出集合的名称，输出到同一数据库。

注意

• 分片集合可以作为管道的输入，但是不能作为$out的输出集合，想要输出到分片集合可以使用$merge。
• $out操作不能输出到副本集合。
• 如果要修改带有Atlas Search索引的集合，必须先删除再重建索引，最好使用$merge代替$out。

说明

创建新集合

如果指定的的集合不存在$out可以创建新集合。在聚合未结束前集合不可见。如果聚合失败则不会创建集合。

替换已存在的集合

如果指定的集合已经存在，在聚合完成后$out会使用新的结果替换原有集合，具体步骤如下：

1. 创建一个临时的集合。
2. 将现有集合索引复制到临时集合。
3. 将聚合结果文档插入到临时集合。
4. 调用renameCollection命令，并且dropTarget: True，将临时集合更名为目标集合。

$out操作不会修改原有集合的索引，如果聚合失败，也不会对原有集合做任何修改。

majority 读关注

从MongoDB4.2开始，可以为包含$out阶段的聚合指定"majority"级别的读关注。

对mongodump的影响

如果有客户端发起的聚合管道包含$out阶段，则会导致带有--oplog参数的’mongodump’执行失败。

一些限制

• 事务的限制。事务中的聚合管道不能使用$out。
• 时间序列集合的限制。聚合管道不能使用$out把结果输出到时间序列集合。
• 视图的限制。在视图定义中，不允许包含$out阶段。如果视图定义中包含内置的管道（如：视图定义包含$lookup或facet阶段），$out阶段不能用于这些内置管道。
• $lookup阶段的限制。从MongoDB4.2开始，不能将$out应用与$lookup阶段的内嵌管道。
• $facet阶段的限制。在$facet阶段的内置管道不允许使用$out阶段。
• $unionWith阶段的限制。在$unionWidth阶段的内置管道不允许使用$out阶段。
• "linearizable" 读关注的限制。从MongoDB4.2开始，$out阶段不能与读关注"linearizable"一起使用。这意味着，如果在db.collection.aggregate()指定了读关注"linearizable"，则不能在管道中使用$out阶段。

举例

在test数据库创建一个books集合并插入文档：

db.getSiblingDB("test").books.insertMany([{ "_id" : 8751, "title" : "The Banquet", "author" : "Dante", "copies" : 2 },{ "_id" : 8752, "title" : "Divine Comedy", "author" : "Dante", "copies" : 1 },{ "_id" : 8645, "title" : "Eclogues", "author" : "Dante", "copies" : 2 },{ "_id" : 7000, "title" : "The Odyssey", "author" : "Homer", "copies" : 10 },{ "_id" : 7020, "title" : "Iliad", "author" : "Homer", "copies" : 10 }
])

输出到同一个库

以下聚合操作将test数据库中books集合中的数据调整为按author分组的标题，然后将结果写入test数据库的authors集合。

db.getSiblingDB("test").books.aggregate( [{ $group : { _id : "$author", books: { $push: "$title" } } },{ $out : "authors" }
] )

• $group阶段按照作者分组，使用$push将同一作者的图书标题数组放入books字段:

  { "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }
  { "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
  

• $out阶段将文档输出到test数据库的authors集合

运行查询命令：

db.getSiblingDB("test").authors.find()

得到结果：

{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }

输出到不同的数据库

以下聚合操作将test数据库中books集合中的数据调整为按author分组的标题，然后将结果写入reporting数据库的authors集合。

db.getSiblingDB("test").books.aggregate( [{ $group : { _id : "$author", books: { $push: "$title" } } },{ $out : { db: "reporting", coll: "authors" } }
] )

• $group阶段按照作者分组，使用$push将同一作者的图书标题数组放入books字段:

  { "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }
  { "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
  

• $out阶段将文档输出到reporting数据库的authors集合

运行查询命令：

db.getSiblingDB("reporting").authors.find()

得到结果：

{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }