cursor.noCursorTimeout()
This is a mongosh
method. This is not the documentation for Node.js
or other programming language specific driver methods.
In most cases, mongosh
methods work the same way as the legacy mongo
shell methods. However, some legacy methods are unavailable in mongosh
.
For the legacy mongo
shell documentation, refer to the documentation for the corresponding MongoDB Server release:
For MongoDB API drivers, refer to the language specific MongoDB driver documentation.
Instructs the server to avoid closing a cursor automatically after a period of inactivity.指示服务器避免在一段时间不活动后自动关闭游标。
The noCursorTimeout()
method has the following prototype form:noCursorTimeout()
方法具有以下原型形式:
db.collection.find(<query>).noCursorTimeout()
noCursorTimeout
noCursorTimeout
Starting in MongoDB 3.6, MongoDB drivers and 从MongoDB 3.6开始,MongoDB驱动程序和mongosh
associate all operations with a server session, with the exception of unacknowledged write operations. mongosh
将所有操作与服务器会话相关联,但未确认的写入操作除外。For operations not explicitly associated with a session (i.e. using 对于未显式与会话关联的操作(即使用Mongo.startSession()
), MongoDB drivers and mongosh
create an implicit session and associate it with the operation.Mongo.startSession()
),MongoDB驱动程序和mongosh
创建一个隐式会话并将其与操作关联。
If a session is idle for longer than 30 minutes, the MongoDB server marks that session as expired and may close it at any time. 如果会话空闲时间超过30分钟,MongoDB服务器会将该会话标记为已过期,并可随时将其关闭。When the MongoDB server closes the session, it also kills any in-progress operations and open cursors associated with the session. 当MongoDB服务器关闭会话时,它还会终止与会话相关联的任何正在进行的操作和打开的游标。This includes cursors configured with 这包括配置了noCursorTimeout()
or a maxTimeMS()
greater than 30 minutes.noCursorTimeout()
或大于30分钟的maxTimeMS()
的游标。
Consider an application that issues a 考虑一个发出带有db.collection.find()
with cursor.noCursorTimeout()
. cursor.noCursorTimeout()
的db.collection.find()
的应用程序。The server returns a cursor along with a batch of documents defined by the 服务器返回一个游标以及由cursor.batchSize()
of the find()
. find()
的cursor.batchSize()
定义的一批文档。The session refreshes each time the application requests a new batch of documents from the server. 每次应用程序从服务器请求新的一批文档时,会话都会刷新。However, if the application takes longer than 30 minutes to process the current batch of documents, the session is marked as expired and closed. 但是,如果应用程序处理当前一批文档的时间超过30分钟,则会话将标记为过期并关闭。When the server closes the session, it also kills the cursor despite the cursor being configured with 当服务器关闭会话时,它也会杀死游标,尽管游标配置了noCursorTimeout()
. noCursorTimeout()
。When the application requests the next batch of documents, the server returns an error.当应用程序请求下一批文档时,服务器返回错误。
For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session using 对于返回游标的操作,如果游标空闲时间可能超过30分钟,请使用Mongo.startSession()
and periodically refresh the session using the refreshSessions
command. Mongo.startSession()
在显式会话中发出操作,并使用refreshSessions
命令定期刷新会话。For example:例如:
var session = db.getMongo().startSession() var sessionId = session.getSessionId().id 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 }
In the example operation, the 在示例操作中,db.collection.find()
method is associated with an explicit session. db.collection.find()
方法与显式会话相关联。The cursor is configured with 游标配置为cursor.noCursorTimeout()
to prevent the server from closing the cursor if idle. cursor.noCursorTimeout()
,以防止服务器在游标空闲时关闭游标。The while
loop includes a block that uses refreshSessions
to refresh the session every 5 minutes. while
循环包含一个块,该块使用refreshSessions
每5分钟刷新一次会话。Since the session will never exceed the 30 minute idle timeout, the cursor can remain open indefinitely.由于会话永远不会超过30分钟的空闲超时,因此游标可以无限期地保持打开状态。
For MongoDB drivers, defer to the driver documentation for instructions and syntax for creating sessions.对于MongoDB驱动程序,有关创建会话的说明和语法,请参阅驱动程序文档。