Class

reactivemongo.api.collections.bson

BSONQueryBuilder

Related Doc: package bson

Permalink

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(), maxTimeMsOption: Option[Long] = 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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
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(), maxTimeMsOption: Option[Long] = None)

    Permalink

Type Members

  1. type Self = BSONQueryBuilder

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

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

    Permalink
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val collection: Collection

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  9. def comment(message: String): Self

    Permalink

    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]

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  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, maxTimeMsOption: Option[Long] = maxTimeMsOption): BSONQueryBuilder

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

    Permalink

    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    Definition Classes
    AnyRef
  18. def explain(flag: Boolean = true): Self

    Permalink

    Toggles explain mode.

    Toggles explain mode.

    Definition Classes
    GenericQueryBuilder
  19. val explainFlag: Boolean

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  20. val failover: FailoverStrategy

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  21. def finalize(): Unit

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

    Permalink
    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()
  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def hint(document: Document): Self

    Permalink

    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
  25. val hintOption: Option[BSONDocument]

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def maxTimeMs(p: Long): Self

    Permalink

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

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

    Definition Classes
    GenericQueryBuilder
  28. val maxTimeMsOption: Option[Long]

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  29. def merge(readPreference: ReadPreference): BSONDocument

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

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

    Permalink

    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
  34. def one[T](implicit reader: Reader[T], ec: ExecutionContext): Future[Option[T]]

    Permalink

    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
  35. def options(options: QueryOpts): Self

    Permalink
    Definition Classes
    GenericQueryBuilder
  36. val options: QueryOpts

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  37. val pack: BSONSerializationPack.type

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  38. def projection(p: Document): Self

    Permalink
    Definition Classes
    GenericQueryBuilder
  39. def projection[Pjn](p: Pjn)(implicit writer: Writer[Pjn]): Self

    Permalink

    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
  40. val projectionOption: Option[BSONDocument]

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  41. def query(selector: Document): Self

    Permalink

    Sets the query (the selector document).

    Sets the query (the selector document).

    Definition Classes
    GenericQueryBuilder
  42. def query[Qry](selector: Qry)(implicit writer: Writer[Qry]): Self

    Permalink

    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
  43. val queryOption: Option[BSONDocument]

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  44. def snapshot(flag: Boolean = true): Self

    Permalink

    Toggles snapshot mode.

    Toggles snapshot mode.

    Definition Classes
    GenericQueryBuilder
  45. val snapshotFlag: Boolean

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  46. def sort(document: Document): Self

    Permalink

    Sets the sorting document.

    Sets the sorting document.

    Definition Classes
    GenericQueryBuilder
  47. val sortOption: Option[BSONDocument]

    Permalink
    Definition Classes
    BSONQueryBuilderGenericQueryBuilder
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  49. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. def [B](y: B): (BSONQueryBuilder, B)

    Permalink
    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

    Permalink

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