cursor.hint()

Definición

cursor.hint(index)

Importante

Método mongosh

Este es un método mongosh. Esta no es la documentación de Node.js ni de otros métodos de controladores específicos de lenguajes de programación.

En la mayoría de los casos, los métodos mongosh funcionan de la misma manera que los métodos tradicionales mongo métodos shell. Sin embargo, algunos métodos heredados no están disponibles en mongosh.

Para la documentación heredada de mongo shell, revisa la documentación de la versión correspondiente de MongoDB Server:

• mongo shell v4.4

• mongo shell v4.2

• mongo shell v4.0

Para los controladores de la API de MongoDB, consultar la documentación específica del controlador de MongoDB para cada lenguaje.

Llama a este método en una query para anular la selección predeterminada de índices de MongoDB y el proceso de optimización de query. Utiliza db.collection.getIndexes() para devolver la lista de índices actuales de una colección.

El método cursor.hint() tiene el siguiente parámetro:

Parameter	Tipo	Descripción
index	string o documento	El índice para "indicar" o forzar que MongoDB utilice al realizar la query. Especifique el índice ya sea por el nombre del índice o mediante el documento de especificación del índice. También puedes especificar { $natural : 1 } para forzar que la query realice un escaneo de colección progresivo, o { $natural : -1 } para un escaneo de colección regresivo.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Comportamiento

• Cuando existe un filtro de índice para la forma del query, MongoDB ignora el hint().

• Si una query incluye una expresión $text, no se puede usar hint() para especificar qué índice usar para la query.

• No puedes usar hint() en un índice oculto.

• En colecciones de series temporales, solo puedes especificar pistas utilizando el nombre del índice, no el patrón de clave del índice.

Ejemplos

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

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

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

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