聚合

用于构建聚合管道的 Aggregate 构造函数。不要直接实例化此类，请使用 Model.aggregate() 代替。

示例

const aggregate = Model.aggregate([
  { $project: { a: 1, b: 1 } },
  { $skip: 5 }
]);

Model.
  aggregate([{ $match: { age: { $gte: 21 }}}]).
  unwind('tags').
  exec();

注意

• 返回的文档是纯 JavaScript 对象，而不是 Mongoose 文档（因为可以返回任何形状的文档）。

• Mongoose **不会** 转换管道阶段。以下**将不起作用**，除非数据库中的 _id 是字符串

  new Aggregate([{ $match: { _id: '00000000000000000000000a' } }]); // 改为这样做以转换为 ObjectId new Aggregate([{ $match: { _id: new mongoose.Types.ObjectId('00000000000000000000000a') } }]);

将新的 $addFields 运算符附加到此聚合管道。需要 MongoDB v3.4+ 才能工作

示例

// adding new fields based on existing fields
aggregate.addFields({
    newField: '$b.nested'
  , plusTen: { $add: ['$val', 10]}
  , sub: {
       name: '$a'
    }
})

// etc
aggregate.addFields({ salary_k: { $divide: [ "$salary", 1000 ] } });

为聚合查询设置 allowDiskUse 选项

示例

await Model.aggregate([{ $match: { foo: 'bar' } }]).allowDiskUse(true);

将新的运算符附加到此聚合管道

示例

aggregate.append({ $project: { field: 1 }}, { $limit: 2 });

// or pass an array
const pipeline = [{ $match: { daw: 'Logic Audio X' }} ];
aggregate.append(pipeline);

执行聚合并返回一个Promise，该Promise 将解析为文档或拒绝错误。与 .then() 相似，但只接受拒绝处理程序。与await 兼容。

添加排序规则

示例

const res = await Model.aggregate(pipeline).collation({ locale: 'en_US', strength: 1 });

将新的 $count 运算符附加到此聚合管道。

示例

aggregate.count("userCount");

设置cursor 选项并执行此聚合，返回一个聚合游标。如果您想一次处理聚合的结果，因为聚合结果太大而无法放入内存，则游标很有用。

示例

const cursor = Model.aggregate(..).cursor({ batchSize: 1000 });
cursor.eachAsync(function(doc, i) {
  // use doc
});

将新的 $densify 运算符附加到此聚合管道。

示例

 aggregate.densify({
   field: 'timestamp',
   range: {
     step: 1,
     unit: 'hour',
     bounds: [new Date('2021-05-18T00:00:00.000Z'), new Date('2021-05-18T08:00:00.000Z')]
   }
 });

在当前绑定的模型上执行聚合管道。

示例

const result = await aggregate.exec();

使用 explain 执行聚合

示例

Model.aggregate(..).explain()

组合多个聚合管道。

示例

const res = await Model.aggregate().facet({
  books: [{ groupBy: '$author' }],
  price: [{ $bucketAuto: { groupBy: '$price', buckets: 2 } }]
});

// Output: { books: [...], price: [{...}, {...}] }

将新的 $fill 运算符附加到此聚合管道。

示例

 aggregate.fill({
   output: {
     bootsSold: { value: 0 },
     sandalsSold: { value: 0 },
     sneakersSold: { value: 0 }
   }
 });

执行聚合并返回一个Promise，该Promise 将解析为.finally() 链。

关于 JavaScript 中的 Promise finally() 的更多信息。

将新的自定义 $graphLookup 运算符附加到此聚合管道，在集合上执行递归搜索。

请注意，graphLookup 最多只能使用 100 MB 内存，即使指定了{ allowDiskUse: true }，也不允许使用磁盘。

示例

 // Suppose we have a collection of courses, where a document might look like `{ _id: 0, name: 'Calculus', prerequisite: 'Trigonometry'}` and `{ _id: 0, name: 'Trigonometry', prerequisite: 'Algebra' }`
 aggregate.graphLookup({ from: 'courses', startWith: '$prerequisite', connectFromField: 'prerequisite', connectToField: 'name', as: 'prerequisites', maxDepth: 3 }) // this will recursively search the 'courses' collection up to 3 prerequisites

将新的自定义 $group 运算符附加到此聚合管道。

示例

aggregate.group({ _id: "$department" });

为聚合查询设置提示选项

示例

Model.aggregate(..).hint({ qty: 1, category: 1 }).exec();

将新的 $limit 运算符附加到此聚合管道。

示例

aggregate.limit(10);

将新的自定义 $lookup 运算符附加到此聚合管道。

示例

aggregate.lookup({ from: 'users', localField: 'userId', foreignField: '_id', as: 'users' });

将新的自定义 $match 运算符附加到此聚合管道。

示例

aggregate.match({ department: { $in: [ "sales", "engineering" ] } });

获取/设置此聚合将在其上执行的模型。

示例

const aggregate = MyModel.aggregate([{ $match: { answer: 42 } }]);
aggregate.model() === MyModel; // true

// Change the model. There's rarely any reason to do this.
aggregate.model(SomeOtherModel);
aggregate.model() === SomeOtherModel; // true

将新的 $geoNear 运算符附加到此聚合管道。

注意

**必须**用作管道中的第一个运算符。

示例

aggregate.near({
  near: { type: 'Point', coordinates: [40.724, -73.997] },
  distanceField: "dist.calculated", // required
  maxDistance: 0.008,
  query: { type: "public" },
  includeLocs: "dist.location",
  spherical: true,
});

允许您设置任意选项，用于中间件或插件。

示例

const agg = Model.aggregate(..).option({ allowDiskUse: true }); // Set the `allowDiskUse` option
agg.options; // `{ allowDiskUse: true }`

包含传递到 聚合命令 的选项。支持的选项包括

• allowDiskUse
• bypassDocumentValidation
• collation
• comment
• cursor
• explain
• fieldsAsRaw
• hint
• let
• maxTimeMS
• raw
• readConcern
• readPreference
• session
• writeConcern

返回当前管道

示例

MyModel.aggregate().match({ test: 1 }).pipeline(); // [{ $match: { test: 1 } }]

将新的 $project 运算符附加到此聚合管道。

Mongoose 查询 选择语法 也受支持。

示例

// include a, include b, exclude _id
aggregate.project("a b -_id");

// or you may use object notation, useful when
// you have keys already prefixed with a "-"
aggregate.project({a: 1, b: 1, _id: 0});

// reshaping documents
aggregate.project({
    newField: '$b.nested'
  , plusTen: { $add: ['$val', 10]}
  , sub: {
       name: '$a'
    }
})

// etc
aggregate.project({ salary_k: { $divide: [ "$salary", 1000 ] } });

为聚合查询设置 readPreference 选项。

示例

await Model.aggregate(pipeline).read('primaryPreferred');

为聚合查询设置 readConcern 级别。

示例

await Model.aggregate(pipeline).readConcern('majority');

将新的 $redact 运算符附加到此聚合管道。

如果提供 3 个参数，Mongoose 将分别使用 $cond 运算符的 if-then-else 包装它们 如果thenExpr 或elseExpr 是字符串，请确保它以 $$ 开头，例如$$DESCEND、$$PRUNE 或$$KEEP。

示例

await Model.aggregate(pipeline).redact({
  $cond: {
    if: { $eq: [ '$level', 5 ] },
    then: '$$PRUNE',
    else: '$$DESCEND'
  }
});

// $redact often comes with $cond operator, you can also use the following syntax provided by mongoose
await Model.aggregate(pipeline).redact({ $eq: [ '$level', 5 ] }, '$$PRUNE', '$$DESCEND');

将新的 $replaceRoot 运算符附加到此聚合管道。

请注意，$replaceRoot 运算符要求字段字符串以 '$' 开头。如果您传入一个字符串，Mongoose 将在指定字段未以 '$' 开头的情况下添加 '$'。如果您传入一个对象，则表达式中的字符串将不会被修改。

示例

aggregate.replaceRoot("user");

aggregate.replaceRoot({ x: { $concat: ['$this', '$that'] } });

将新的自定义 $sample 运算符附加到此聚合管道。

示例

aggregate.sample(3); // Add a pipeline that picks 3 random documents

用于 Atlas 文本搜索 的$search 阶段的助手。

示例

const res = await Model.aggregate().
 search({
   text: {
     query: 'baseball',
     path: 'plot'
   }
 });

// Output: [{ plot: '...', title: '...' }]

为此聚合设置会话。对 事务 有用。

示例

const session = await Model.startSession();
await Model.aggregate(..).session(session);

将新的 $skip 运算符附加到此聚合管道。

示例

aggregate.skip(10);

将新的 $sort 运算符附加到此聚合管道。

如果传入一个对象，允许的值为asc、desc、ascending、descending、1 和-1。

如果传入一个字符串，它必须是空格分隔的路径名称列表。每个路径的排序顺序为升序，除非路径名称以- 为前缀，这将被视为降序。

示例

// these are equivalent
aggregate.sort({ field: 'asc', test: -1 });
aggregate.sort('field -test');

将新的 $sortByCount 运算符附加到此聚合管道。接受字符串字段名称或管道对象。

请注意，$sortByCount 运算符要求新的根以 '$' 开头。如果指定字段名称未以 '$' 开头，Mongoose 将添加 '$'。

示例

aggregate.sortByCount('users');
aggregate.sortByCount({ $mergeObjects: [ "$employee", "$business" ] })

提供一个 Promise 类型的then 函数，该函数将在没有回调的情况下调用.exec 与await 兼容。

示例

Model.aggregate(..).then(successCallback, errorCallback);

将新的 $unionWith 运算符附加到此聚合管道。

示例

aggregate.unionWith({ coll: 'users', pipeline: [ { $match: { _id: 1 } } ] });

将新的自定义 $unwind 运算符附加到此聚合管道。

请注意，$unwind 运算符要求路径名称以 '$' 开头。如果指定的字段不以 '$' 开头，Mongoose 会在前面加上 '$'。

示例

aggregate.unwind("tags");
aggregate.unwind("a", "b", "c");
aggregate.unwind({ path: '$tags', preserveNullAndEmptyArrays: true });

返回一个用于 for/await/of 循环 的异步迭代器。您无需显式调用此函数，JavaScript 运行时将为您调用它。

示例

const agg = Model.aggregate([{ $match: { age: { $gte: 25 } } }]);
for await (const doc of agg) {
  console.log(doc.name);
}

Node.js 10.x 本机支持异步迭代器，无需任何标志。您可以使用 --harmony_async_iteration 标志 在 Node.js 8.x 中启用异步迭代器。

注意：如果 Symbol.asyncIterator 未定义，则不会设置此函数。如果 Symbol.asyncIterator 未定义，则意味着您的 Node.js 版本不支持异步迭代器。