Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

MongoDB.CursorID

Retrieves the cursor id used by the server to track the cursor.

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

Parameters

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

Result

Returns OK or error.

Description

Retrieves the cursor id used by the server to track the cursor.
This number is zero until the driver actually uses a server when executing the query, and after it has fetched all results from the server.

Examples

Shows ID of current cursor:

Show Custom Dialog [ "Current cursor ID:" ; MBS( "MongoDB.CursorID"; $mongo ) ]

See also

This function checks for a license.

Created 22nd May 2022, last changed 20th June 2022


MongoDB.CursorGetMaxAwaitTimeMS - MongoDB.CursorLimit