cursor.maxTimeMS()（mongoshメソッド）

セッション アイドル タイムアウトの上書き maxTimeMS

MongoDBドライバーとmongosh は、確認されていない書込み操作を除くすべての操作をサーバーセッションに関連付けます。セッションに明示的に関連付けられていない操作（つまり を使用するもの）の場合、Mongo.startSession() MongoDBドライバーとmongosh は暗黙的なセッションを作成し、それが操作に関連付けられます。

セッションが30 分以上アイドル状態になると、 MongoDBサーバーはそのセッションを期限切れとしてマークし、いつでも閉じる可能性があります。 MongoDBサーバーがセッションを閉じると、セッションに関連付けられている進行中の操作と開いているカーソルもすべて強制終了されます。これには、noCursorTimeout() maxTimeMS()または30 分を超える で構成されたカーソルが含まれます。

例、 がfind() maxTimeMS()分のタイムアウトに設定されている31 操作を考えてみましょう。サーバーは、cursor.batchSize() のfind() によって定義されたドキュメントのバッチするとともにカーソルを返します。セッションは、アプリケーションがサーバーに新しいドキュメントのバッチするをリクエストするたびに更新されます。ただし、アプリケーションが現在のドキュメントのバッチする処理に30 分以上かかる場合は、セッションは期限切れとしてマークされ、閉じます。サーバーがセッションを閉じると、カーソルは maxTimeMS()分より長く30 に設定されているにもかかわらず、カーソルも強制終了されます。アプリケーションが次のドキュメントのバッチするをリクエストすると、サーバーはエラーを返します。

カーソルを返す操作の場合、カーソルが 30 分以上アイドル状態になる可能性がある場合は、 Mongo.startSession()を使用して明示的なセッション内で操作を発行し、 refreshSessionsコマンドを使用して定期的にセッションを更新します。以下がその例です。

var session = db.getMongo().startSession()
var sessionId = session
sessionId  // show the sessionId
var cursor = session.getDatabase("examples").getCollection("data").find().noCursorTimeout()
var refreshTimestamp = new Date() // take note of time at operation start
while (cursor.hasNext()) {
  // Check if more than 5 minutes have passed since the last refresh
  if ( (new Date()-refreshTimestamp)/1000 > 300 ) {
    print("refreshing session")
    db.adminCommand({"refreshSessions" : [sessionId]})
    refreshTimestamp = new Date()
  }
  // process cursor normally
}

例操作では、db.collection.find() メソッドは明示的なセッションに関連付けられています。カーソルは、カーソルを少なくともcursor.maxTimeMS() 分間開いたままになるように31 で設定されています。while ループには、refreshSessions を使用して5 分ごとにセッションを更新するブロックが含まれています。セッションが30 分のアイドル タイムアウトを超えることはないため、カーソルは設定されたmaxTimeMS() まで開いたままにできます。

MongoDB ドライバーの場合、セッションを作成するための手順と構文については、ドライバーのドキュメントを参照してください。

すべての操作のデフォルトタイムアウト

MongoDB8.0 以降では、defaultMaxTimeMS クラスター パラメータを使用して、個々の読み取り操作が完了するデフォルトの時間制限を指定できます。クエリでmaxTimeMS() オプションが指定されている場合、その値はdefaultMaxTimeMS 値を上書きします。