Limite el tiempo de ejecución del servidor

Valores de tiempo de espera aceptados

La siguiente tabla describe el comportamiento de espera correspondiente a los valores aceptados para timeoutMS:

Si se especifica la opción timeoutMS, el driver aplica automáticamente el timeout especificado a cada operación del servidor. El siguiente ejemplo de código especifica un tiempo de espera de 200 milisegundos a nivel de cliente y luego llama al método MongoCollection.insertOne():

MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(new ConnectionString("<connection string>"))
        .timeout(200L, MILLISECONDS)
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    MongoDatabase database = mongoClient.getDatabase("db");
    MongoCollection<Document> collection = database.getCollection("people");
    collection.insertOne(new Document("name", "Francine Loews"));
}

Herencia de tiempo de espera

Al especificar la opción timeoutMS, el controlador aplica el tiempo de espera según los mismos comportamientos de herencia que las demás opciones del controlador Java. La siguiente tabla describe cómo se hereda el valor del tiempo de espera en cada nivel:

Para obtener más información sobre anulaciones y opciones específicas, consulte la siguiente sección Anulaciones.

Transacciones

Al crear una nueva instancia de ClientSession para implementar una transacción, utilice el defaultTimeout() método al crear una ClientSessionOptions instancia. Puede usar esta opción para especificar el tiempo de espera de los siguientes métodos:

• confirmarTransacción()

• abortTransaction()

• withTransaction()

• close()

El siguiente código muestra cómo configurar el defaultTimeout al crear una instancia de un ClientSession:

ClientSessionOptions opts = ClientSessionOptions.builder()
        .defaultTimeout(200L, MILLISECONDS)
        .build();
ClientSession session = mongoClient.startSession(opts);
// ... perform operations on ClientSession

Si no especifica defaultTimeout, el controlador utiliza el valor de tiempo de espera establecido en el elemento principal MongoClient.

También puedes establecer un tiempo de espera a nivel de transacción llamando al método timeout() al crear una instancia de TransactionOptions. La configuración de esta opción aplica un tiempo de espera a todas las operaciones realizadas en el ámbito de la transacción:

TransactionOptions transactionOptions = TransactionOptions.builder()
        .timeout(200L, MILLISECONDS)
        .build();

Para obtener más información sobre las transacciones, consulte la Transactions guide.

Cifrado del cliente

Cuando usas la Encriptación de Campo a Nivel de Cliente (CSFLE), el driver utiliza la opción timeoutMS para limitar el tiempo permitido para las operaciones de encriptación y desencriptación. Puedes configurar una opción de tiempo de espera para tu instancia de ClientEncryption llamando al método timeout() al crear una instancia de ClientEncryptionSettings.

Si especifica el tiempo de espera al construir una instancia ClientEncryption, este controla la duración de todas las operaciones realizadas en esa instancia. Si no proporciona un tiempo de espera al instanciar ClientEncryption, la instancia hereda el valor de tiempo de espera del MongoClient utilizado en el constructor ClientEncryption.

Si se establece timeoutMS tanto en el cliente como directamente en ClientEncryption, se le da prioridad al valor que se proporciona a ClientEncryption.

Modo de tiempo de vida del cursor

El modo de tiempo de vida del cursor utiliza la configuración de tiempo de espera para limitar toda la vida útil de un cursor. En este modo, tu aplicación debe inicializar el cursor, completar todas las llamadas a los métodos del cursor y devolver todos los documentos dentro del límite de tiempo especificado. De lo contrario, el tiempo de vida del cursor expira y el driver genera un error de tiempo de espera.

Cuando cierras un cursor llamando al método close(), el tiempo de espera se restablece para el comando killCursors para asegurar que los recursos del servidor se limpien.

El siguiente ejemplo muestra cómo configurar un tiempo de espera del cursor para asegurar que el cursor esté inicializado y que todos los documentos se recuperen dentro del tiempo de espera heredado:

FindIterable<Document> cursorWithLifetimeTimeout = collection
        .find(gte("age", 40))
        .timeoutMode(TimeoutMode.CURSOR_LIFETIME);

Modo de iteración de cursor

El modo de iteración del cursor establece el tiempo de espera para limitar cada llamada a los métodos next(), hasNext() y tryNext(). El tiempo de espera se actualiza tras cada llamada. Este es el modo predeterminado para todos los cursores adaptables, como los cursores adaptables devueltos por el método find() en colecciones limitadas o flujos de cambios.

El siguiente ejemplo de código itera sobre documentos en la colección db.people usando un cursor con el modo de tiempo de espera ITERATION, y luego recupera e imprime el valor del campo name para cada documento:

try (MongoCursor<Document> cursorWithIterationTimeout = collection
        .find(gte("age", 40))
        .timeoutMode(TimeoutMode.ITERATION)
        .cursor()
) {
    while (cursorWithIterationTimeout.hasNext()) {
        System.out.println(cursorWithIterationTimeout.next().toJson());
    }
}