cursor.addOption() (método mongosh)

Definición

cursor.addOption(flag)

Importante

Método mongosh

Esta página documenta a mongosh Método. Esta no es la documentación de un controlador específico del lenguaje, como Node.js.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

Nota

Obsoleto desde la v3.2

A partir de la v3.2, el operador cursor.addOption() está obsoleto en mongo. Utilice 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	Para `mongosh`, puedes usar las siguientes banderas del cursor. Para la lista específica del controlador, consulta la 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 soporte limitado en todos los clústeres de MongoDB Atlas. 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`	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 consultar una réplica secundaria.
`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 de protocolo de cable incorrectos puede causar problemas y/o carga adicional en el servidor.

Volver

db.colección.watch

cursor.allowDiskUse