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():

val settings = MongoClientSettings.builder
  .applyConnectionString(ConnectionString("<connection string>"))
  .timeout(200L, MILLISECONDS)
  .build
val mongoClient = MongoClient(settings)
val database = mongoClient.getDatabase("db")
val collection = database.getCollection("people")
collection.insertOne(Document("name" -> "Francine Loews"))

Herencia de tiempo de espera

Cuando se especifica la opción timeoutMS, el controlador aplica el tiempo de espera de acuerdo con los mismos comportamientos de herencia que las demás opciones del controlador de Scala. La siguiente tabla describe cómo se hereda el valor del tiempo de espera en cada nivel:

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

Transacciones

Cuando cree una nueva instancia de ScalaClientSession para implementar una transacción, utilice el método defaultTimeout() al construir una instancia de ClientSessionOptions. Puedes usar esta opción para especificar el tiempo de espera para los siguientes métodos:

• commitTransaction()

• abortTransaction()

• close()

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

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

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

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:

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

Para obtener más información sobre las transacciones, consulte Realizar una transacción guía.

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 especificas el tiempo de espera cuando construyes una instancia de ClientEncryption, el tiempo de espera controla la duración de todas las operaciones realizadas en esa instancia. Si no se proporciona un tiempo de espera al instanciar ClientEncryption, la instancia hereda la configuración de tiempo de espera de 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 por vida

El modo de ciclo de vida utiliza la configuración de tiempo de espera para limitar la vida útil total de un Observable. En este modo, tu aplicación debe inicializar el Observable, completar todas las llamadas a los métodos Observable y devolver todos los documentos dentro del plazo establecido. De lo contrario, la duración de Observable expira y el controlador genera un error de tiempo de espera.

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

val observableWithLifetimeTimeout = collection
  .find(gte("age", 40))
  .timeoutMode(TimeoutMode.CURSOR_LIFETIME)