Navigation
This version of the manual is no longer supported.

cursor.hint()

cursor.hint(index)
Arguments:
  • index

    The index to “hint” or force MongoDB to use when performing the query.

    Specify the index either by the index name or by the index specification document. See Index Specification Documents for information on index specification documents.

Call this method on a query to override MongoDB’s default index selection and query optimization process. Use db.collection.getIndexes() to return the list of current indexes on a collection.

Consider the following operation:

db.users.find().hint( { age: 1 } )

This operation returns all documents in the collection named users using the index on the age field.

You can also specify the index using the index name:

db.users.find().hint( "age_1" )

See also

$hint