游标()（mongosh方法）

定义

cursor.hint(index)

重要

mongosh 方法

This page documents a mongosh method. This is not the documentation for a language-specific driver, such as Node.js.

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

对查询调用此方法可覆盖 MongoDB 的默认索引选择和查询优化过程。使用 db.collection.getIndexes() 返回集合的当前索引列表。

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

Parameter	类型	说明
index	字符串或文档	执行查询时“提示”或强制 MongoDB 使用的索引。通过索引名称或索引规范文档来指定索引。 您还可以指定{ $natural : 1 }强制查询，以执行正向集合扫描，或指定{ $natural : -1 }，以执行反向集合扫描。

兼容性

此方法可用于以下环境中托管的部署：

• MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

行为

• When an index filter exists for the query shape, MongoDB ignores the hint().

• If a query includes a $text expression, you cannot use hint() to specify which index to use for the query.

• If you use hint() on a hidden index or an index that doesn't exist, the operation returns an error.

• 在时间序列集合上，只能使用索引名称而不能使用索引键模式来指定提示。

• 集群查询设置优先于作为命令字段传递的查询设置或索引提示。如果匹配的查询设置已包含索引提示，MongoDB将忽略命令字段中的索引提示。

  索引提示不会影响查询结构。

  有关提示和查询设置的更多信息，请参阅查询设置语法。

示例

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

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

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

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