Class

reactivemongo.api

QueryOpts

Related Doc: package api

Permalink

case class QueryOpts(skipN: Int = 0, batchSizeN: Int = 0, flagsN: Int = 0) extends 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.

flagsN

the query flags

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. QueryOpts
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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)

    Permalink

    skipN

    the number of documents to skip.

    batchSizeN

    the upper limit on the number of documents to retrieve per batch.

    flagsN

    the query flags

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def awaitData: QueryOpts

    Permalink

    Toggles AwaitData: Block a little while waiting for more data instead of returning immediately if no data.

    Toggles AwaitData: Block a little while waiting for more data instead of returning immediately if no data. Use along with TailableCursor.

  8. def batchSize(n: Int): QueryOpts

    Permalink

    Sets an upper limit on the number of documents to retrieve per batch.

    Sets an upper limit on the number of documents to retrieve per batch. Defaults to 0 (meaning no upper limit - MongoDB decides).

  9. val batchSizeN: Int

    Permalink

    the upper limit on the number of documents to retrieve per batch.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def ensuring(cond: (QueryOpts) ⇒ Boolean, msg: ⇒ Any): QueryOpts

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef

  16. def exhaust: QueryOpts

    Permalink

    Toggles Exhaust

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. def flags(n: Int): QueryOpts

    Permalink

    Sets the query flags.

  19. val flagsN: Int

    Permalink

    the query flags

  20. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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[_]

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  24. def noCursorTimeout: QueryOpts

    Permalink

    Toggles NoCursorTimeout: The cursor will not expire automatically

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. def oplogReplay: QueryOpts

    Permalink

    Toggles OplogReplay

  28. def partial: QueryOpts

    Permalink

    Toggles Partial: The response can be partial - if a shard is down, no error will be thrown.

  29. def skip(n: Int): QueryOpts

    Permalink

    Sets the number of documents to skip.

  30. val skipN: Int

    Permalink

    the number of documents to skip.

  31. def slaveOk: QueryOpts

    Permalink

    Toggles SlaveOk: The query is might be run on a secondary.

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

    Permalink
    Definition Classes
    AnyRef

  33. def tailable: QueryOpts

    Permalink

    Toggles TailableCursor: Makes the cursor not to close after all the data is consumed.

  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. def →[B](y: B): (QueryOpts, B)

    Permalink
    Implicit information
    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 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