Aggregate.unwind(value: string|object): Aggregate

支持端：小程序 2.7.4 起, 云函数 0.8.1 起

聚合阶段。使用指定的数组字段中的每个元素，对文档进行拆分。拆分后，文档会从一个变为一个或多个，分别对应数组的每个元素。

参数

value: string|object

返回值

Aggregate

API 说明

使用指定的数组字段中的每个元素，对文档进行拆分。拆分后，文档会从一个变为一个或多个，分别对应数组的每个元素。

unwind 有两种使用形式：

  • 参数是一个字段名
  1. unwind(<字段名>)
  • 参数是一个对象
  1. unwind({
  2.     path: <字段名>,
  3.     includeArrayIndex: <string>,
  4.     preserveNullAndEmptyArrays: <boolean>
  5. })
字段类型说明
pathstring想要拆分的数组的字段名，需要以 $ 开头。
includeArrayIndexstring可选项，传入一个新的字段名，数组索引会保存在这个新的字段上。新的字段名不能以 $ 开头。
preserveNullAndEmptyArraysboolean如果为 true，那么在 path 对应的字段为 null、空数组或者这个字段不存在时，依然会输出这个文档；如果为 false，unwind 将不会输出这些文档。默认为 false。

示例

拆分数组

假设我们有一个 products 集合，包含数据如下：

  1. { "_id": "1", "product": "tshirt", "size": ["S", "M", "L"] }
  2. { "_id": "2", "product": "pants", "size": [] }
  3. { "_id": "3", "product": "socks", "size": null }
  4. { "_id": "4", "product": "trousers", "size": ["S"] }
  5. { "_id": "5", "product": "sweater", "size": ["M", "L"] }

我们根据 size 字段对这些文档进行拆分

  1. db.collection('products')
  2.   .aggregate()
  3.   .unwind('$size')
  4.   .end()

输出如下：

  1. { "_id": "1", "product": "tshirt", "size": "S" }
  2. { "_id": "1", "product": "tshirt", "size": "M" }
  3. { "_id": "1", "product": "tshirt", "size": "L" }
  4. { "_id": "4", "product": "trousers", "size": "S" }
  5. { "_id": "5", "product": "sweater", "size": "M" }
  6. { "_id": "5", "product": "sweater", "size": "L" }

拆分后，保留原数组的索引

我们根据 size 字段对文档进行拆分后，想要保留原数组索引在新的 index 字段中。

  1. db.collection('products')
  2.   .aggregate()
  3.   .unwind({
  4.       path: '$size',
  5.       includeArrayIndex: 'index'
  6.   })
  7.   .end()

输出如下：

  1. { "_id": "1", "product": "tshirt", "size": "S", "index": 0 }
  2. { "_id": "1", "product": "tshirt", "size": "M", "index": 1 }
  3. { "_id": "1", "product": "tshirt", "size": "L", "index": 2 }
  4. { "_id": "4", "product": "trousers", "size": "S", "index": 0 }
  5. { "_id": "5", "product": "sweater", "size": "M", "index": 0 }
  6. { "_id": "5", "product": "sweater", "size": "L", "index": 1 }

保留字段为空的文档

注意到我们的集合中有两行特殊的空值数据：

  1. ...
  2. { "_id": "2", "product": "pants", "size": [] }
  3. { "_id": "3", "product": "socks", "size": null }
  4. ...

如果想要在输出中保留 size 为空数组、null，或者 size 字段不存在的文档，可以使用 preserveNullAndEmptyArrays 参数

  1. db.collection('products')
  2.   .aggregate()
  3.   .unwind({
  4.       path: '$size',
  5.       preserveNullAndEmptyArrays: true
  6.   })
  7.   .end()

输出如下：

  1. { "_id": "1", "product": "tshirt", "size": "S" }
  2. { "_id": "1", "product": "tshirt", "size": "M" }
  3. { "_id": "1", "product": "tshirt", "size": "L" }
  4. { "_id": "2", "product": "pants", "size": null }
  5. { "_id": "3", "product": "socks", "size": null }
  6. { "_id": "4", "product": "trousers", "size": "S" }
  7. { "_id": "5", "product": "sweater", "size": "M" }
  8. { "_id": "5", "product": "sweater", "size": "L" }