Definición
cursor.maxTimeMS(<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 los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.
Especifica un límite de tiempo acumulativo en milisegundos para las operaciones de procesamiento en un cursor.
El método
maxTimeMS()tiene la siguiente forma de prototipo:db.collection.find( { <query> }, { <projection> } ).maxTimeMS( <milliseconds> ) El método
maxTimeMS()tiene el siguiente parámetro:ParameterTipoDescripciónmillisecondsentero
Especifica un límite de tiempo acumulado en milisegundos para las operaciones de procesamiento en el cursor.
Importante
maxTimeMS() no está relacionado con el indicador de consulta NoCursorTimeout. maxTimeMS() se relaciona con el tiempo de procesamiento, mientras que NoCursorTimeout se relaciona con el tiempo de inactividad. El tiempo de inactividad de un cursor no contribuye a su tiempo de procesamiento.
El maxAwaitTimeMS() método establece un límite en cuanto a cuánto tiempo un cursor con seguimiento espera la siguiente respuesta. No establece un límite en el tiempo total de procesamiento.
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.
Nota
Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre la compatibilidad de Atlas con todos los comandos, 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.
Comportamientos
MongoDB apunta a operaciones para terminación si el cursor asociado excede su límite de tiempo asignado. MongoDB termina las operaciones que exceden su límite de tiempo asignado utilizando el mismo mecanismo que db.killOp(). MongoDB solo termina una operación en uno de sus puntos designados de interrupción.
MongoDB no cuenta la latencia de red entre el cliente y el servidor en el límite de tiempo de un cursor. En el caso de un clúster fragmentado, MongoDB sí incluye la latencia entre las instancias mongos y mongod dentro de este límite de tiempo.
Las consultas que generan múltiples lotes de resultados seguirán devolviendo lotes hasta que el cursor supere su tiempo asignado.
Modificaciones al tiempo de espera por inactividad maxTimeMS
Los controladores de MongoDB y mongosh asocian todas las operaciones con una sesión de servidor, con la excepción de las operaciones de escritura no confirmadas. Para las operaciones que no están explícitamente asociadas con una sesión (es decir, usando Mongo.startSession()), los controladores de MongoDB y mongosh crean una sesión implícita y la asocian con la operación.
Si una sesión permanece inactiva durante más de 30 minutos, el servidor MongoDB la marca como caducada y puede cerrarla en cualquier momento. Al cerrar la sesión, el servidor MongoDB también finaliza las operaciones en curso y los cursores abiertos asociados a ella. Esto incluye los cursores configurados con noCursorTimeout() o con un maxTimeMS() superior a 30 minutos.
Por ejemplo, consideremos una operación find() con maxTimeMS() configurado para un tiempo de espera de 31 minutos. El servidor devuelve un cursor junto con un lote de documentos definido por cursor.batchSize() defind(). La sesión se actualiza cada vez que la aplicación solicita un nuevo lote de documentos al servidor. Sin embargo, si la aplicación tarda más de 30 minutos en procesar el lote actual de documentos, la sesión se marca como caducada y se cierra. Cuando el servidor cierra la sesión, también elimina el cursor,a pesar de que este esté configurado con maxTimeMS() mayor que 30 minutos. Cuando la aplicación solicita el siguiente lote de documentos, el servidor devuelve un error.
Para las operaciones que devuelven un cursor, si el cursor puede estar inactivo durante más de 30 minutos, emite la operación dentro de una sesión explícita utilizando Mongo.startSession() y actualiza periódicamente la sesión utilizando el comando refreshSessions. Por ejemplo:
var session = db.getMongo().startSession() var sessionId = session sessionId // show the sessionId var cursor = session.getDatabase("examples").getCollection("data").find().noCursorTimeout() var refreshTimestamp = new Date() // take note of time at operation start while (cursor.hasNext()) { // Check if more than 5 minutes have passed since the last refresh if ( (new Date()-refreshTimestamp)/1000 > 300 ) { print("refreshing session") db.adminCommand({"refreshSessions" : [sessionId]}) refreshTimestamp = new Date() } // process cursor normally }
En la operación de ejemplo, el método db.collection.find() está asociado a una sesión explícita. El cursor está configurado con cursor.maxTimeMS() para permanecer abierto durante al menos 31 minutos. El bucle while incluye un bloque que utiliza refreshSessions para actualizar la sesión cada 5 minutos. Dado que la sesión nunca superará el tiempo de espera de inactividad de 30 minutos, el cursor puede permanecer abierto hasta el maxTimeMS() configurado.
Para los controladores de MongoDB, consulte la documentación del controlador para obtener instrucciones y sintaxis sobre cómo crear sesiones.
Tiempo de espera por defecto para todas las operaciones
A partir de MongoDB 8.0, puede usar el parámetro de clúster defaultMaxTimeMS para especificar un límite de tiempo predeterminado para que se completen las operaciones de lectura individuales. Si una consulta especifica una opción maxTimeMS(), ese valor anula el valor de defaultMaxTimeMS.
Ejemplos
Ejemplo
La siguiente query especifica un límite de tiempo de 50 milisegundos:
db.collection.find({description: /August [0-9]+, 1969/}).maxTimeMS(50)