cursor.addOption()

Definition

cursor.addOption(flag)

Important

mongosh Method

This is a mongosh method. This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

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

• mongo shell v4.4

• mongo shell v4.2

• mongo shell v4.0

For MongoDB API drivers, refer to the language specific MongoDB driver documentation.

Note

Deprecated since v3.2

Starting in v3.2, the cursor.addOption() operator is deprecated in mongosh. In mongosh, use available cursor methods instead.

Adds OP_QUERY wire protocol flags, such as the tailable flag, to change the behavior of queries.

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

Parameter	Type	Description
flag	flag	OP_QUERY wire protocol flag. For mongosh, you can use the cursor flags listed below. For the driver-specific list, see your driver documentation.

Flags

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

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:

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