クエリカーソル

クエリカーソルは、クエリ結果を一度に1つのドキュメントずつ処理するための並行処理プリミティブです。クエリカーソルは、MongoDBからドキュメントを1つずつロードするための他のいくつかのメカニズムに加えて、Node.js streams3 APIを満たします。

クエリカーソルは、MongoDBからドキュメントを読み込む前にモデルのpre `find`フックを実行し、各ドキュメントを読み込んだ後にモデルのpost `find`フックを実行します。

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

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

このカーソルを閉じられたとしてマークします。ストリーミングを停止し、後続の`next（）`の呼び出しはエラーになります。

カーソルのすべてのドキュメントに対して`fn`を実行します。 `fn`がPromiseを返す場合、次のドキュメントに進む前にPromiseが解決するのを待ちます。完了したら解決するPromiseを返します。

例

// Iterate over documents asynchronously
Thing.
  find({ name: /^hello/ }).
  cursor().
  eachAsync(async function (doc, i) {
    doc.foo = doc.bar + i;
    await doc.save();
  })

このカーソルが使用するMongoDBノードドライバーから、基になるカーソルを返します。

ストリームインターフェースまたは`.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`を返します。

`QueryCursor`コンストラクターに渡された`options`。

このカーソルを初期化されていない状態に巻き戻します。カーソルに存在するオプションはすべて有効なままです。このカーソルを反復処理すると、結果のデータがこのカーソルによって既に取得されている場合でも、サーバーに新しいクエリが送信されます。

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

例

// Works without using `cursor()`
for await (const doc of Model.find([{ $sort: { name: 1 } }])) {
  console.log(doc.name);
}

// Can also use `cursor()`
for await (const doc of Model.find([{ $sort: { name: 1 } }]).cursor()) {
  console.log(doc.name);
}

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

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