限制MongoDB Server执行时间

接受的超时值

下表描述了与 timeoutMS 的可接受值相对应的超时行为：

如果指定 timeoutMS 选项，驾驶员会自动将指定的超时应用于每个服务器操作。以下代码示例在客户端端级别指定 200 毫秒的超时，然后调用 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"));
}

超时继承

当您指定 timeoutMS 选项时，驾驶员将根据与其他Java驾驶员选项相同的继承行为应用超时。下表描述了如何在每个级别继承超时值：

有关覆盖和特定选项的更多信息，请参阅以下覆盖部分。

事务

当您创建新的ClientSession实例来实现ACID 事务时，请在构建 ClientSessionOptions实例时使用 defaultTimeout() 方法。您可以使用此选项指定以下方法的超时时间：

• commitTransaction()

• abortTransaction()

• withTransaction()

• close()

以下代码演示了如何在实例化 ClientSession 时设立defaultTimeout：

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

如果未指定 defaultTimeout，驾驶员将使用在父项 MongoClient 上设立的超时值。

您还可以在构建 TransactionOptions实例时调用 timeout() 方法来设立事务级超时。设置此选项会将超时应用于在ACID 事务范围内执行的所有操作：

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

要学习；了解有关事务的更多信息，请参阅 事务指南。

客户端加密

使用客户端字段级加密(CSFLE) 时，驾驶员使用 timeoutMS 选项来限制加密和解密操作所允许的时间。您可以在构建 ClientEncryptionSettings实例时调用 timeout() 方法，为 ClientEncryption实例设立超时选项。

如果在构造 ClientEncryption实例时指定了超时，则该超时将控制对该实例执行的所有操作的生命周期。如果在实例化 ClientEncryption 时未提供超时，则该实例将从 ClientEncryption 构造函数中使用的 MongoClient 继承超时设置。

如果您在客户端和直接在 ClientEncryption 中同时设立timeoutMS，则提供给 ClientEncryption 的值优先。

游标生命周期模式

游标生命周期模式使用超时设置来限制游标的整个生命周期。在此模式下，应用程序必须初始化游标，完成对游标方法的所有调用，并在指定的时限内返回所有文档。否则，游标的生命周期将到期，并且驾驶员会引发超时错误。

通过调用 close() 方法关闭游标时，killCursors 命令的超时时间将重置，以确保清理服务器端资源。

以下示例展示了如何设立游标超时，以确保在继承的超时时间内初始化游标并检索所有文档：

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

游标迭代模式

游标迭代模式会设置超时，以限制对 next()、hasNext() 和 tryNext() 方法的每次调用。每次调用完成后，超时时间都会刷新。这是所有可追加游标的默认模式，例如 find() 方法在固定大小集合或变更流上返回的可追加游标。

以下代码示例使用具有 ITERATION 超时模式的游标遍历 db.people集合中的文档，然后检索并打印每个文档的 name字段值：

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