reactivemongo.api.collections.bson

BSONQueryBuilder

Related Doc: package bson

case class BSONQueryBuilder(collection: Collection, failover: FailoverStrategy, queryOption: Option[BSONDocument] = None, sortOption: Option[BSONDocument] = None, projectionOption: Option[BSONDocument] = None, hintOption: Option[BSONDocument] = None, explainFlag: Boolean = false, snapshotFlag: Boolean = false, commentString: Option[String] = None, options: QueryOpts = QueryOpts()) extends GenericQueryBuilder[BSONSerializationPack.type] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, GenericQueryBuilder[BSONSerializationPack.type], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BSONQueryBuilder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. GenericQueryBuilder
  7. AnyRef
  8. 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

Instance Constructors

  1. new BSONQueryBuilder(collection: Collection, failover: FailoverStrategy, queryOption: Option[BSONDocument] = None, sortOption: Option[BSONDocument] = None, projectionOption: Option[BSONDocument] = None, hintOption: Option[BSONDocument] = None, explainFlag: Boolean = false, snapshotFlag: Boolean = false, commentString: Option[String] = None, options: QueryOpts = QueryOpts())

Type Members

  1. type Self = BSONQueryBuilder

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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 BSONQueryBuilder to any2stringadd[BSONQueryBuilder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (BSONQueryBuilder, B)

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to ArrowAssoc[BSONQueryBuilder] 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 clone(): AnyRef

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

  8. val collection: Collection

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  9. def comment(message: String): Self

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

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

    Definition Classes
    GenericQueryBuilder

  10. val commentString: Option[String]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  11. def copy(queryOption: Option[BSONDocument] = queryOption, sortOption: Option[BSONDocument] = sortOption, projectionOption: Option[BSONDocument] = projectionOption, hintOption: Option[BSONDocument] = hintOption, explainFlag: Boolean = explainFlag, snapshotFlag: Boolean = snapshotFlag, commentString: Option[String] = commentString, options: QueryOpts = options, failover: FailoverStrategy = failover): BSONQueryBuilder

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  12. def cursor[T](readPreference: ReadPreference = ReadPreference.primary, isMongo26WriteOp: Boolean = false)(implicit reader: Reader[T], ec: ExecutionContext, cp: CursorProducer[T]): ProducedCursor

    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.

    Definition Classes
    GenericQueryBuilder

  13. def ensuring(cond: (BSONQueryBuilder) ⇒ Boolean, msg: ⇒ Any): BSONQueryBuilder

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to Ensuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: (BSONQueryBuilder) ⇒ Boolean): BSONQueryBuilder

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to Ensuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean, msg: ⇒ Any): BSONQueryBuilder

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to Ensuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: Boolean): BSONQueryBuilder

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to Ensuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  18. val explainFlag: Boolean

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  19. val failover: FailoverStrategy

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  20. def finalize(): Unit

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

  21. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  23. def hint(document: Document): Self

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

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

    Definition Classes
    GenericQueryBuilder

  24. val hintOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def merge(readPreference: ReadPreference): BSONDocument

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  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.

    Definition Classes
    GenericQueryBuilder

  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.

    Definition Classes
    GenericQueryBuilder

  32. def options(options: QueryOpts): Self

    Definition Classes
    GenericQueryBuilder

  33. val options: QueryOpts

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  34. val pack: BSONSerializationPack.type

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  35. def projection(p: Document): Self

    Definition Classes
    GenericQueryBuilder

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

    Definition Classes
    GenericQueryBuilder

  37. val projectionOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  38. def query(selector: Document): Self

    Sets the query (the selector document).

    Sets the query (the selector document).

    Definition Classes
    GenericQueryBuilder

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

    Definition Classes
    GenericQueryBuilder

  40. val queryOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

    Toggles snapshot mode.

    Toggles snapshot mode.

    Definition Classes
    GenericQueryBuilder

  42. val snapshotFlag: Boolean

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  43. def sort(document: Document): Self

    Sets the sorting document.

    Sets the sorting document.

    Definition Classes
    GenericQueryBuilder

  44. val sortOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

    Definition Classes
    AnyRef

  46. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  49. def →[B](y: B): (BSONQueryBuilder, B)

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to ArrowAssoc[BSONQueryBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def cursor[T](implicit reader: Reader[T], ec: ExecutionContext, cp: CursorProducer[T]): ProducedCursor

    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.

    Definition Classes
    GenericQueryBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.0) Use cursor function with read preference.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenericQueryBuilder[BSONSerializationPack.type]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BSONQueryBuilder to any2stringadd[BSONQueryBuilder]

Inherited by implicit conversion StringFormat from BSONQueryBuilder to StringFormat[BSONQueryBuilder]

Inherited by implicit conversion Ensuring from BSONQueryBuilder to Ensuring[BSONQueryBuilder]

Inherited by implicit conversion ArrowAssoc from BSONQueryBuilder to ArrowAssoc[BSONQueryBuilder]

Ungrouped