Definición
cursor.hint(index)Importante
Método mongosh
Esta página documenta un método
mongosh. Esta no es la documentación para un driver específico de lenguaje, como Node.js.Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.
Llama a este método en una query para anular la selección de índice por defecto de MongoDB y proceso de optimización de query. Utilice
db.collection.getIndexes()para devolver la lista de índices actuales de una colección.El método
cursor.hint()tiene el siguiente parámetro:ParameterTipoDescripciónindexstring 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
Nota
Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulte Comandos no compatibles.
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 usarhint()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
Especifica un índice
El siguiente ejemplo devuelve todos los documentos en la colección llamada users usando el índice en el campo age.
db.users.find().hint( { age: 1 } )
También se puede especificar el índice utilizando el nombre del índice:
db.users.find().hint( "age_1" )
Forzar escaneo de colección
Puedes especificar { $natural : 1 } para que la query realice un escaneo de colección hacia adelante:
db.users.find().hint( { $natural : 1 } )
También puedes especificar { $natural : -1 } para forzar que la query realice un escaneo inverso de la colección:
db.users.find().hint( { $natural : -1 } )