Limitar o tempo de execução do servidor MongoDB

Valores de tempo limite aceitos

A tabela seguinte descreve o comportamento de tempo limite correspondente aos valores aceitos para timeoutMS:

Se você especificar a opção timeoutMS, o driver aplicará automaticamente o tempo limite especificado para cada operação do servidor . O exemplo de código a seguir especifica um tempo limite de 200 milissegundos no nível do cliente e, em seguida, chama o 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"))

Herança de tempo limite

Quando você especifica a opção timeoutMS, o driver aplica o tempo limite de acordo com os mesmos comportamentos de herança que as outras opções de driver Scala. A tabela a seguir descreve como o valor do tempo limite é herdado em cada nível:

Para obter mais informações sobre substituições e opções específicas, consulte a seguinte seção Substituições.

Transações

Ao criar uma nova instância ScalaClientSession para implementar uma transação, utilize o método defaultTimeout() ao construir uma instância do ClientSessionOptions. Você pode utilizar esta opção para especificar o tempo limite para os seguintes métodos:

• commitTransaction()

• abortTransaction()

• close()

O seguinte código demonstra como definir o defaultTimeout ao instanciar um ClientSession:

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

Se você não especificar o defaultTimeout, o driver utilizará o valor de tempo limite definido no MongoClient pai.

Você também pode definir um tempo limite no nível da transação ligando para o método timeout() ao criar uma instância TransactionOptions. A definição desta opção aplica um tempo limite a todas as operações realizadas no escopo da transação:

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

Para saber mais sobre transações, consulte o guia Realizar uma transação.

Criptografia do cliente

Quando você usa a criptografia no nível do campo do lado do cliente (CSFLE), o driver usa a opção timeoutMS para limitar o tempo permitido para operações de criptografia e descriptografia. Você pode definir uma opção de tempo limite para sua instância ClientEncryption chamando o método timeout() ao criar uma instância ClientEncryptionSettings.

Se você especificar o timeout ao construir uma instância do ClientEncryption, o timeout controlará a vida útil de todas as operações executadas nessa instância. Se você não fornecer um timeout ao instanciar ClientEncryption, a instância herdará a configuração de timeout do MongoClient usado no construtor ClientEncryption.

Se você definir timeoutMS no cliente e diretamente em ClientEncryption, o valor fornecido para ClientEncryption terá precedência.

Modo de vida

O modo de vida útil usa a configuração de tempo limite para limitar a vida útil inteira de um Observable. Neste modo, seu aplicação deve inicializar o Observable, concluir todas as chamadas para os métodos Observable e retornar todos os documentos dentro do limite de tempo especificado. Caso contrário, a vida útil do Observable expira e o driver gera um erro de tempo limite.

O exemplo a seguir mostra como definir um tempo limite de Observable para garantir que o cursor seja inicializado e todos os documentos sejam recuperados dentro do tempo limite herdado:

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