Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.1   12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4    Statistic    FMM    Blog  

MongoDB.ChangeStreamResumeToken

Queries resume token.

Component Version macOS Windows Linux Server iOS SDK
MongoDB 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "MongoDB.ChangeStreamResumeToken"; MongoDBRef )   More

Parameters

Parameter Description Example
MongoDBRef The reference number for the mongo connection. $MongoDB

Result

Returns text or error.

Description

Queries resume token.
Returns the cached resume token, which may be passed as either the resumeAfter or startAfter option of a watch function to start a new change stream from the same point.

Returns "" if no resume token is available. This is possible if the change stream has not been iterated and neither resumeAfter nor startAfter options were specified in the watch function.

Release notes

Blog Entries

This function checks for a license.

Created 18th November 2022, last changed 18th November 2022


MongoDB.ChangeStreamErrorDocument - MongoDB.CloseChangeStream

💬 Ask a question or report a problem