cursor.maxAwaitTimeMS() (método mongosh)

Definición

cursor.maxAwaitTimeMS(<time limit>)

Importante

Método mongosh

Esta página documenta un método mongosh. No se trata de la documentación de un controlador específico de un lenguaje, como Node.js.

Para obtener información sobre los controladores de la API de MongoDB, consulte la documentación del controlador de MongoDB específica del lenguaje.

Especifica el tiempo máximo que el servidor debe esperar nuevos documentos que coincidan con una query de cursor con seguimiento en una colección con tamaño fijo. Para obtener más información sobre cómo iterar un cursor devuelto por una query, consulta: Itera un cursor en mongosh.

El método maxAwaitTimeMS() tiene la siguiente forma de prototipo:

db.collection.find(
   { <query> },
   { <projection> }
).tailable( { awaitData: true } ).maxAwaitTimeMS( <milliseconds> )

El método maxAwaitTimeMS() tiene el siguiente parámetro:

Parameter	Tipo	Descripción
milliseconds	entero	Especifica un tiempo máximo de espera para los nuevos documentos.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente administrado 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.

Ejemplo

Query la limitada sales colección para encontrar los totales semanales de ventas del agente Mary Kay:

db.sales.find(
   { agent: "Mary Kay" },
   { _id: 0, agent: 1, weeklyTotal: 1  }
).tailable( { awaitData: true } ).maxAwaitTimeMS( 1000 )

La línea resaltada crea un cursor rastreable en la colección sales. La línea maxAwaitTimeMS() establece un tiempo máximo de espera de un segundo para la siguiente actualización del cursor.