cursor.addOption()¶

On this page

Definition
Flags
Example

Definition¶

cursor.addOption(flag)¶

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for a language-specific driver such as Node.js.

For MongoDB API drivers, refer to the language-specific :driver:`MongoDB driver documentation </>`.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

:v4.4:`mongo shell v4.4 </mongo>`
mongo shell v4.2

Note

Deprecated since v3.2

Starting in v3.2, the cursor.addOption() operator is deprecated in mongo. Use available cursor methods instead.

Used to change query behavior by setting the flags listed below.

The cursor.addOption() method has the following parameter:

Parameter	Type	Description
`flag`	flag	For `mongosh`, you can use the cursor flags listed below. For the driver-specific list, see your :driver:`driver documentation </>`.

Flags¶

mongosh provides several additional cursor flags to modify the behavior of the cursor.

Flag	Description
`DBQuery.Option.tailable`¶	Sets the cursor not to close once the last data is received, allowing the query to continue returning data added after the initial results were exhausted.
`DBQuery.Option.slaveOk`¶	Allows querying of a replica secondary.
`DBQuery.Option.noTimeout`¶	Prevents the server from timing out idle cursors.
`DBQuery.Option.awaitData`¶	For use with .. data:: DBQuery.Option.tailable; sets the cursor to block and await data for a while rather than returning no data. The cursor will return no data once the timeout has expired.
`DBQuery.Option.exhaust`¶	Sets the cursor to return all data returned by the query at once rather than splitting the results into batches.
`DBQuery.Option.partial`¶	Sets the cursor to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.

Example¶

The following example adds the DBQuery.Option.tailable flag and the DBQuery.Option.awaitData flag to ensure that the query returns a tailable cursor. The sequence creates a cursor that will wait for few seconds after returning the full result set so that it can capture and return additional data added during the query:

copy

var t = db.myCappedCollection;
var cursor = t.find().addOption(DBQuery.Option.tailable).
                      addOption(DBQuery.Option.awaitData)

Warning

Adding incorrect wire protocol flags can cause problems and/or extra server load.

← Cursor Methods cursor.allowDiskUse() →