cursor.tailable() (método mongosh)

Definición

cursor.tailable()

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.

Marca el cursor como Manteniéndolo abierto incluso cuando el cliente agote todos los resultados.

Solo para usar en colecciones con límite. Usar tailable() en colecciones sin límite devuelve un error.

cursor.tailable() utiliza la siguiente sintaxis:

cursor.tailable( { awaitData : <boolean> } )

~cursor.tailable() tiene el siguiente parámetro:

Parameter	Tipo	Descripción
awaitData	booleano	Opcional. 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 incorrecta inmediatamente. El cursor solo devolverá la información incorrecta si se agota el tiempo de DBQuery.Option.tailable espera. De forma predeterminada, si se establece maxTimeMS en el comando que creó el cursor, el tiempo de espera para awaitData es el tiempo restante. De lo contrario, el tiempo de espera predeterminado es de 1000 milisegundos. Puede establecer un tiempo de espera al ejecutar en un cursor getMore con awaitData habilitado. Se establece por defecto en false.

Devuelve:	El cursor ~cursor.tailable() al que está adjunto.

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

• 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

Un cursor adaptable realiza un escaneo de colección sobre una colección limitada. Permanece abierto incluso después de alcanzar el final de la colección. Las aplicaciones pueden continuar iterando el cursor adaptable a medida que se insertan nuevos datos en la colección.

Si awaitData truees, cuando el cursor llega al final de la colección limitada, mongod bloquea el hilo de consulta durante el tiempo de espera y espera la llegada de nuevos datos. Cuando se insertan nuevos datos en la colección limitada, mongod indica al hilo bloqueado que se active y devuelva el siguiente lote al cliente.

Ver Cursores adaptables.