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, Product, Equals, QueryOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryOpts
  2. Serializable
  3. Product
  4. Equals
  5. QueryOps
  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. Protected

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. 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
  2. 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
  3. val batchSizeN: Int
  4. 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
  5. def flags(n: Int): QueryOpts

    Sets the query (raw) flags.

  6. val flagsN: Int
  7. def noCursorTimeout: QueryOpts

    Sets the noTimeout flag.

    Sets the noTimeout flag.

    import reactivemongo.api.QueryOpts

val opts: QueryOpts = QueryOpts().noCursorTimeout
    Definition Classes
    QueryOpts → QueryOps
  8. def oplogReplay: QueryOpts

    Toggles OplogReplay

    Toggles OplogReplay

    Definition Classes
    QueryOpts → QueryOps
  9. 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
  10. def productElementNames: Iterator[String]
    Definition Classes
    Product
  11. 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
  12. val skipN: Int
  13. 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
  14. 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