c

reactivemongo.api

QueryOpts

case class QueryOpts(skipN: Int = 0, batchSizeN: Int = 0, flagsN: Int = 0) extends QueryOps with Product with Serializable

A helper to make the query options. You may use the methods to set the fields of this class, or set them directly.

skipN

the number of documents to skip.

batchSizeN

the upper limit on the number of documents to retrieve per batch (0 for unspecified)

flagsN

the query flags

Annotations
@deprecated
Deprecated

(Since version 0.19.8) Internal: will be made private

Linear Supertypes
Serializable, Serializable, Product, Equals, QueryOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryOpts
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. QueryOps
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new QueryOpts(skipN: Int = 0, batchSizeN: Int = 0, flagsN: Int = 0)

    skipN

    the number of documents to skip.

    batchSizeN

    the upper limit on the number of documents to retrieve per batch (0 for unspecified)

    flagsN

    the query flags

Type Members

  1. type Self = QueryOpts
    Definition Classes
    QueryOpts → QueryOps

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
    This member is added by an implicit conversion from QueryOpts to any2stringadd[QueryOpts] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (QueryOpts, B)
    Implicit
    This member is added by an implicit conversion from QueryOpts to ArrowAssoc[QueryOpts] 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 awaitData: QueryOpts

    Makes the result cursor await data.

    Makes the result cursor await data.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().awaitData
    Definition Classes
    QueryOpts → QueryOps
  8. def batchSize(n: Int): QueryOpts

    Sets the size of result batches.

    Sets the size of result batches.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().batchSize(10)
    Definition Classes
    QueryOpts → QueryOps
  9. val batchSizeN: Int
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def ensuring(cond: (QueryOpts) ⇒ Boolean, msg: ⇒ Any): QueryOpts
    Implicit
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (QueryOpts) ⇒ Boolean): QueryOpts
    Implicit
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): QueryOpts
    Implicit
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): QueryOpts
    Implicit
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def exhaust: QueryOpts

    Sets the flag to return all data returned by the query at once rather than splitting the results into batches.

    Sets the flag to return all data returned by the query at once rather than splitting the results into batches.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().exhaust
    Definition Classes
    QueryOpts → QueryOps
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def flags(n: Int): QueryOpts

    Sets the query (raw) flags.

  19. val flagsN: Int
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from QueryOpts to StringFormat[QueryOpts] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def noCursorTimeout: QueryOpts

    Sets the noTimeout flag.

    Sets the noTimeout flag.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().noCursorTimeout
    Definition Classes
    QueryOpts → QueryOps
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def oplogReplay: QueryOpts

    Toggles OplogReplay

    Toggles OplogReplay

    Definition Classes
    QueryOpts → QueryOps
  28. def partial: QueryOpts

    Sets the flag to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.

    Sets the flag to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().partial
    Definition Classes
    QueryOpts → QueryOps
  29. def skip(n: Int): QueryOpts

    Sets how many documents must be skipped at the beginning of the results.

    Sets how many documents must be skipped at the beginning of the results.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().skip(10)
    Definition Classes
    QueryOpts → QueryOps
  30. val skipN: Int
  31. def slaveOk: QueryOpts

    Allows querying of a replica slave (slaveOk).

    Allows querying of a replica slave (slaveOk).

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().slaveOk
    Definition Classes
    QueryOpts → QueryOps
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def tailable: QueryOpts

    Makes the result cursor tailable.

    Makes the result cursor tailable.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().tailable
    Definition Classes
    QueryOpts → QueryOps
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  37. def →[B](y: B): (QueryOpts, B)
    Implicit
    This member is added by an implicit conversion from QueryOpts to ArrowAssoc[QueryOpts] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from QueryOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from QueryOpts to any2stringadd[QueryOpts]

Inherited by implicit conversion StringFormat from QueryOpts to StringFormat[QueryOpts]

Inherited by implicit conversion Ensuring from QueryOpts to Ensuring[QueryOpts]

Inherited by implicit conversion ArrowAssoc from QueryOpts to ArrowAssoc[QueryOpts]

Ungrouped