reactivemongo.api

QueryOpts

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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.

    flagsN

    The query flags.

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from QueryOpts to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (QueryOpts, B)

    Implicit information
    This member is added by an implicit conversion from QueryOpts to ArrowAssoc[QueryOpts] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def awaitData: QueryOpts

    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.

  10. def batchSize(n: Int): QueryOpts

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

  11. val batchSizeN: Int

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

  12. def clone(): AnyRef

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

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

    Implicit information
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: (QueryOpts) ⇒ Boolean): QueryOpts

    Implicit information
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Implicit information
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: Boolean): QueryOpts

    Implicit information
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  18. def exhaust: QueryOpts

    Toggles Exhaust

  19. def finalize(): Unit

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

  20. def flags(n: Int): QueryOpts

    Sets the query flags.

  21. val flagsN: Int

    The query flags.

  22. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from QueryOpts to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  26. def noCursorTimeout: QueryOpts

    Toggles NoCursorTimeout: The cursor will not expire automatically

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. def oplogReplay: QueryOpts

    Toggles OplogReplay

  30. def partial: QueryOpts

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

  31. def skip(n: Int): QueryOpts

    Sets the number of documents to skip.

  32. val skipN: Int

    The number of documents to skip.

  33. def slaveOk: QueryOpts

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

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

    Definition Classes
    AnyRef

  35. def tailable: QueryOpts

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

  36. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from QueryOpts to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (queryOpts: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from QueryOpts to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (queryOpts: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: QueryOpts

    Implicit information
    This member is added by an implicit conversion from QueryOpts to ArrowAssoc[QueryOpts] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (queryOpts: ArrowAssoc[QueryOpts]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: QueryOpts

    Implicit information
    This member is added by an implicit conversion from QueryOpts to Ensuring[QueryOpts] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (queryOpts: Ensuring[QueryOpts]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from QueryOpts to StringFormat

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

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

Ungrouped