CommandCursor

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. var _read: Function0[Any]

   

   Definition Classes

   Readable

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

   

   Definition Classes

   IEventEmitter

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def batchSize(size: Int): CommandCursor.this.type

   

   Set the batch size for the cursor.

   Set the batch size for the cursor.

   size

   The batchSize for the cursor.

   returns

   a CommandCursor

8. def clone(): CommandCursor.this.type

   

   Clone the cursor

   Clone the cursor

   returns

   a CommandCursor

   Definition Classes

   CommandCursor → AnyRef

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

   

   Close the cursor, sending a KillCursor command and emitting close.

   Close the cursor, sending a KillCursor command and emitting close.

   callback

   The result callback.

10. def close(): Promise[CommandCursor.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 result

11. def close(callback: Function): Unit

    

    Definition Classes

    Readable

12. var domain: String

    

    Definition Classes

    IEventEmitter

13. 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

    The result callback.

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

    

    Definition Classes

    IEventEmitter

15. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

16. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

17. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

19. def getMaxListeners(): Int

    

    Definition Classes

    IEventEmitter

20. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

21. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

22. def isClosed(): Boolean

    

    Is the cursor closed

    Is the cursor closed

    returns

    true, if the cursor is closed

23. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

24. def isPaused(): Boolean

    

    Definition Classes

    Readable

25. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

26. def listenerCount(eventName: String): Int

    

    Definition Classes

    IEventEmitter

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

    

    Definition Classes

    IEventEmitter

28. def maxTimeMS(value: Int): CommandCursor.this.type

    

    Add a maxTimeMS stage to the aggregation pipeline

    Add a maxTimeMS stage to the aggregation pipeline

    value

    The state maxTimeMS value.

    returns

    a CommandCursor

29. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

30. def next(callback: MongoCallback[T]): 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.

31. final def notify(): Unit

    

    Definition Classes

    AnyRef

32. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    IEventEmitter

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

    

    Definition Classes

    IEventEmitter

35. def pause(): CommandCursor.this.type

    

    Definition Classes

    Readable

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

    

    Definition Classes

    Readable

37. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

38. def push(value: Any): CommandCursor.this.type

    

    Definition Classes

    Readable

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

    

    Definition Classes

    Readable

40. def removeAllListeners(): CommandCursor.this.type

    

    Definition Classes

    IEventEmitter

41. def removeAllListeners(eventName: String): CommandCursor.this.type

    

    Definition Classes

    IEventEmitter

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

    

    Definition Classes

    IEventEmitter

43. def resume(): CommandCursor.this.type

    

    Definition Classes

    Readable

44. def setEncoding(encoding: String): CommandCursor.this.type

    

    Definition Classes

    Readable

45. def setMaxListeners(n: Int): CommandCursor.this.type

    

    Definition Classes

    IEventEmitter

46. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

47. 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.

    callback

    The result callback.

48. def toArray(): Promise[Array[T]]

    

    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.

    returns

    the promise of an array of results

49. def toLocaleString(): String

    

    Definition Classes

    Object

50. def toString(): String

    

    Definition Classes

    AnyRef → Any

51. def unpipe(destination: Writable): Unit

    

    Definition Classes

    Readable

52. def unshift(chunk: Any): Unit

    

    Definition Classes

    Readable

53. var usingDomains: Boolean

    

    Definition Classes

    IEventEmitter

54. def valueOf(): Any

    

    Definition Classes

    Object

55. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

56. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

57. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

58. def wrap(stream: Any): Unit

    

    Definition Classes

    Readable