cursor.forEach()

Definition

cursor.forEach(function)

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 MongoDB driver documentation.

Iterates the cursor to apply a JavaScript function to each document from the cursor.

Compatibility

This method is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB

• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Syntax

The method has the following syntax:

db.collection.find().forEach( <function> )

Method Fields

The method accepts the following field:

Examples

Create the users collection:

db.users.insertMany( [
   { name: "John" },
   { name: "Jane" }
] )

The following example uses forEach() with the find() method to print the user names that are read from the users collection. myDoc stores the current document.

db.users.find().forEach( function( myDoc ) {
   print( "User name: " + myDoc.name )
} )

Example output:

User name: John
User name: Jane

Starting in mongosh 2.1.0, you can also use for-of loops. The following example returns the same results as the previous example:

for ( const myDoc of db.users.find() ) {
   print( "User name: " + myDoc.name )
}

Learn More

For a method that has similar functionality, see cursor.map().