cursor.addOption()

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 5.0, consulta el Procedimientos de actualización de MongoDB 6.0 .

Definición

cursor.addOption(flag)

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:

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

Nota

Obsoleto desde la v3.2

A partir de la v3.2, el operador cursor.addOption() está obsoleto en mongosh. En mongosh, usa los métodos de cursor disponibles en su lugar.

Se utiliza para cambiar el comportamiento de las consultas configurando las banderas que se indican a continuación.

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

Parameter	Tipo	Descripción
`flag`	flag	`OP_QUERY` bandera de protocolo de conexión. Para `mongosh`, puedes usar las banderas de cursor que se enumeran a continuación. Para obtener la lista específica del controlador, consulta tu documentación del controlador.

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

Importante

Este comando tiene compatibilidad limitada en los clústeres M0, M2, M5 y M10+. Para más información, consulta Comandos no admitidos.

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.

Flags

mongosh proporciona varias banderas de cursor adicionales para modificar el comportamiento del cursor.

Flag	Descripción
`DBQuery.Option.tailable`	Configura el cursor para que no se cierre una vez que se haya recibido el último dato, permitiendo que la query continúe devolviendo datos añadidos después de que los resultados iniciales se hayan agotado.
`DBQuery.Option.slaveOk`	Permite realizar consultas de una réplica esclava.
`DBQuery.Option.noTimeout`	Evita que el servidor agote el tiempo de espera de los cursores inactivos.
`DBQuery.Option.awaitData`	Para su uso con `DBQuery.Option.tailable`. Establece que el cursor bloquee el hilo de query cuando no haya datos disponibles y espere datos durante un tiempo determinado en lugar de devolver inmediatamente que no hay datos. El cursor no devuelve datos sólo cuando el tiempo de espera expira.
`DBQuery.Option.exhaust`	Configura el cursor para que retorne todos los datos proporcionados por la query de una vez en lugar de dividir los resultados en lotes.
`DBQuery.Option.partial`	Establece el cursor para devolver datos parciales de una consulta a un clúster particionado en el que algunas particiones no responden, en lugar de generar un error.

Ejemplo

El siguiente ejemplo agrega la bandera DBQuery.Option.tailable y la bandera DBQuery.Option.awaitData para garantizar que la query devuelva un cursor con seguimiento. La secuencia crea un cursor. Después de devolver el conjunto completo de resultados, espera el intervalo por defecto de 1000 milisegundos para poder capturar y devolver cualquier dato adicional añadido durante la query:

var t = db.myCappedCollection;
var cursor = t.find().addOption(DBQuery.Option.tailable).
                      addOption(DBQuery.Option.awaitData)

Advertencia

Agregar indicadores incorrectos de protocolo de conexión puede causar problemas y/o una carga adicional en el servidor.

Volver

Cursors

cursor.allowDiskUse