- Reference >
mongo
Shell Methods >- Cursor Methods >
- cursor.hint()
cursor.hint()¶
On this page
Definition¶
-
cursor.
hint
(index)¶ 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.The
cursor.hint()
method has the following parameter:Parameter Type Description index
string or document 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.
Behavior¶
When an index filter exists for the query shape,
MongoDB ignores the hint()
.
You cannot use hint()
if the query includes
a $text
query expression.
Example¶
The following example 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: