t

reactivemongo.api.collections

GenericQueryBuilder

trait GenericQueryBuilder[P <: SerializationPack] extends QueryOps

A builder that helps to make a fine-tuned query to MongoDB.

When the query is ready, you can call cursor to get a Cursor, or one if you want to retrieve just one document.

Annotations
@deprecated
Deprecated

(Since version 0.16.0) Internal: will be made private

Linear Supertypes
QueryOps, AnyRef, Any
Known Subclasses
BSONQueryBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenericQueryBuilder
  2. QueryOps
  3. AnyRef
  4. 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

Type Members

  1. abstract type Self <: GenericQueryBuilder[pack.type]
    Definition Classes
    GenericQueryBuilder → QueryOps

Abstract Value Members

  1. abstract def collection: Collection
  2. abstract def commentString: Option[String]
  3. abstract def explainFlag: Boolean
  4. abstract def failoverStrategy: FailoverStrategy
    Annotations
    @deprecatedName(Symbol("failover"))
  5. abstract def hintOption: Option[P.Document]
  6. abstract def maxTimeMsOption: Option[Long]
  7. abstract def options: QueryOpts
  8. abstract val pack: P
  9. abstract def projectionOption: Option[P.Document]
  10. abstract def queryOption: Option[P.Document]
  11. abstract def snapshotFlag: Boolean
  12. abstract def sortOption: Option[P.Document]
  13. abstract def copy(queryOption: Option[P.Document] = queryOption, sortOption: Option[P.Document] = sortOption, projectionOption: Option[P.Document] = projectionOption, hintOption: Option[P.Document] = hintOption, explainFlag: Boolean = explainFlag, snapshotFlag: Boolean = snapshotFlag, commentString: Option[String] = commentString, options: QueryOpts = options, failoverStrategy: FailoverStrategy = failoverStrategy, maxTimeMsOption: Option[Long] = maxTimeMsOption): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.0) Internal: will be made private

Concrete 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 GenericQueryBuilder[P] toany2stringadd[GenericQueryBuilder[P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GenericQueryBuilder[P], B)
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toArrowAssoc[GenericQueryBuilder[P]] 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: Self

    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.

    Definition Classes
    GenericQueryBuilder → QueryOps
  8. def batchSize(n: Int): Self

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

    Definition Classes
    GenericQueryBuilder → QueryOps
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def comment(message: String): Self

    Adds a comment to this query, that may appear in the MongoDB logs.

  11. def cursor[T](readPreference: ReadPreference = readPreference, isMongo26WriteOp: Boolean = false)(implicit reader: P.Reader[T], cp: CursorProducer[T]): ProducedCursor

    Returns a Cursor for the result of this query.

    Returns a Cursor for the result of this query.

    import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.Cursor
import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONCollection

def findAllVisible(coll: BSONCollection)(
  implicit ec: ExecutionContext): Future[List[BSONDocument]] =
  coll.find(BSONDocument("visible" -> true)).
    cursor[BSONDocument]().collect[List](
     maxDocs = 10,
     err = Cursor.FailOnError[List[BSONDocument]]())
    T

    the results type

    readPreference

    The reactivemongo.api.ReadPreference for this query. If the ReadPreference implies that this query can be run on a secondary, the slaveOk flag will be set.

    reader

    the reader for the results type

  12. def ensuring(cond: (GenericQueryBuilder[P]) => Boolean, msg: => Any): GenericQueryBuilder[P]
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toEnsuring[GenericQueryBuilder[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (GenericQueryBuilder[P]) => Boolean): GenericQueryBuilder[P]
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toEnsuring[GenericQueryBuilder[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): GenericQueryBuilder[P]
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toEnsuring[GenericQueryBuilder[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): GenericQueryBuilder[P]
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toEnsuring[GenericQueryBuilder[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def exhaust: Self

    Toggles Exhaust

    Toggles Exhaust

    Definition Classes
    GenericQueryBuilder → QueryOps
  19. def explain(flag: Boolean = true): Self

    Toggles explain mode.

  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toStringFormat[GenericQueryBuilder[P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hint(document: P.Document): Self

    Sets the hint document (a document that declares the index MongoDB should use for this query).

  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def maxTimeMs(p: Long): Self

    Adds maxTimeMs to query

  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noCursorTimeout: Self

    Toggles NoCursorTimeout: The cursor will not expire automatically

    Toggles NoCursorTimeout: The cursor will not expire automatically

    Definition Classes
    GenericQueryBuilder → QueryOps
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def one[T](readPreference: ReadPreference)(implicit reader: P.Reader[T], ec: ExecutionContext): Future[Option[T]]

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption).

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption).

    import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.ReadPreference
import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONCollection

def findUser(coll: BSONCollection, name: String)(
  implicit ec: ExecutionContext): Future[Option[BSONDocument]] =
  coll.find(BSONDocument("user" -> name)).
    one[BSONDocument](ReadPreference.primaryPreferred)
    T

    the results type

    readPreference

    The reactivemongo.api.ReadPreference for this query. If the ReadPreference implies that this query can be run on a secondary, the slaveOk flag will be set.

    reader

    the reader for the results type

  32. def one[T](implicit reader: P.Reader[T], ec: ExecutionContext): Future[Option[T]]

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption) (using the default reactivemongo.api.ReadPreference).

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption) (using the default reactivemongo.api.ReadPreference).

    import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.bson.{ BSONDocument, Macros }
import reactivemongo.api.bson.collection.BSONCollection

case class User(name: String, pass: String)

implicit val handler = Macros.reader[User]

def findUser(coll: BSONCollection, name: String)(
  implicit ec: ExecutionContext): Future[Option[User]] =
  coll.find(BSONDocument("user" -> name)).one[User]
    T

    the results type

    reader

    the reader for the results type

  33. def oplogReplay: Self

    Toggles OplogReplay

    Toggles OplogReplay

    Definition Classes
    GenericQueryBuilder → QueryOps
  34. def options(options: QueryOpts): Self
  35. def partial: Self

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

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

    Definition Classes
    GenericQueryBuilder → QueryOps
  36. def projection(p: P.Document): Self

    Sets the projection specification to determine which fields to include in the returned documents.

  37. def projection[Pjn](p: Pjn)(implicit writer: P.Writer[Pjn]): Self

    Sets the projection specification to determine which fields to include in the returned documents.

    Sets the projection specification to determine which fields to include in the returned documents.

    Pjn

    The type of the projection. An implicit Writer[Pjn] typeclass for handling it has to be in the scope.

  38. def readConcern: ReadConcern

    The read concern (since 3.2)

  39. def requireOne[T](readPreference: ReadPreference)(implicit reader: P.Reader[T], ec: ExecutionContext): Future[T]

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head).

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head).

    import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.ReadPreference
import reactivemongo.api.bson.{ BSONDocument, Macros }
import reactivemongo.api.bson.collection.BSONCollection

case class User(name: String, pass: String)

implicit val handler = Macros.handler[User]

def findUser(coll: BSONCollection, name: String)(
  implicit ec: ExecutionContext): Future[User] =
  coll.find(BSONDocument("user" -> name)).
    requireOne[User](ReadPreference.primaryPreferred)
    T

    the results type

    readPreference

    The reactivemongo.api.ReadPreference for this query. If the ReadPreference implies that this query can be run on a secondary, the slaveOk flag will be set.

    reader

    the reader for the results type

  40. def requireOne[T](implicit reader: P.Reader[T], ec: ExecutionContext): Future[T]

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head) (using the default reactivemongo.api.ReadPreference).

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head) (using the default reactivemongo.api.ReadPreference).

    import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONCollection

def findUser(coll: BSONCollection, name: String)(
  implicit ec: ExecutionContext): Future[BSONDocument] =
  coll.find(BSONDocument("user" -> name)).requireOne[BSONDocument]
    T

    the results type

    reader

    the reader for the results type

  41. def skip(n: Int): Self

    Sets the number of documents to skip.

    Sets the number of documents to skip.

    Definition Classes
    GenericQueryBuilder → QueryOps
  42. def slaveOk: Self

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

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

    Definition Classes
    GenericQueryBuilder → QueryOps
  43. def snapshot(flag: Boolean = true): Self

    Toggles snapshot mode.

  44. def sort(document: P.Document): Self

    Sets the sort specification for the ordering of the results.

    Sets the sort specification for the ordering of the results.

    import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.Cursor
import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONCollection

def findSortedVisible(coll: BSONCollection)(
  implicit ec: ExecutionContext): Future[List[BSONDocument]] =
  coll.find(BSONDocument("visible" -> true)).
    sort(BSONDocument("age" -> 1)). // sort per age
    cursor[BSONDocument]().
    collect[List](
      maxDocs = 100,
      err = Cursor.FailOnError[List[BSONDocument]]())
  45. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  46. def tailable: Self

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

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

    Definition Classes
    GenericQueryBuilder → QueryOps
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. lazy val version: MongoWireVersion
    Attributes
    protected
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def filter(predicate: P.Document): Self

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.4) Specify the filter predicate using collection.find(..)

  2. def filter[Qry](predicate: Qry)(implicit writer: P.Writer[Qry]): Self

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Qry

    The type of the query. An implicit Writer[Qry] typeclass for handling it has to be in the scope.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.4) Specify the filter predicate using collection.find(..)

  3. def query(selector: P.Document): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.2) Use filter

  4. def query[Qry](selector: Qry)(implicit writer: P.Writer[Qry]): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.2) Use filter

  5. def readPreference: ReadPreference

    The default ReadPreference

    The default ReadPreference

    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.16.0) Internal: will be made private

  6. def updateOptions(update: (QueryOpts) => QueryOpts): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.4) Use options or the separate query ops

  7. def →[B](y: B): (GenericQueryBuilder[P], B)
    Implicit
    This member is added by an implicit conversion from GenericQueryBuilder[P] toArrowAssoc[GenericQueryBuilder[P]] 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.

Inherited from QueryOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromGenericQueryBuilder[P] to any2stringadd[GenericQueryBuilder[P]]

Inherited by implicit conversion StringFormat fromGenericQueryBuilder[P] to StringFormat[GenericQueryBuilder[P]]

Inherited by implicit conversion Ensuring fromGenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]]

Inherited by implicit conversion ArrowAssoc fromGenericQueryBuilder[P] to ArrowAssoc[GenericQueryBuilder[P]]

Ungrouped