カーソルメソッド

注意

mongosh メソッド

この目次ページにリストされているメソッドは、 mongoshメソッドです。これは、 Node.jsまたはその他のプログラミング言語固有のドライバーメソッドのドキュメントではありません。

ほとんどの場合、 mongoshメソッドはレガシーの mongo shell メソッドと同じように動作します。ただし、一部のレガシーメソッドはmongoshでは利用できません。

MongoDB API ドライバーについては、各言語のMongoDB ドライバードキュメントを参照してください。

これらのメソッドは、基礎のクエリの実行方法を変更します。

注意

構文や例など、特定のメソッドの詳細については、「メソッドの参照ページ」へのリンクをクリックしてください。

名前	説明
`cursor.addOption()`	クエリの動作を変更する特別なワイヤプロトコルフラグを追加します。
`cursor.allowDiskUse()`	MongoDB ではブロッキングソート操作の処理中にディスクの一時ファイルを使用して 100 メガバイトのシステムメモリ制限を超えるデータを保存できるようになります。
`cursor.allowPartialResults()`	シャーディングされたコレクションに対する `db.collection.find()` 操作では、クエリされたシャードが 1 つ以上利用できない場合に、エラーではなく部分的な結果を返すことができます。
`cursor.batchSize()`	MongoDB が単一のネットワークメッセージでクライアントに返すドキュメントの数を制御します。
`cursor.close()`	カーソルを閉じて、関連付けられているサーバーリソースを解放します。
`cursor.isClosed()`	カーソルが閉じている場合は `true` を返します。
`cursor.collation()`	`db.collection.find()` によって返されるカーソルの照合を指定します。
`cursor.comment()`	ログおよび system.profile コレクションのトレーサビリティを確保できるように、クエリにコメントを付けます。
`cursor.count()`	カーソルがドキュメントそのものではなく、結果セット内のドキュメント数を返すように変更します。
`cursor.explain()`	カーソルのクエリ実行プランについて報告します。
`cursor.forEach()`	カーソル内のすべてのドキュメントに JavaScript 関数を適用します。
`cursor.hasNext()`	カーソルにドキュメントがあり、反復処理できる場合は true を返します。
`cursor.hint()`	MongoDB がクエリに特定のインデックスを使用するように強制します。
`cursor.isExhausted()`	カーソルが閉じており、かつ、バッチにオブジェクトが残っていない場合は `true` を返します。
`cursor.itcount()`	結果セットを取得して反復処理することにより、クライアント側のカーソルにあるドキュメントの総数を計算します。
`cursor.limit()`	カーソルの結果セットのサイズを制限します。
`cursor.map()`	カーソル内の各ドキュメントに関数を適用し、戻り値を配列に収集します。
`cursor.max()`	カーソルに対して限定的な上位インデックスの限界を指定します。使用用途 `cursor.hint()`
`cursor.maxTimeMS()`	カーソルに対する情報処理操作の累積時間制限をミリ秒単位で指定します。
`cursor.min()`	カーソルに対して限定しない下位インデックスの限界を指定します。使用用途 `cursor.hint()`
`cursor.next()`	カーソル内の次のドキュメントを返します。
`cursor.noCursorTimeout()`	非アクティブな状態が一定期間続いた後、カーソルを自動的に閉じないようサーバーへ指示します。
`cursor.objsLeftInBatch()`	現在のカーソルバッチに残っているドキュメントの数を返します。
`cursor.pretty()`	結果を読みやすい形式で表示するようカーソルを設定します。
`cursor.readConcern()`	`find()`操作の読み取り保証（read concern）を指定します。
`cursor.readPref()`	カーソルに読み込み設定（read preference）を指定して、クライアントがレプリカセットにクエリを送信する方法を制御します。
`cursor.returnKey()`	カーソルを変更して、ドキュメントではなくインデックスキーを返します。
`cursor.showRecordId()`	カーソルによって返される各ドキュメントに内部 storage engine ID フィールドを追加します。
`cursor.size()`	`skip()`および`limit()`メソッドを適用した後、カーソル内のドキュメントの数を返します。
`cursor.skip()`	一定数のドキュメントを渡したりスキップした後にのみ結果を返し始めるカーソルを返します。
`cursor.sort()`	ソート指定に従って順序付けられた結果を返します。
`cursor.tailable()`	カーソルを末尾可能としてマークします。上限付きコレクションのカーソルに対してのみ有効です。
`cursor.toArray()`	カーソルによって返されたすべてのドキュメントを含む配列を返します。
`cursor.tryNext()`	反復に次の要素がある場合はそれを返し、ない場合は null を返します。

戻る

db.collection.watch

cursor.addOption