cursor.hint()

Definition定义

cursor.hint(index)

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for a language-specific driver, such as Node.js.本页记录了一个mongosh方法。这不是针对特定语言驱动程序（如Node.js）的文档。

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.有关MongoDB API驱动程序，请参阅特定语言的MongoDB驱动程序文档。

Call this method on a query to override MongoDB's default index selection and query optimization process. 对查询调用此方法以覆盖MongoDB的默认索引选择和查询优化过程。Use db.collection.getIndexes() to return the list of current indexes on a collection.使用db.collection.getIndexes()返回集合上的当前索引列表。

The cursor.hint() method has the following parameter:cursor.hint()方法具有以下参数：

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.执行查询时要“提示”或强制MongoDB使用的索引。通过索引名称或索引规范文档指定索引。 You can also specify { $natural : 1 } to force the query to perform a forwards collection scan, or { $natural : -1 } for a reverse collection scan. 您还可以指定{ $natural : 1 }以强制查询执行正向集合扫描，或者指定{ $natural : -1 }以执行反向集合扫描。

Behavior行为

• When an index filter exists for the query shape, MongoDB ignores the hint().当查询形状存在索引筛选器时，MongoDB会忽略hint()。
• If a query includes a $text expression, you cannot use hint() to specify which index to use for the query.如果查询包含$text表达式，则不能使用hint()指定用于查询的索引。
• If you use hint() on a hidden index or an index that doesn't exist, the operation returns an error.如果对隐藏索引或不存在的索引使用hint()，则操作将返回错误。
• On a time series collections, you can only specify hints using the index name, not the index key pattern.在时间序列集合中，只能使用索引名称而不是索引键模式指定提示。

Examples实例

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

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

db.users.find().hint( { $natural : 1 } )

db.users.find().hint( { $natural : -1 } )