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
- Alphabetic
- By Inheritance
- QueryOpts
- Serializable
- Product
- Equals
- QueryOps
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (QueryOpts, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def awaitData: QueryOpts
Makes the result cursor await data.
Makes the result cursor await data.
import reactivemongo.api.QueryOpts val opts: QueryOpts = QueryOpts().awaitData
- def batchSize(n: Int): QueryOpts
Sets the size of result batches.
- val batchSizeN: Int
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (QueryOpts) => Boolean, msg: => Any): QueryOpts
- def ensuring(cond: (QueryOpts) => Boolean): QueryOpts
- def ensuring(cond: Boolean, msg: => Any): QueryOpts
- def ensuring(cond: Boolean): QueryOpts
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def exhaust: QueryOpts
Sets the flag to return all data returned by the query at once rather than splitting the results into batches.
- def flags(n: Int): QueryOpts
Sets the query (raw) flags.
- val flagsN: Int
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noCursorTimeout: QueryOpts
Sets the
noTimeoutflag. - final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def oplogReplay: QueryOpts
Toggles OplogReplay
- 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.
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def skip(n: Int): QueryOpts
Sets how many documents must be skipped at the beginning of the results.
- val skipN: Int
- def slaveOk: QueryOpts
Allows querying of a replica slave (
slaveOk). - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tailable: QueryOpts
Makes the result cursor tailable.
Makes the result cursor tailable.
import reactivemongo.api.QueryOpts val opts: QueryOpts = QueryOpts().tailable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
- def →[B](y: B): (QueryOpts, B)
- Implicit
- This member is added by an implicit conversion from QueryOpts toArrowAssoc[QueryOpts] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.