reactivemongo.api.collections

GenericQueryBuilder

trait GenericQueryBuilder[Structure, Reader[_], Writer[_]] extends GenericHandlers[Structure, Reader, Writer]

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.

Linear Supertypes
GenericHandlers[Structure, Reader, Writer], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GenericQueryBuilder
  2. GenericHandlers
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class GenericBufferReader[T](reader: Reader[T]) extends BufferReader[T] with Product with Serializable

    Definition Classes
    GenericHandlers
  2. case class GenericBufferWriter[T](writer: Writer[T]) extends BufferWriter[T] with Product with Serializable

    Definition Classes
    GenericHandlers
  3. abstract type Self <: GenericQueryBuilder[Structure, Reader, Writer]

Abstract Value Members

  1. abstract def StructureBufferReader: BufferReader[Structure]

    Definition Classes
    GenericHandlers
  2. abstract def StructureBufferWriter: BufferWriter[Structure]

    Definition Classes
    GenericHandlers
  3. abstract def StructureReader[T](reader: Reader[T]): GenericReader[Structure, T]

    Definition Classes
    GenericHandlers
  4. abstract def StructureWriter[T](writer: Writer[T]): GenericWriter[T, Structure]

    Definition Classes
    GenericHandlers
  5. abstract def collection: Collection

  6. abstract def commentString: Option[String]

  7. abstract def copy(queryOption: Option[Structure] = queryOption, sortOption: Option[Structure] = sortOption, projectionOption: Option[Structure] = projectionOption, hintOption: Option[Structure] = hintOption, explainFlag: Boolean = explainFlag, snapshotFlag: Boolean = snapshotFlag, commentString: Option[String] = commentString, options: QueryOpts = options, failover: FailoverStrategy = failover): Self

  8. abstract def explainFlag: Boolean

  9. abstract def failover: FailoverStrategy

  10. abstract def hintOption: Option[Structure]

  11. abstract def merge: Structure

  12. abstract def options: QueryOpts

  13. abstract def projectionOption: Option[Structure]

  14. abstract def queryOption: Option[Structure]

  15. abstract def snapshotFlag: Boolean

  16. abstract def sortOption: Option[Structure]

  17. abstract def structureReader: Reader[Structure]

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 information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to any2stringadd[GenericQueryBuilder[Structure, Reader, Writer]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GenericQueryBuilder[Structure, Reader, Writer], B)

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to ArrowAssoc[GenericQueryBuilder[Structure, Reader, Writer]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def BufferReaderInstance[T](reader: Reader[T]): GenericBufferReader[T]

    Definition Classes
    GenericHandlers
  7. def BufferWriterInstance[T](writer: Writer[T]): GenericBufferWriter[T]

    Definition Classes
    GenericHandlers
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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)(implicit reader: Reader[T], ec: ExecutionContext): Cursor[T]

    Makes a Cursor of this query, which can be enumerated.

    Makes a Cursor of this query, which can be enumerated.

    An implicit Reader[T] must be present in the scope.

    readPreference

    The ReadPreference for this request. If the ReadPreference implies that this request might be run on a Secondary, the slaveOk flag will be set.

  12. def cursor[T](implicit reader: Reader[T], ec: ExecutionContext): Cursor[T]

    Sends this query and gets a Cursor of instances of T.

    Sends this query and gets a Cursor of instances of T.

    An implicit Reader[T] must be present in the scope.

  13. def ensuring(cond: (GenericQueryBuilder[Structure, Reader, Writer]) ⇒ Boolean, msg: ⇒ Any): GenericQueryBuilder[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to Ensuring[GenericQueryBuilder[Structure, Reader, Writer]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (GenericQueryBuilder[Structure, Reader, Writer]) ⇒ Boolean): GenericQueryBuilder[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to Ensuring[GenericQueryBuilder[Structure, Reader, Writer]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): GenericQueryBuilder[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to Ensuring[GenericQueryBuilder[Structure, Reader, Writer]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): GenericQueryBuilder[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to Ensuring[GenericQueryBuilder[Structure, Reader, Writer]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to StringFormat[GenericQueryBuilder[Structure, Reader, Writer]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  23. def hint(document: Structure): Self

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

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. def one[T](readPreference: ReadPreference)(implicit reader: Reader[T], ec: ExecutionContext): Future[Option[T]]

    Sends this query and gets a future Option[T].

    Sends this query and gets a future Option[T].

    An implicit Reader[T] must be present in the scope.

    readPreference

    The ReadPreference for this request. If the ReadPreference implies that this request might be run on a Secondary, the slaveOk flag will be set.

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

    Sends this query and gets a future Option[T].

    Sends this query and gets a future Option[T].

    An implicit Reader[T] must be present in the scope.

  30. def options(options: QueryOpts): Self

  31. def projection(p: Structure): Self

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

    Sets the projection document (for retrieving only a subset of fields).

    Sets the projection document (for retrieving only a subset of fields).

    Pjn

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

  33. def query(selector: Structure): Self

    Sets the query (the selector document).

  34. def query[Qry](selector: Qry)(implicit writer: Writer[Qry]): Self

    Sets the query (the selector document).

    Sets the query (the selector document).

    Qry

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

  35. def snapshot(flag: Boolean = true): Self

    Toggles snapshot mode.

  36. def sort(document: Structure): Self

    Sets the sorting document.

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

    Definition Classes
    AnyRef
  38. def toString(): String

    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def [B](y: B): (GenericQueryBuilder[Structure, Reader, Writer], B)

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to ArrowAssoc[GenericQueryBuilder[Structure, Reader, Writer]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from GenericHandlers[Structure, Reader, Writer]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GenericQueryBuilder[Structure, Reader, Writer] to any2stringadd[GenericQueryBuilder[Structure, Reader, Writer]]

Inherited by implicit conversion StringFormat from GenericQueryBuilder[Structure, Reader, Writer] to StringFormat[GenericQueryBuilder[Structure, Reader, Writer]]

Inherited by implicit conversion Ensuring from GenericQueryBuilder[Structure, Reader, Writer] to Ensuring[GenericQueryBuilder[Structure, Reader, Writer]]

Inherited by implicit conversion ArrowAssoc from GenericQueryBuilder[Structure, Reader, Writer] to ArrowAssoc[GenericQueryBuilder[Structure, Reader, Writer]]

Ungrouped