Get cursor ReadPreference.
Cursor query sort setting.
Is Cursor able to time out.
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial'].
The flag boolean value.
Event emitter The defined events on documents including:
The query modifier (must start with $, such as $orderby etc).
The flag boolean value.
The batchSize for the cursor.
Clone the cursor. still returns the same type.
Close the cursor, sending a KillCursor command and emitting close. The result callback.
Add a comment to the cursor query allowing for tracking the comment in the log.
The comment attached to this query.
Get the count of documents for this cursor.
Should the count command apply limit and skip settings on the cursor or in the passed in options.
The result callback.
Get the count of documents for this cursor.
Should the count command apply limit and skip settings on the cursor or in the passed in options.
Optional settings.
Get the count of documents for this cursor.
Should the count command apply limit and skip settings on the cursor or in the passed in options.
Optional settings.
The result callback.
Execute the explain for the cursor. returns Promise if no callback passed.
Execute the explain for the cursor.
The result callback.
Set the cursor query.
The filter object used for the cursor.
Iterates over all the documents for this cursor using the iterator, callback pattern.
The iteration callback.
The end callback.
Check if there is any document still available in the cursor.
Check if there is any document still available in the cursor.
The result callback.
Set the cursor hint.
If specified, then the query system will only consider plans using the hinted index.
Is the cursor closed.
Set the limit for the cursor.
The limit for the cursor query.
SMap all documents using the provided function.
The mapping transformation method.
Set the cursor max.
Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find(). The $max specifies the upper bound for all keys of a specific index in order.
Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise).
Number of milliseconds to wait before aborting the tailed query.
Set the cursor maxScan.
Constrains the query to only scan the specified number of documents when fulfilling the query.
Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher).
Number of milliseconds to wait before aborting the query.
Set the cursor min.
Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). The $min specifies the lower bound for all keys of a specific index in order.
Get the next available document from the cursor, returns null if no more documents are available.
Get the next available document from the cursor, returns null if no more documents are available.
The result callback.
Sets a field projection for the query.
The field projection object.
The read() method pulls some data out of the internal buffer and returns it. If there is no data available, then it will return null.
Optional argument to specify how much data to read.
Set the cursor returnKey.
Only return the index field or fields for the results of the query. If $returnKey is set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields. Use one of the following forms:
Resets the cursor.
Set a node.js specific cursor option.
The cursor option to set ['numberOfRetries', 'tailableRetryInterval'].
The field value.
Set the ReadPreference for the cursor.
The new read preference for the cursor.
Set the cursor showRecordId.
The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.
Set the skip for the cursor.
The skip for the cursor query.
Set the cursor snapshot.
The $snapshot operator prevents the cursor from returning a document more than once because an intervening write operation results in a move of the document.
Sets the sort order of the cursor query.
The key or keys set for the sort.
The direction of the sorting (1 or -1).
Return a modified Readable stream including a possible transform method.
Optional settings.
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contain partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contain partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
The result callback.
This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.
Chunk of data to unshift onto the read queue.
Generated using TypeDoc
Creates a new Cursor instance (INTERNAL TYPE, do not instantiate directly).
http://mongodb.github.io/node-mongodb-native/2.1/api/Cursor.html