$ unwind（汇总）_MonogDB 中文网

MongoDB 中文手册

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

在本页面

定义
句法
行为举止
例子
其他资源

定义¶

$unwind¶: 从输入文档中解构一个数组字段，以输出每个元素的文档。每个输出文档都是输入文档，其中array字段的值被元素替换。

语法¶

您可以传递字段路径操作数或文档操作数来展开数组字段。

字段路径操作数¶

您可以将数组字段路径传递给$unwind。使用此语法时，$unwind如果字段值为null，丢失或空数组，则不输出文档。

复制

{ $unwind: <field path> }

指定字段路径时，请在字段名称前加上美元符号$并用引号引起来。

带选项的文档操作数¶

3.2版中的新功能。

您可以将文档传递到$unwind以指定各种行为选项。

复制

{
  $unwind:
    {
      path: <field path>,
      includeArrayIndex: <string>,
      preserveNullAndEmptyArrays: <boolean>
    }
}

领域	类型	描述
路径	串	数组字段的字段路径。要指定字段路径，请在字段名称前加一个美元符号`$`并用引号引起来。
includeArrayIndex	串	可选的。一个新字段的名称，用于保存元素的数组索引。名称不能以美元符号开头`$`。
reserveNullAndEmptyArrays	布尔值	可选的。如果为`true`，则如果`path`为null，丢失或为空数组，则`$unwind`输出文档。如果为`false`，如果`path`为null，缺少或为空数组，`$unwind`则不会输出文档。默认值为`false`。

行为¶

非阵列田间小路¶

在版本3.2中进行了更改：$unwind在非数组操作数上不再出现阶段错误。如果操作数不能解析为数组但不丢失，为null或为空数组，$unwind则将操作数视为单个元素数组。如果操作数为null，缺失或为空数组，则行为$unwind取决于preserveNullAndEmptyArrays 选项的值。

以前，如果由字段路径指定的字段中的值不是数组，db.collection.aggregate()则会生成错误。

缺少字段¶

如果您为输入文档中不存在的字段指定路径，或者该字段为空数组，则$unwind默认情况下，会忽略输入文档，并且不会输出该输入文档的文档。

3.2版中的新增功能：要输出缺少数组字段，为null或为空数组的文档，请使用 prepareNullAndEmptyArrays 选项。

例子¶

展开数组¶

在mongo外壳程序中，创建一个inventory使用以下文档命名的样本集合：

复制

db.inventory.insertOne({ "_id" : 1, "item" : "ABC1", sizes: [ "S", "M", "L"] })

以下聚合使用该$unwind阶段为sizes数组中的每个元素输出文档：

复制

db.inventory.aggregate( [ { $unwind : "$sizes" } ] )

该操作返回以下结果：

{ "_id" : 1, "item" : "ABC1", "sizes" : "S" }
{ "_id" : 1, "item" : "ABC1", "sizes" : "M" }
{ "_id" : 1, "item" : "ABC1", "sizes" : "L" }

每个文档都与输入文档相同，只是sizes字段的值现在包含原始sizes数组中的值。

`includeArrayIndex`和`preserveNullAndEmptyArrays`¶

3.2版中的新功能。

在mongo外壳程序中，创建一个示例集合，其名称 inventory2为以下文档：

复制

db.inventory2.insertMany([
  { "_id" : 1, "item" : "ABC", price: NumberDecimal("80"), "sizes": [ "S", "M", "L"] },
  { "_id" : 2, "item" : "EFG", price: NumberDecimal("120"), "sizes" : [ ] },
  { "_id" : 3, "item" : "IJK", price: NumberDecimal("160"), "sizes": "M" },
  { "_id" : 4, "item" : "LMN" , price: NumberDecimal("10") },
  { "_id" : 5, "item" : "XYZ", price: NumberDecimal("5.75"), "sizes" : null }
])

以下$unwind操作是等效的，并为该sizes字段中的每个元素返回一个文档。如果该sizes 字段不能解析为数组但不丢失，为null或为空数组，$unwind则将非数组操作数视为单个元素数组。

复制

db.inventory2.aggregate( [ { $unwind: "$sizes" } ] )
db.inventory2.aggregate( [ { $unwind: { path: "$sizes" } } ] )

该操作返回以下文档：

{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "S" }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "M" }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "L" }
{ "_id" : 3, "item" : "IJK", "price" : NumberDecimal("160"), "sizes" : "M" }

`includeArrayIndex`¶

以下$unwind操作使用 includeArrayIndex选项将数组索引包含在输出中。

复制

db.inventory2.aggregate( [
  {
    $unwind:
      {
        path: "$sizes",
        includeArrayIndex: "arrayIndex"
      }
   }])

该操作将展开sizes数组，并将数组索引的数组索引包含在新arrayIndex字段中。如果该sizes 字段不能解析为数组，但不丢失，为null或为空数组，则该arrayIndex字段为null。

{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "S", "arrayIndex" : NumberLong(0) }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "M", "arrayIndex" : NumberLong(1) }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "L", "arrayIndex" : NumberLong(2) }
{ "_id" : 3, "item" : "IJK", "price" : NumberDecimal("160"), "sizes" : "M", "arrayIndex" : null }

`preserveNullAndEmptyArrays`¶

以下$unwind操作使用 preserveNullAndEmptyArrays 选项来包括其sizes字段为空，丢失或空数组的文档。

复制

db.inventory2.aggregate( [
   { $unwind: { path: "$sizes", preserveNullAndEmptyArrays: true } }
] )

输出包括sizes字段为空，缺失或空数组的那些文档：

{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "S" }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "M" }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "L" }
{ "_id" : 2, "item" : "EFG", "price" : NumberDecimal("120") }
{ "_id" : 3, "item" : "IJK", "price" : NumberDecimal("160"), "sizes" : "M" }
{ "_id" : 4, "item" : "LMN", "price" : NumberDecimal("10") }
{ "_id" : 5, "item" : "XYZ", "price" : NumberDecimal("5.75"), "sizes" : null }

按展开值分组¶

在mongo外壳程序中，创建一个示例集合，其名称 inventory2为以下文档：

复制

db.inventory2.insertMany([
  { "_id" : 1, "item" : "ABC", price: NumberDecimal("80"), "sizes": [ "S", "M", "L"] },
  { "_id" : 2, "item" : "EFG", price: NumberDecimal("120"), "sizes" : [ ] },
  { "_id" : 3, "item" : "IJK", price: NumberDecimal("160"), "sizes": "M" },
  { "_id" : 4, "item" : "LMN" , price: NumberDecimal("10") },
  { "_id" : 5, "item" : "XYZ", price: NumberDecimal("5.75"), "sizes" : null }
])

以下管道展开sizes数组并将结果文档按展开大小值分组：

复制

db.inventory2.aggregate( [
   // First Stage
   {
     $unwind: { path: "$sizes", preserveNullAndEmptyArrays: true }
   },
   // Second Stage
   {
     $group:
       {
         _id: "$sizes",
         averagePrice: { $avg: "$price" }
       }
   },
   // Third Stage
   {
     $sort: { "averagePrice": -1 }
   }
] )

第一阶段：

该$unwind阶段将为sizes数组中的每个元素输出一个新文档。该阶段使用 prepareNullAndEmptyArrays 选项在输出中包括sizes缺少字段，为null或为空数组的那些文档。此阶段将以下文档传递到下一阶段：

{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "S" }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "M" }
{ "_id" : 1, "item" : "ABC", "price" : NumberDecimal("80"), "sizes" : "L" }
{ "_id" : 2, "item" : "EFG", "price" : NumberDecimal("120") }
{ "_id" : 3, "item" : "IJK", "price" : NumberDecimal("160"), "sizes" : "M" }
{ "_id" : 4, "item" : "LMN", "price" : NumberDecimal("10") }
{ "_id" : 5, "item" : "XYZ", "price" : NumberDecimal("5.75"), "sizes" : null }

第二阶段：

该$group阶段将文件分组，sizes 然后计算每种尺寸的平均价格。此阶段将以下文档传递到下一阶段：

{ "_id" : "S", "averagePrice" : NumberDecimal("80") }
{ "_id" : "L", "averagePrice" : NumberDecimal("80") }
{ "_id" : "M", "averagePrice" : NumberDecimal("120") }
{ "_id" : null, "averagePrice" : NumberDecimal("45.25") }

第三阶段：

该$sort阶段由排序文件averagePrice按降序排列。该操作返回以下结果：

{ "_id" : "M", "averagePrice" : NumberDecimal("120") }
{ "_id" : "L", "averagePrice" : NumberDecimal("80") }
{ "_id" : "S", "averagePrice" : NumberDecimal("80") }
{ "_id" : null, "averagePrice" : NumberDecimal("45.25") }

也可以看看

展开嵌入式阵列¶

在mongo外壳程序中，创建一个示例集合，其名称 sales为以下文档：

复制

db.sales.insertMany([
  {
    _id: "1",
    "items" : [
     {
      "name" : "pens",
      "tags" : [ "writing", "office", "school", "stationary" ],
      "price" : NumberDecimal("12.00"),
      "quantity" : NumberInt("5")
     },
     {
      "name" : "envelopes",
      "tags" : [ "stationary", "office" ],
      "price" : NumberDecimal("1.95"),
      "quantity" : NumberInt("8")
     }
    ]
  },
  {
    _id: "2",
    "items" : [
     {
      "name" : "laptop",
      "tags" : [ "office", "electronics" ],
      "price" : NumberDecimal("800.00"),
      "quantity" : NumberInt("1")
     },
     {
      "name" : "notepad",
      "tags" : [ "stationary", "school" ],
      "price" : NumberDecimal("14.95"),
      "quantity" : NumberInt("3")
     }
    ]
  }
])

以下操作按其标签对出售的商品进行分组，并计算每个标签的总销售额。

复制

db.sales.aggregate([
  // First Stage
  { $unwind: "$items" },

  // Second Stage
  { $unwind: "$items.tags" },

  // Third Stage
  {
    $group:
      {
        _id: "$items.tags",
        totalSalesAmount:
          {
            $sum: { $multiply: [ "$items.price", "$items.quantity" ] }
          }
      }
  }
])

第一阶段

第一$unwind阶段为items数组中的每个元素输出一个新文档：

{ "_id" : "1", "items" : { "name" : "pens", "tags" : [ "writing", "office", "school", "stationary" ], "price" : NumberDecimal("12.00"), "quantity" : 5 } }
{ "_id" : "1", "items" : { "name" : "envelopes", "tags" : [ "stationary", "office" ], "price" : NumberDecimal("19.95"), "quantity" : 8 } }
{ "_id" : "2", "items" : { "name" : "laptop", "tags" : [ "office", "electronics" ], "price" : NumberDecimal("800.00"), "quantity" : 1 } }
{ "_id" : "2", "items" : { "name" : "notepad", "tags" : [ "stationary", "school" ], "price" : NumberDecimal("14.95"), "quantity" : 3 } }

第二阶段

第二$unwind阶段为items.tags数组中的每个元素输出一个新文档：

MongoDB 中文手册

$ unwind（汇总）

定义¶

语法¶

字段路径操作数¶

带选项的文档操作数¶

行为¶

非阵列田间小路¶

缺少字段¶

例子¶

展开数组¶

includeArrayIndex和preserveNullAndEmptyArrays¶

includeArrayIndex¶

preserveNullAndEmptyArrays¶

按展开值分组¶

展开嵌入式阵列¶

`includeArrayIndex`和`preserveNullAndEmptyArrays`¶

`includeArrayIndex`¶

`preserveNullAndEmptyArrays`¶