Cursor

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var _read: Function0[Any]

Definition Classes
Readable
def addCursorFlag(flag: CursorFlag, value: Boolean): Cursor.this.type

Add a cursor flag to the cursor
Add a cursor flag to the cursor
flag
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial'].
value
The flag boolean value.
def addListener(eventName: String, listener: Function): Cursor.this.type

Definition Classes
IEventEmitter
def addQueryModifier(name: String, value: Boolean): Cursor.this.type

Add a query modifier to the cursor query
Add a query modifier to the cursor query
name
The query modifier (must start with $, such as $orderby etc)
value
The flag boolean value.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def batchSize(size: Int, callback: MongoCallback[Cursor.this.type]): Unit

Sets the batch size parameter of this cursor to the given value.
Sets the batch size parameter of this cursor to the given value.
size
the new batch size.
callback
this optional callback will be called after executing this method. The first parameter will contain an error object when the batchSize given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. batchSize(size[, callback])
def batchSize(size: Int): Promise[Cursor.this.type]

Sets the batch size parameter of this cursor to the given value.
Sets the batch size parameter of this cursor to the given value.
size
the new batch size.
returns
a promise of the Cursor
Example:
1. batchSize(size[, callback])
def clone(): Cursor.this.type

Clone the cursor
Clone the cursor

Definition Classes
Cursor → AnyRef
def close(callback: MongoCallback[Cursor.this.type]): Unit

Close the cursor, sending a KillCursor command and emitting close.
Close the cursor, sending a KillCursor command and emitting close.
callback
this will be called after executing this method. The first parameter will always contain null while the second parameter will contain a reference to this cursor.
def close(): Promise[Cursor.this.type]

Close the cursor, sending a KillCursor command and emitting close.
Close the cursor, sending a KillCursor command and emitting close.
returns
a promise of the Cursor
def close(callback: Function): Unit

Definition Classes
Readable
def collation(value: Any): Cursor.this.type

Set the collation options for the cursor.
Set the collation options for the cursor.
value
the cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
returns
the Cursor
def comment(value: String): Cursor.this.type

Add a comment to the cursor query allowing for tracking the comment in the log.
Add a comment to the cursor query allowing for tracking the comment in the log.
value
The comment attached to this query.
returns
the Cursor
def count(applySkipLimit: Boolean, callback: MongoCallback[Int]): Unit

Determines how many result the query for this cursor will return
Determines how many result the query for this cursor will return
applySkipLimit
if set to true will apply the skip and limits set on the cursor. Defaults to false.
callback
this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the number of results or null if an error occurred.
Example:
1. count(applySkipLimit, [options], callback)
def count(applySkipLimit: Boolean, options: |[CountOptions, RawOptions], callback: MongoCallback[Int]): Unit

Determines how many result the query for this cursor will return
Determines how many result the query for this cursor will return
applySkipLimit
if set to true will apply the skip and limits set on the cursor. Defaults to false.
options
the optional settings.
callback
this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the number of results or null if an error occurred.
Example:
1. count(applySkipLimit, [options], callback)
def count(applySkipLimit: Boolean = js.native, options: |[CountOptions, RawOptions] = js.native): Promise[Int]

Determines how many result the query for this cursor will return
Determines how many result the query for this cursor will return
applySkipLimit
if set to true will apply the skip and limits set on the cursor. Defaults to false.
options
the optional settings.
returns
a promise of the count
Example:
1. count(applySkipLimit, [options])
var domain: String

Definition Classes
IEventEmitter
def emit(name: String, args: Any*): Any

Definition Classes
IEventEmitter
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def explain(callback: Function): Unit

Gets a detailed information about how the query is performed on this cursor and how long it took the database to process it.
Gets a detailed information about how the query is performed on this cursor and how long it took the database to process it.
callback
this will be called after executing this method. The first parameter will always be null while the second parameter will be an object containing the details.
Example:
1. explain(callback)
def filter(filter: Any): Cursor.this.type

Set the cursor query
Set the cursor query
filter
The filter object used for the cursor.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forEach(iterator: Function1[T, Any], callback: MongoCallback[T]): Unit

Iterates over all the documents for this cursor using the iterator, callback pattern.
Iterates over all the documents for this cursor using the iterator, callback pattern.
iterator
The iteration callback.
callback
The end callback.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getMaxListeners(): Int

Definition Classes
IEventEmitter
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
def hint(hint: String = js.native): Cursor.this.type

Set the cursor hint
Set the cursor hint
hint
If specified, then the query system will only consider plans using the hinted index.
def isClosed(): Boolean

Check if the cursor is closed or open.
Check if the cursor is closed or open.
returns
the state of the cursor.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPaused(): Boolean

Definition Classes
Readable
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
def limit(limit: Int, callback: Function = js.native): Cursor.this.type

Sets the limit parameter of this cursor to the given value.
Sets the limit parameter of this cursor to the given value.
limit
the new limit.
callback
this optional callback will be called after executing this method. The first parameter will contain an error object when the limit given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. limit(limit[, callback])
def listenerCount(eventName: String): Int

Definition Classes
IEventEmitter
def listeners(eventName: String): Array[Function]

Definition Classes
IEventEmitter
def map(transform: Function): Unit

Map all documents using the provided function
Map all documents using the provided function
transform
The mapping transformation method.
def max(max: Int): Cursor.this.type

Set the cursor max
Set the cursor max
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.
def maxAwaitTimeMS(value: Int): Cursor.this.type

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)
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)
value
Number of milliseconds to wait before aborting the tailed query.
def maxScan(maxScan: Int): Cursor.this.type

Set the cursor maxScan
Set the cursor maxScan
maxScan
Constrains the query to only scan the specified number of documents when fulfilling the query
def maxTimeMS(maxTimeMS: Int, callback: Function = js.native): Cursor.this.type

Specifies a time limit for a query operation.
Specifies a time limit for a query operation. After the specified time is exceeded, the operation will be aborted and an error will be returned to the client. If maxTimeMS is null, no limit is applied.
maxTimeMS
the maxTimeMS for the query.
callback
this optional callback will be called after executing this method. The first parameter will contain an error object when the limit given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. maxTimeMS(maxTimeMS[, callback])
def min(min: Int): Cursor.this.type

Set the cursor min
Set the cursor min
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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def next(): Promise[T]

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.
returns
promise if no callback passed
def next(callback: Function): Unit

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.
callback
The result callback.
returns
promise if no callback passed
def nextObject(callback: MongoCallback[T]): Unit

Gets the next document from the cursor.
Gets the next document from the cursor.
callback
The result callback.
returns
promise if no callback passed
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def on(eventName: String, listener: Function): Cursor.this.type

Definition Classes
IEventEmitter
def once(eventName: String, listener: Function): Cursor.this.type

Definition Classes
IEventEmitter
def pause(): Cursor.this.type

Definition Classes
Readable
def pipe(destination: Writable, options: RawOptions): Cursor.this.type

Definition Classes
Readable
def project(value: Any): Cursor.this.type

Sets a field projection for the query.
Sets a field projection for the query.
value
The field projection object.
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def push(value: Any): Cursor.this.type

Definition Classes
Readable
def read[T](size: Int): T

Definition Classes
Readable
def removeAllListeners(): Cursor.this.type

Definition Classes
IEventEmitter
def removeAllListeners(eventName: String): Cursor.this.type

Definition Classes
IEventEmitter
def removeListener(eventName: String, listener: Function): Cursor.this.type

Definition Classes
IEventEmitter
def resume(): Cursor.this.type

Definition Classes
Readable
def returnKey(returnKey: Int): Cursor.this.type

Set the cursor returnKey
Set the cursor returnKey
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.
def rewind(): Cursor.this.type

Resets this cursor to its initial state.
Resets this cursor to its initial state. All settings like the query string, tailable, batchSizeValue, skipValue and limits are preserved.
def setEncoding(encoding: String): Cursor.this.type

Definition Classes
Readable
def setMaxListeners(n: Int): Cursor.this.type

Definition Classes
IEventEmitter
def setReadPreference(pref: String, callback: Function = js.native): Cursor.this.type

Sets the read preference for the cursor
Sets the read preference for the cursor
pref
read preference for the cursor, one of Server.READ_PRIMARY, Server.READ_SECONDARY, Server.READ_SECONDARY_ONLY
callback
this optional callback will be called after executing this method. The first parameter will contain an error object when the read preference given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. setReadPreference(pref[, callback])
def showRecordId(enable: Boolean): Cursor.this.type

Set the cursor showRecordId
Set the cursor showRecordId
enable
The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.
def skip(skip: Int, callback: Function = js.native): Cursor.this.type

Sets the skip parameter of this cursor to the given value.
Sets the skip parameter of this cursor to the given value.
skip
the new skip value.
callback
this optional callback will be called after executing this method. The first parameter will contain an error object when the skip value given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. skip(skip[, callback])
def snapshot(enable: Boolean): Cursor.this.type

TODO document me
def sort(keyOrList: |[String, Array[Any]], direction: |[Int, String]): Cursor.this.type

Sets the sort parameter of this cursor to the given value.
Sets the sort parameter of this cursor to the given value.
keyOrList
this can be a string or an array. If passed as a string, the string will be the field to sort. If passed an array, each element will represent a field to be sorted and should be an array that contains the format [string, direction].
direction
this determines how the results are sorted. "asc", "ascending" or 1 for ascending order while "desc", "descending or -1 for descending order. Note that the strings are case insensitive.
Example:
1. sort(keyOrList, direction, callback)
def sort(keyOrList: Array[Any], callback: Function = js.native): Cursor.this.type

Sets the sort parameter of this cursor to the given value.
Sets the sort parameter of this cursor to the given value.
keyOrList
this can be a string or an array. If passed as a string, the string will be the field to sort. If passed an array, each element will represent a field to be sorted and should be an array that contains the format [string, direction].
callback
this will be called after executing this method. The first parameter will contain an error object when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. sort(keyOrList, direction, callback)
def sort(keyOrList: String, direction: |[Int, String], callback: Function): Cursor.this.type

Sets the sort parameter of this cursor to the given value.
Sets the sort parameter of this cursor to the given value.
keyOrList
this can be a string or an array. If passed as a string, the string will be the field to sort. If passed an array, each element will represent a field to be sorted and should be an array that contains the format [string, direction].
direction
this determines how the results are sorted. "asc", "ascending" or 1 for ascending order while "desc", "descending or -1 for descending order. Note that the strings are case insensitive.
callback
this will be called after executing this method. The first parameter will contain an error object when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
Example:
1. sort(keyOrList, direction, callback)
def stream(transform: StreamTransform): Cursor.this.type

Returns a Node Transform Stream interface for this cursor.
Returns a Node Transform Stream interface for this cursor.
returns
returns a stream object.
def stream(): CursorStream

Returns a Node Transform Stream interface for this cursor.
Returns a Node Transform Stream interface for this cursor.
```
var stream = collection.find({mykey:{$ne:2}}).stream();
stream.on("data", function(item) {});
stream.on("end", function() {});
```
returns
returns a stream object.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toArray(callback: MongoCallback[Array[T]]): Unit

Returns an array of documents.
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 previouly accessed. In that case, cursor.rewind() can be used to reset the cursor.
callback
This will be called after executing this method successfully. The first parameter will contain the Error object if an error occurred, or null otherwise. The second parameter will contain an array of BSON deserialized objects as a result of the query.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def unpipe(destination: Writable): Unit

Definition Classes
Readable
def unshift(chunk: Any): Unit

Definition Classes
Readable
var usingDomains: Boolean

Definition Classes
IEventEmitter
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def wrap(stream: Any): Unit

Definition Classes
Readable

Deprecated Value Members

def each(callback: MongoCallback[T]): Unit

Iterates over all the documents for this cursor.
Iterates over all the documents for this cursor. As with {cursor.toArray}, not all of the elements will be iterated if this cursor had been previouly accessed. In that case, {cursor.rewind} can be used to reset the cursor. However, unlike {cursor.toArray}, the cursor will only hold a maximum of batch size elements at any given time if batch size is specified. Otherwise, the caller is responsible for making sure that the entire result can fit the memory.
callback
this will be called for while iterating every document of the query result. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the document.

Annotations
@deprecated
Deprecated
(Since version 2.2) No alternatives specified
def nextObject(): Promise[T]

Gets the next document from the cursor.
Gets the next document from the cursor.
returns
promise if no callback passed

Annotations
@deprecated
Deprecated
(Since version 2.0) Use next() instead

Related Docs: object Cursor | package mongodb

trait Cursor[T] extends Object with Readable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var _read: Function0[Any]

def addCursorFlag(flag: CursorFlag, value: Boolean): Cursor.this.type

def addListener(eventName: String, listener: Function): Cursor.this.type

def addQueryModifier(name: String, value: Boolean): Cursor.this.type

final def asInstanceOf[T0]: T0

def batchSize(size: Int, callback: MongoCallback[Cursor.this.type]): Unit

def batchSize(size: Int): Promise[Cursor.this.type]

def clone(): Cursor.this.type

def close(callback: MongoCallback[Cursor.this.type]): Unit

def close(): Promise[Cursor.this.type]

def close(callback: Function): Unit

def collation(value: Any): Cursor.this.type

def comment(value: String): Cursor.this.type

def count(applySkipLimit: Boolean, callback: MongoCallback[Int]): Unit

def count(applySkipLimit: Boolean, options: |[CountOptions, RawOptions], callback: MongoCallback[Int]): Unit

def count(applySkipLimit: Boolean = js.native, options: |[CountOptions, RawOptions] = js.native): Promise[Int]

var domain: String

def emit(name: String, args: Any*): Any

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explain(callback: Function): Unit

def filter(filter: Any): Cursor.this.type

def finalize(): Unit

def forEach(iterator: Function1[T, Any], callback: MongoCallback[T]): Unit

final def getClass(): Class[_]

def getMaxListeners(): Int

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

def hint(hint: String = js.native): Cursor.this.type

def isClosed(): Boolean

final def isInstanceOf[T0]: Boolean

def isPaused(): Boolean

def isPrototypeOf(v: Object): Boolean

def limit(limit: Int, callback: Function = js.native): Cursor.this.type

def listenerCount(eventName: String): Int

def listeners(eventName: String): Array[Function]

def map(transform: Function): Unit

def max(max: Int): Cursor.this.type

def maxAwaitTimeMS(value: Int): Cursor.this.type

def maxScan(maxScan: Int): Cursor.this.type

def maxTimeMS(maxTimeMS: Int, callback: Function = js.native): Cursor.this.type

def min(min: Int): Cursor.this.type

final def ne(arg0: AnyRef): Boolean

def next(): Promise[T]

def next(callback: Function): Unit

def nextObject(callback: MongoCallback[T]): Unit

final def notify(): Unit

final def notifyAll(): Unit

def on(eventName: String, listener: Function): Cursor.this.type

def once(eventName: String, listener: Function): Cursor.this.type

def pause(): Cursor.this.type

def pipe(destination: Writable, options: RawOptions): Cursor.this.type

def project(value: Any): Cursor.this.type

def propertyIsEnumerable(v: String): Boolean

def push(value: Any): Cursor.this.type

def read[T](size: Int): T

def removeAllListeners(): Cursor.this.type

def removeAllListeners(eventName: String): Cursor.this.type

def removeListener(eventName: String, listener: Function): Cursor.this.type

def resume(): Cursor.this.type

def returnKey(returnKey: Int): Cursor.this.type

def rewind(): Cursor.this.type

def setEncoding(encoding: String): Cursor.this.type

def setMaxListeners(n: Int): Cursor.this.type

def setReadPreference(pref: String, callback: Function = js.native): Cursor.this.type

def showRecordId(enable: Boolean): Cursor.this.type

def skip(skip: Int, callback: Function = js.native): Cursor.this.type

def snapshot(enable: Boolean): Cursor.this.type

def sort(keyOrList: |[String, Array[Any]], direction: |[Int, String]): Cursor.this.type

def sort(keyOrList: Array[Any], callback: Function = js.native): Cursor.this.type

def sort(keyOrList: String, direction: |[Int, String], callback: Function): Cursor.this.type

def stream(transform: StreamTransform): Cursor.this.type

def stream(): CursorStream