Returns current buffered documents length
Returns current buffered documents
Get the next available document from the cursor, returns null if no more documents are available.
Try to get the next available document from the cursor or null if an empty batch is returned
Iterates over all the documents for this cursor using the iterator, callback pattern.
If the iterator returns false, iteration will stop.
The iteration callback.
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 contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
Add a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
Set the ReadPreference for the cursor.
The new read preference for the cursor.
Set the ReadPreference for the cursor.
Set the batch size for the cursor.
The number of documents to return per batch. See find command documentation.
Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.
Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.
Get the count of documents for this cursor
Execute the explain for the cursor
Set the cursor query
Set the cursor hint
If specified, then the query system will only consider plans using the hinted index.
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.
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 the cursor returnKey. If set to true, modifies the cursor to only return the index field or fields for the results of the query, rather than documents. If set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields.
the returnKey value.
Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.
The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.
Add a query modifier to the cursor query
The query modifier (must start with $, such as $orderby etc)
The modifier value.
Add a comment to the cursor query allowing for tracking the comment in the log.
The comment attached to this query.
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 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.
Add a project stage to the aggregation pipeline
Sets the sort order of the cursor query.
The key or keys set for the sort.
The direction of the sorting (1 or -1).
Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
Set the collation options for the cursor.
The cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
Set the limit for the cursor.
The limit for the cursor query.
Set the skip for the cursor.
The skip for the cursor query.
This symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Sets or gets the default captureRejection value for all emitters.
Generated using TypeDoc
since v4.0.0