MongoCursorMBS.BatchSize as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The cursor’s batch size.

(Read and Write property)

MongoCursorMBS.Current as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries current record as JSON.

Fetches the cursors current document or "" if there has been an error.
(Read only property)

MongoCursorMBS.Handle as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The internal object reference.

(Read only property)

MongoCursorMBS.Host as MongoHostListMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Fetches the MongoDB host that the cursor is communicating with in the host out parameter.

(Read only property)

MongoCursorMBS.ID as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.
(Read only property)

MongoCursorMBS.Limit as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Limits the number of documents in the result set.

This function is useful for setting the limit on a cursor after the cursor is created, but before any calls to NextRecord().

Calling this function after NextRecord() has no effect.
(Read and Write property)

MongoCursorMBS.MaxAwaitTimeMS as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

Only applies if the cursor is created from Find() with “tailable” and “awaitData” options, and the server is MongoDB 3.2 or later.

The max await time ms cannot be changed after the first call to NextRecord().

This is not applicable to all cursors. Setting batch size on a cursor returned by FindDatabases(), FindCollections(), or FindIndexes() will not change the results.
(Read and Write property)

MongoCursorMBS.More as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Whether there may be more data.

This function shall indicate if there is potentially more data to be read from the cursor.
This is only useful with tailable cursors. Use NextRecord() for regular cursors.

Details: mongoc_cursor_more is unreliable because it does not contact the server to see if there are actually more documents in the result set. It simply returns true if the cursor has not begun, or if it has begun and there are buffered documents in the client-side cursor, or if it has begun and the server has not yet told the cursor it is completely iterated.

This is unreliable with regular queries because it returns true for a new cursor before iteration, even if the cursor will match no documents. It is also true if the collection has been dropped on the server since the previous fetch, or if the cursor has finished its final batch and the next batch will be empty.

Returns true if the cursor has locally-buffered documents, or if a round-trip to the server might fetch additional documents.
(Read only property)

MongoCursorMBS.Parent as Variant

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	MongoDB	MBS MongoDB Plugin	22.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The parent object reference.

Points to the related database or collection and avoids you free those before this object gets destructed.
(Read only property)