Cursor class

Implementers

Constructors

Cursor(Db db, DbCollection? collection, dynamic selectorBuilderOrMap)

Properties

awaitData bool
If we are at the end of the data, block for a while rather than returning no data. After a timeout period, we do return as normal, only applicable for tailable cursor.
getter/setter pair
collection DbCollection?
getter/setter pair
cursorId int
getter/setter pair
db Db
getter/setter pair
eachCallback MonadicBlock?
getter/setter pair
exhaust bool
Stream the data down full blast in multiple “more” packages, on the assumption that the client will fully read all data queried. Faster when you are pulling a lot of data and know you want to pull it all down. Note: the client is not allowed to not read all the data unless it closes the connection.
getter/setter pair
explain bool
getter/setter pair
fields Map<String, dynamic>?
getter/setter pair
flags int
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
hint Map<String, dynamic>?
getter/setter pair
items Queue<Map<String, dynamic>>
getter/setter pair
limit int
getter/setter pair
partial bool
Get partial results from a mongos if some shards are down (instead of throwing an error)
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selector Map<String, dynamic>
getter/setter pair
skip int
getter/setter pair
slaveOk bool
Allow query of replica slave. Normally these return an error except for namespace “local”.
getter/setter pair
sort Map<String, dynamic>?
getter/setter pair
state State
getter/setter pair
stream Stream<Map<String, dynamic>>
no setter
tailable bool
Tailable means cursor is not closed when the last data is retrieved
getter/setter pair
tailableRetryInterval int
Specify the miliseconds between getMore on tailable cursor, only applicable when awaitData isn't set. Default value is 100 ms
getter/setter pair
timeout bool
The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Unset this option to prevent that.
getter/setter pair

Methods

close() Future<Map<String, dynamic>?>
generateGetMoreMessage() MongoGetMoreMessage
generateQueryMessage() MongoQueryMessage
getCursorData(MongoReplyMessage replyMessage) → void
nextObject() Future<Map<String, dynamic>?>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited