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
BSONQueryBuilder, ChannelQueryBuilder
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GenericQueryBuilder
  2. GenericHandlers
  3. AnyRef
  4. 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

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: 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 GenericQueryBuilder[Structure, Reader, Writer] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. 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 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. def BufferReaderInstance[T](reader: Reader[T]): GenericBufferReader[T]

    Definition Classes
    GenericHandlers

  9. def BufferWriterInstance[T](writer: Writer[T]): GenericBufferWriter[T]

    Definition Classes
    GenericHandlers

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def clone(): AnyRef

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

  12. def comment(message: String): Self

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

  13. def cursor[T](readPreference: ReadPreference)(implicit reader: Reader[T] = structureReader, 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.

  14. def cursor[T](implicit reader: Reader[T] = structureReader, 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.

  15. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  21. def finalize(): Unit

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

  22. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  25. def hint(document: Structure): Self

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

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

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

  32. def options(options: QueryOpts): Self

  33. def projection(p: Structure): Self

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

  35. def query(selector: Structure): Self

    Sets the query (the selector document).

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

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

    Toggles snapshot mode.

  38. def sort(document: Structure): Self

    Sets the sorting document.

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

    Definition Classes
    AnyRef

  40. def toString(): String

    Definition Classes
    AnyRef → Any

  41. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  44. 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 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 GenericQueryBuilder[Structure, Reader, Writer] 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:
    (genericQueryBuilder: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] 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:
    (genericQueryBuilder: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GenericQueryBuilder[Structure, Reader, Writer]

    Implicit information
    This member is added by an implicit conversion from GenericQueryBuilder[Structure, Reader, Writer] to ArrowAssoc[GenericQueryBuilder[Structure, Reader, Writer]] 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:
    (genericQueryBuilder: ArrowAssoc[GenericQueryBuilder[Structure, Reader, Writer]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: 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 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:
    (genericQueryBuilder: Ensuring[GenericQueryBuilder[Structure, Reader, Writer]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from GenericHandlers[Structure, Reader, Writer]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped