reactivemongo.api.collections.bson

BSONQueryBuilder

case class BSONQueryBuilder(collection: Collection, failover: FailoverStrategy, queryOption: Option[BSONDocument] = scala.None, sortOption: Option[BSONDocument] = scala.None, projectionOption: Option[BSONDocument] = scala.None, hintOption: Option[BSONDocument] = scala.None, explainFlag: Boolean = false, snapshotFlag: Boolean = false, commentString: Option[String] = scala.None, options: QueryOpts = ..., maxTimeMsOption: Option[Long] = scala.None) 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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  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] = scala.None, sortOption: Option[BSONDocument] = scala.None, projectionOption: Option[BSONDocument] = scala.None, hintOption: Option[BSONDocument] = scala.None, explainFlag: Boolean = false, snapshotFlag: Boolean = false, commentString: Option[String] = scala.None, options: QueryOpts = ..., maxTimeMsOption: Option[Long] = scala.None)

Type Members

  1. type Self = BSONQueryBuilder

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

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

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to ArrowAssoc[BSONQueryBuilder] 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

  10. val collection: Collection

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

  12. val commentString: Option[String]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  13. 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, maxTimeMsOption: Option[Long] = maxTimeMsOption): BSONQueryBuilder

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

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

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

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

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

  18. def ensuring(cond: Boolean): BSONQueryBuilder

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

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

    Definition Classes
    AnyRef

  20. def explain(flag: Boolean = true): Self

    Toggles explain mode.

    Toggles explain mode.

    Definition Classes
    GenericQueryBuilder

  21. val explainFlag: Boolean

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  22. val failover: FailoverStrategy

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  23. def finalize(): Unit

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

  24. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

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

  27. val hintOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  29. def maxTimeMs(p: Long): Self

    Adds maxTimeMs to query https://docs.

    Adds maxTimeMs to query https://docs.mongodb.org/v3.0/reference/operator/meta/maxTimeMS/

    Definition Classes
    GenericQueryBuilder

  30. val maxTimeMsOption: Option[Long]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  31. def merge(readPreference: ReadPreference): BSONDocument

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  35. 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]. Alias for .cursor[T](readPreference).headOption.

    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

  36. 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]. Alias for .cursor[T]().headOption.

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

    Definition Classes
    GenericQueryBuilder

  37. def options(options: QueryOpts): Self

    Definition Classes
    GenericQueryBuilder

  38. val options: QueryOpts

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  39. val pack: BSONSerializationPack.type

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  40. def projection(p: Document): Self

    Definition Classes
    GenericQueryBuilder

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

  42. val projectionOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  43. def query(selector: Document): Self

    Sets the query (the selector document).

    Sets the query (the selector document).

    Definition Classes
    GenericQueryBuilder

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

  45. val queryOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

    Toggles snapshot mode.

    Toggles snapshot mode.

    Definition Classes
    GenericQueryBuilder

  47. val snapshotFlag: Boolean

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

  48. def sort(document: Document): Self

    Sets the sorting document.

    Sets the sorting document.

    Definition Classes
    GenericQueryBuilder

  49. val sortOption: Option[BSONDocument]

    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder

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

    Definition Classes
    AnyRef

  51. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to ArrowAssoc[BSONQueryBuilder] 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 BSONQueryBuilder 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:
    (bSONQueryBuilder: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder 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:
    (bSONQueryBuilder: StringFormat).self
    Definition Classes
    StringFormat

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.

  2. def x: BSONQueryBuilder

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

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: BSONQueryBuilder

    Implicit information
    This member is added by an implicit conversion from BSONQueryBuilder to Ensuring[BSONQueryBuilder] 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:
    (bSONQueryBuilder: Ensuring[BSONQueryBuilder]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from BSONQueryBuilder to StringFormat

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

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

Ungrouped