/ /

Métodos del cursor

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 6.0, consulte Procedimientos de actualización de MongoDB.7.0

Nota

Métodos mongosh

Los métodos enumerados en esta página de índice son Métodos mongosh. Esta no es la documentación de Node.js ni de los métodos de controlador específicos de otros lenguajes de programación.

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

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

Estos métodos modifican la forma en que se ejecuta la query subyacente.

Nota

Para obtener detalles sobre un método específico, incluida la sintaxis y los ejemplos, haz clic en el enlace a la página de referencia del método.

Nombre	Descripción
`cursor.addOption()`	Agrega indicadores especiales de protocolo de conexión que modifican el comportamiento del query.
`cursor.allowDiskUse()`	Permite a MongoDB utilizar archivos temporales en disco para almacenar datos que superan el límite de memoria del sistema de 100 megabytes mientras se está procesando una operación de clasificación en memoria.
`cursor.batchSize()`	Controla el número de documentos que MongoDB devolverá al cliente en un único mensaje de red.
`cursor.close()`	Cierra un cursor y libera los recursos del servidor asociados.
`cursor.isClosed()`	Devuelve `true` si el cursor está cerrado.
`cursor.collation()`	Especifica la intercalación para el cursor devuelto por el `db.collection.find()`.
`cursor.comment()`	Adjunta un comentario a la query para permitir la trazabilidad en los registros y en la colección system.profile.
`cursor.count()`	Modifica el cursor para devolver el número de documentos en el conjunto de resultados en lugar de los documentos mismos.
`cursor.explain()`	Informes sobre el plan de ejecución de la query para un cursor.
`cursor.forEach()`	Aplica una función de JavaScript para cada documento en un cursor.
`cursor.hasNext()`	Muestra verdadero si el cursor tiene documentos y puede ser iterado.
`cursor.hint()`	Obliga a MongoDB a usar un índice específico para una query.
`cursor.isExhausted()`	Muestra `true` si el cursor está cerrado y no quedan objetos en la agrupación.
`cursor.itcount()`	Calcula el número total de documentos del lado del cliente del cursor al obtener e iterar el conjunto de resultados.
`cursor.limit()`	Limita el tamaño del conjunto de resultados de un cursor.
`cursor.map()`	Aplica una función a cada documento en un cursor y recopila los valores de retorno en un arreglo.
`cursor.max()`	Especifica un límite superior exclusivo de los límites del índice para un cursor. Para su uso con `cursor.hint()`
`cursor.maxAwaitTimeMS()`	Se especifica un límite en milisegundos para esperar la siguiente actualización del resultado de la query.
`cursor.maxTimeMS()`	Especifica un límite de tiempo acumulativo en milisegundos para las operaciones de procesamiento en un cursor.
`cursor.min()`	Especifica un límite inferior inclusivo de los límites del índice para un cursor. Para su uso con `cursor.hint()`
`cursor.next()`	Devuelve el siguiente documento en un cursor.
`cursor.noCursorTimeout()`	Instruye al servidor para que evite cerrar automáticamente un cursor después de un período de inactividad.
`cursor.objsLeftInBatch()`	Devuelve el número de documentos restantes en la agrupación actual del cursor.
`cursor.pretty()`	Configura el cursor para mostrar los resultados en un formato de fácil lectura.
`cursor.readConcern()`	Especifica un nivel de consistencia de lectura para una operación de `find()`.
`cursor.readPref()`	Especifica una preferencia de lectura para un cursor para controlar cómo el cliente dirige las consultas a un set de réplicas.
`cursor.returnKey()`	Modifica el cursor para devolver las claves del índice en lugar de los documentos.
`cursor.showRecordId()`	Añade un campo de ID interno del motor de almacenamiento a cada documento devuelto por el cursor.
`cursor.size()`	Devuelve un recuento de los documentos en el cursor tras aplicar los métodos `skip()` y `limit()`.
`cursor.skip()`	Devuelve un cursor que comienza a devolver resultados solo después de pasar o saltar un número de documentos.
`cursor.sort()`	Devuelve los resultados ordenados conforme a una especificación de clasificación.
`cursor.tailable()`	Marca el cursor como con seguimiento. Solo válido para cursores sobre colecciones con tamaño fijo.
`cursor.toArray()`	Devuelve un arreglo que contiene todos los documentos devueltos por el cursor.
`cursor.tryNext()`	Se devuelve el siguiente elemento en la iteración si está disponible o, de lo contrario, nulo.

Volver

db.colección.watch

cursor.addOption