集約カーソル

集約カーソルは、集約結果を一度に1つのドキュメントずつ処理するための並行処理プリミティブです。クエリカーソルに類似しています。

集約カーソルは、MongoDBからドキュメントを1つずつロードするための他のいくつかのメカニズムに加えて、Node.js streams3 APIを満たします。

集約カーソルを作成すると、モデルの事前集約フックは実行されますが、モデルの事後集約フックは**実行されません**。

上級ユーザーでない限り、このクラスを直接インスタンス化**しないでください**。代わりにAggregate#cursor()を使用してください。

カーソルフラグを追加します。 noCursorTimeoutおよびtailableフラグの設定に役立ちます。

このカーソルを閉じているとマークします。ストリーミングを停止し、後続のnext()の呼び出しはエラーになります。

カーソルのすべてのドキュメントに対してfnを実行します。 fnがプロミスを返す場合、次のドキュメントに進む前にプロミスが解決されるまで待機します。完了時に解決されるプロミスを返します。

ストリームインターフェースまたは.next()を介して取得されたドキュメントを後続にマップする変換関数を登録します

例

// Map documents returned by `data` events
Thing.
  find({ name: /^hello/ }).
  cursor().
  map(function (doc) {
   doc.foo = "bar";
   return doc;
  })
  on('data', function(doc) { console.log(doc.foo); });

// Or map documents returned by `.next()`
const cursor = Thing.find({ name: /^hello/ }).
  cursor().
  map(function (doc) {
    doc.foo = "bar";
    return doc;
  });
cursor.next(function(error, doc) {
  console.log(doc.foo);
});

このカーソルから次のドキュメントを取得します。ドキュメントが残っていない場合はnullを返します。

for/await/ofループで使用するasyncIteratorを返します。この関数を明示的に呼び出す必要はありません。JavaScriptランタイムが自動的に呼び出します。

例

// Async iterator without explicitly calling `cursor()`. Mongoose still
// creates an AggregationCursor instance internally.
const agg = Model.aggregate([{ $match: { age: { $gte: 25 } } }]);
for await (const doc of agg) {
  console.log(doc.name);
}

// You can also use an AggregationCursor instance for async iteration
const cursor = Model.aggregate([{ $match: { age: { $gte: 25 } } }]).cursor();
for await (const doc of cursor) {
  console.log(doc.name);
}

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

**注：** Symbol.asyncIteratorが未定義の場合、この関数は設定されません。 Symbol.asyncIteratorが未定義の場合、Node.jsバージョンが非同期イテレータをサポートしていないことを意味します。