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 インスタンスを作成してトランザクションを実装する場合は、 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() メソッドを呼び出して、トランザクションレベルのタイムアウトを設定することもできます。このオプションを設定すると、トランザクションの範囲内で実行されるすべての操作にタイムアウトが適用されます。

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() メソッドに制限されます。タイムアウトは、各呼び出しが完了した後に更新されます。これは、Cappedコレクションや変更ストリームで find() メソッドによって返される追尾可能 (tailable) カーソルなど、すべての追尾可能 (tailable) カーソルのデフォルトモードです。

次のコード例では、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());
    }
}