cursor.addOption()

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 5.0, consulte 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 controlador específicos del lenguaje de programación.

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

Para obtener la documentación del shell heredado, consulte la documentación de la versión correspondiente de MongoDB mongo 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 v3.2

A partir de la versión3.2, el operadorcursor.addOption()está obsoleto enmongosh. Enmongosh, utilice los métodos de cursor disponibles.

Se utiliza para cambiar el comportamiento de la consulta configurando los indicadores que se enumeran a continuación.

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

Parameter	Tipo	Descripción
`flag`	flag	`OP_QUERY` Indicador de protocolo de cable. Para, puede usar los indicadores de cursor que se indican a continuación. Para ver la lista específica del controlador, consulte `mongosh` la documentación del mismo.

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 con clústeres M,0 M,2 M5 y M10+. Para obtener más información, 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.

Flags

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

Flag	Descripción
`DBQuery.Option.tailable`	Establece que el cursor no se cierre una vez que se reciben los últimos datos, lo que permite que la consulta continúe devolviendo datos agregados después de que se agotaron los resultados iniciales.
`DBQuery.Option.slaveOk`	Permite consultar un esclavo de réplica.
`DBQuery.Option.noTimeout`	Evita que el servidor agote el tiempo de espera de los cursores inactivos.
`DBQuery.Option.awaitData`	Para usar con. Establece que el cursor bloquee el hilo de consulta cuando no haya datos disponibles y espere los datos durante un tiempo determinado en lugar de devolver la información sin devolver datos inmediatamente. El cursor no devuelve datos solo si se agota el tiempo de `DBQuery.Option.tailable` espera.
`DBQuery.Option.exhaust`	Establece el cursor para que devuelva todos los datos devueltos por la consulta de una vez en lugar de dividir los resultados en lotes.
`DBQuery.Option.partial`	Establece el cursor para devolver datos parciales de una consulta contra un clúster fragmentado en el que algunos fragmentos no responden en lugar de generar un error.

Ejemplo

El siguiente ejemplo agrega DBQuery.Option.tailable los DBQuery.Option.awaitData indicadores y para garantizar que la consulta devuelva un cursor adaptable. La secuencia crea un cursor. Tras devolver el conjunto de resultados completo, espera el intervalo predeterminado de 1000 milisegundos para capturar y devolver los datos adicionales añadidos durante la consulta:

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

Advertencia

Agregar indicadores de protocolo de cable incorrectos puede causar problemas y/o carga adicional en el servidor.

Volver

Cursors

cursor.allowDiskUse