Aggregate.project(object: Object): Aggregate

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

聚合阶段。把指定的字段传递给下一个流水线，指定的字段可以是某个已经存在的字段，也可以是计算出来的新字段。

参数

object: Object

返回值

Aggregate

API 说明

project 的形式如下：

  1. project({
  2.   <表达式>
  3. })

表达式可以有以下格式：

格式说明
<字段>: <1 或 true>指定包含某个已有字段
id: <0 或 false>舍弃 _id 字段
<字段>: <表达式>加入一个新字段，或者重置某个已有字段
<字段>: <0 或 false>舍弃某个字段（如果你指定舍弃了某个非 id 字段，那么在此次 project 中，你不能再使用其它表达式）

指定包含字段

_id 字段是默认包含在输出中的，除此之外其他任何字段，如果想要在输出中体现的话，必须在 project 中指定；如果指定包含一个尚不存在的字段，那么 project 会忽略这个字段，不会加入到输出的文档中；

指定排除字段

如果你在 project 中指定排除某个字段，那么其它字段都会体现在输出中；如果指定排除的是非 _id 字段，那么在本次 project 中，不能再使用其它表达式；

加入新的字段或重置某个已有字段

你可以使用一些特殊的表达式加入新的字段，或重置某个已有字段。

多层嵌套的字段

有时有些字段处于多层嵌套的底层，我们可以使用点记法：

  1. "contact.phone.number": <1 or 0 or 表达式>

也可以直接使用嵌套的格式：

  1. contact: { phone: { number: <1 or 0 or 表达式> } }

示例

假设我们有一个 articles 集合，其中含有以下文档：

  1. {
  2.     "_id": 666,
  3.     "title": "This is title",
  4.     "author": "Nobody",
  5.     "isbn": "123456789",
  6.     "introduction": "......"
  7. }

指定包含某些字段

下面的代码使用 project，让输出只包含 _id、title 和 author 字段：

  1. db.collection('articles')
  2.   .aggregate()
  3.   .project({
  4.     title: 1,
  5.     author: 1
  6.   })
  7.   .end()

输出如下：

  1. { "_id" : 666, "title" : "This is title", "author" : "Nobody" }

去除输出中的 _id 字段

_id 是默认包含在输出中的，如果不想要它，可以指定去除它：

  1. db.collection('articles')
  2.   .aggregate()
  3.   .project({
  4.     _id: 0,  // 指定去除 _id 字段
  5.     title: 1,
  6.     author: 1
  7.   })
  8.   .end()

输出如下：

  1. { "title" : "This is title", "author" : "Nobody" }

去除某个非 _id 字段

我们还可以指定在输出中去掉某个非 _id 字段，这样其它字段都会被输出：

  1. db.collection('articles')
  2.   .aggregate()
  3.   .project({
  4.     isbn: 0,  // 指定去除 isbn 字段
  5.   })
  6.   .end()

输出如下，相比输入，没有了 isbn 字段：

  1. {
  2.     "_id" : 666,
  3.     "title" : "This is title",
  4.     "author" : "Nobody",
  5.     "introduction": "......"
  6. }

加入计算出的新字段

假设我们有一个 students 集合，其中包含以下文档：

  1. {
  2.     "_id": 1,
  3.     "name": "小明",
  4.     "scores": {
  5.         "chinese": 80,
  6.         "math": 90,
  7.         "english": 70
  8.     }
  9. }

下面的代码，我们使用 project，在输出中加入了一个新的字段 totalScore：

  1. const { sum } = db.command.aggregate
  2. db.collection('students')
  3.   .aggregate()
  4.   .project({
  5.     _id: 0,
  6.     name: 1,
  7.     totalScore: sum([
  8.         "$scores.chinese",
  9.         "$scores.math",
  10.         "$scores.english"
  11.     ])
  12.   })
  13.   .end()

输出为：

  1. { "name": "小明", "totalScore": 240 }

加入新的数组字段

假设我们有一个 points 集合，包含以下文档：

  1. { "_id": 1, "x": 1, "y": 1 }
  2. { "_id": 2, "x": 2, "y": 2 }
  3. { "_id": 3, "x": 3, "y": 3 }

下面的代码，我们使用 project，把 x 和 y 字段，放入到一个新的数组字段 coordinate 中：

  1. db.collection('points')
  2.   .aggregate()
  3.   .project({
  4.     coordinate: ["$x", "$y"]
  5.   })
  6.   .end()

输出如下：

  1. { "_id": 1, "coordinate": [1, 1] }
  2. { "_id": 2, "coordinate": [2, 2] }
  3. { "_id": 3, "coordinate": [3, 3] }