reactivemongo.api

Cursor

trait Cursor[T] extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Cursor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def collect[M[_]](upTo: Int = Int.MaxValue, stopOnError: Boolean = true)(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

    Collects all the documents into a collection of type M[T].

    Collects all the documents into a collection of type M[T]. Given the stopOnError parameter (which defaults to true), the resulting Future may fail if any non-fatal exception occurs. If set to false, all the documents that caused exceptions are skipped. Up to maxDocs returned by the database may be processed. If stopOnError is false, then documents that cause error are dropped, so the result may contain a little less than maxDocs even if maxDocs documents were processed.

    upTo

    Collect up to upTo documents.

    stopOnError

    States if the Future should fail if any non-fatal exception occurs.

    Example:

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return the 3 first documents in a Vector[BSONDocument].
    val vector = cursor.collect[Vector](3)
  2. abstract def enumerate(maxDocs: Int = Int.MaxValue, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[T]

    Produces an Enumerator of documents.

    Produces an Enumerator of documents. Given the stopOnError parameter, this Enumerator may stop on any non-fatal exception, or skip and continue. The returned enumerator may process up to maxDocs. If stopOnError is false, then documents that cause error are dropped, so the enumerator may emit a little less than maxDocs even if it processes maxDocs documents.

    maxDocs

    Enumerate up to maxDocs documents.

    stopOnError

    States if the produced Enumerator may stop on non-fatal exception.

    returns

    an Enumerator of documents.

  3. abstract def enumerateBulks(maxDocs: Int = Int.MaxValue, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

    Produces an Enumerator of Iterator of documents.

    Produces an Enumerator of Iterator of documents. Given the stopOnError parameter, this Enumerator may stop on any non-fatal exception, or skip and continue.

    maxDocs

    Enumerate up to maxDocs documents.

    stopOnError

    States if the produced Enumerator may stop on non-fatal exception.

    returns

    an Enumerator of Iterators of documents.

  4. abstract def enumerateResponses(maxDocs: Int = Int.MaxValue, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[Response]

    Produces an Enumerator of responses from the database.

    Produces an Enumerator of responses from the database. Given the stopOnError parameter, this Enumerator may stop on any non-fatal exception, or skip and continue.

    maxDocs

    Enumerate up to maxDocs documents.

    stopOnError

    States if the produced Enumerator may stop on non-fatal exception.

    returns

    an Enumerator of Responses.

  5. abstract def rawEnumerateResponses(maxDocs: Int = Int.MaxValue)(implicit ctx: ExecutionContext): Enumerator[Response]

    Produces an Enumerator of responses from the database.

    Produces an Enumerator of responses from the database. An Enumeratee for error handling should be used to prevent silent failures. Consider using enumerateResponses instead.

    maxDocs

    Enumerate up to maxDocs documents.

    returns

    an Enumerator of Responses.

Concrete Value Members

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

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

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to any2stringadd[Cursor[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Cursor[T], B)

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to ArrowAssoc[Cursor[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Cursor[T]) ⇒ Boolean, msg: ⇒ Any): Cursor[T]

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to Ensuring[Cursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Cursor[T]) ⇒ Boolean): Cursor[T]

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to Ensuring[Cursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Cursor[T]

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to Ensuring[Cursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Cursor[T]

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to Ensuring[Cursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to StringFormat[Cursor[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  18. def headOption(implicit ctx: ExecutionContext): Future[Option[T]]

    Gets the first document matching the query, if any.

    Gets the first document matching the query, if any. The resulting Future may fail if any exception occurs (for example, while deserializing the document).

    Example:

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return option of the first element.
    val first: Future[Option[BSONDocument]] = cursor.headOption
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toString(): String

    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def [B](y: B): (Cursor[T], B)

    Implicit information
    This member is added by an implicit conversion from Cursor[T] to ArrowAssoc[Cursor[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def toList(upTo: Int = Int.MaxValue, stopOnError: Boolean = true)(implicit ctx: ExecutionContext): Future[List[T]]

    Collects all the documents into a List[T].

    Collects all the documents into a List[T]. Given the stopOnError parameter (which defaults to true), the resulting Future may fail if any non-fatal exception occurs. If set to false, all the documents that caused exceptions are skipped.

    upTo

    Collect up to maxDocs documents.

    stopOnError

    States if the Future should fail if any non-fatal exception occurs.

    Example:

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return the 3 first documents in a list.
    val list = cursor.toList(3)
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) consider using collect[List] instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Cursor[T] to any2stringadd[Cursor[T]]

Inherited by implicit conversion StringFormat from Cursor[T] to StringFormat[Cursor[T]]

Inherited by implicit conversion Ensuring from Cursor[T] to Ensuring[Cursor[T]]

Inherited by implicit conversion ArrowAssoc from Cursor[T] to ArrowAssoc[Cursor[T]]

Ungrouped