集計

集計パイプラインを構築するために使用される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を返します。.then()に似ていますが、拒否ハンドラーのみを受け取ります。awaitと互換性があります。

照合を追加します

例

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

この集計パイプラインに新しい$count演算子を追加します。

例

aggregate.count("userCount");

cursorオプションを設定し、この集計を実行して、集計カーソルを返します。集計結果が大きすぎてメモリに収まらないため、集計結果を一度に1つずつ処理したい場合にカーソルが役立ちます。

例

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 }
   }
 });

.finally()がチェーンされた状態で解決されるPromiseを返す集計を実行します。

JavaScriptでのPromise finally()の詳細。

この集計パイプラインに新しいカスタム$graphLookup演算子を追加し、コレクションで再帰的な検索を実行します。

graphLookupは最大100MBのメモリしか消費できず、{ 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 }`

aggregateコマンドに渡されるオプションが含まれています。サポートされているオプションは次のとおりです。

• 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 Text Search の $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 ループで使用するための asyncIterator を返します。この関数を明示的に呼び出す必要はありません。JavaScript ランタイムが代わりに呼び出します。

例

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

Node.js 10.x は、フラグなしで async iterator をネイティブにサポートしています。Node.js 8.x では、--harmony_async_iteration フラグを使用して async iterator を有効にできます。

注: Symbol.asyncIterator が未定義の場合、この関数は設定されません。Symbol.asyncIterator が未定義の場合、お使いの Node.js バージョンが async iterator をサポートしていないことを意味します。