Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
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
- Version 13.1
- Fixed a bug in MongoDB.ChangeStreamErrorDocument, MongoDB.ChangeStreamResumeToken and MongoDB.NextChange functions.
- Version 13.0
- Added functions to watch changes in MongoDB: MongoDB.ChangeStreamErrorDocument, MongoDB.ChangeStreamResumeToken, MongoDB.CloseChangeStream, MongoDB.NextChange, MongoDB.WatchClient, MongoDB.WatchCollection and MongoDB.WatchDatabase.
Blog Entries
This function checks for a license.
Created 18th November 2022, last changed 18th November 2022
