Packages

case class BSONQueryBuilder(collection: Collection, failoverStrategy: 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

Annotations
@SerialVersionUID() @deprecated
Deprecated

(Since version 0.16.0) Useless, will be remove

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

Instance Constructors

  1. new BSONQueryBuilder(collection: Collection, failoverStrategy: 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)

Type Members

  1. type Self = BSONQueryBuilder
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder → QueryOps

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
    This member is added by an implicit conversion from BSONQueryBuilder toany2stringadd[BSONQueryBuilder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONQueryBuilder, B)
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toArrowAssoc[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 awaitData: Self

    Toggles AwaitData: Block a little while waiting for more data instead of returning immediately if no data.

    Toggles AwaitData: Block a little while waiting for more data instead of returning immediately if no data. Use along with TailableCursor.

    Definition Classes
    GenericQueryBuilder → QueryOps
  8. def batchSize(n: Int): Self

    Sets an upper limit on the number of documents to retrieve per batch.

    Sets an upper limit on the number of documents to retrieve per batch. Defaults to 0 (meaning no upper limit - MongoDB decides).

    Definition Classes
    GenericQueryBuilder → QueryOps
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  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, failoverStrategy: FailoverStrategy = failoverStrategy, maxTimeMsOption: Option[Long] = maxTimeMsOption): BSONQueryBuilder
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  14. def cursor[T](readPreference: ReadPreference = readPreference, isMongo26WriteOp: Boolean = false)(implicit reader: Reader[T], cp: CursorProducer[T]): ProducedCursor

    Returns a Cursor for the result of this query.

    Returns a Cursor for the result of this query.

    T

    the results type

    readPreference

    The reactivemongo.api.ReadPreference for this query. If the ReadPreference implies that this query can be run on a secondary, the slaveOk flag will be set.

    reader

    the reader for the results type

    Definition Classes
    GenericQueryBuilder
  15. def ensuring(cond: (BSONQueryBuilder) => Boolean, msg: => Any): BSONQueryBuilder
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toEnsuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (BSONQueryBuilder) => Boolean): BSONQueryBuilder
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toEnsuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): BSONQueryBuilder
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toEnsuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): BSONQueryBuilder
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toEnsuring[BSONQueryBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def exhaust: Self

    Toggles Exhaust

    Toggles Exhaust

    Definition Classes
    GenericQueryBuilder → QueryOps
  21. def explain(flag: Boolean = true): Self

    Toggles explain mode.

    Toggles explain mode.

    Definition Classes
    GenericQueryBuilder
  22. val explainFlag: Boolean
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  23. val failoverStrategy: FailoverStrategy
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  24. def filter(predicate: Document): Self

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Definition Classes
    GenericQueryBuilder
  25. def filter[Qry](predicate: Qry)(implicit writer: Writer[Qry]): Self

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Sets the query predicate; If unspecified, then all documents in the collection will match the predicate.

    Qry

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

    Definition Classes
    GenericQueryBuilder
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  27. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toStringFormat[BSONQueryBuilder] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. 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
  30. val hintOption: Option[BSONDocument]
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def maxTimeMs(p: Long): Self

    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
  33. val maxTimeMsOption: Option[Long]
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def noCursorTimeout: Self

    Toggles NoCursorTimeout: The cursor will not expire automatically

    Toggles NoCursorTimeout: The cursor will not expire automatically

    Definition Classes
    GenericQueryBuilder → QueryOps
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def one[T](readPreference: ReadPreference)(implicit reader: Reader[T], ec: ExecutionContext): Future[Option[T]]

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption).

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption).

    T

    the results type

    readPreference

    The reactivemongo.api.ReadPreference for this query. If the ReadPreference implies that this query can be run on a secondary, the slaveOk flag will be set.

    reader

    the reader for the results type

    Definition Classes
    GenericQueryBuilder
  39. def one[T](implicit reader: Reader[T], ec: ExecutionContext): Future[Option[T]]

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption).

    Sends this query and gets a future Option[T] (alias for reactivemongo.api.Cursor.headOption).

    T

    the results type

    reader

    the reader for the results type

    Definition Classes
    GenericQueryBuilder
  40. def oplogReplay: Self

    Toggles OplogReplay

    Toggles OplogReplay

    Definition Classes
    GenericQueryBuilder → QueryOps
  41. def options(options: QueryOpts): Self
    Definition Classes
    GenericQueryBuilder
  42. val options: QueryOpts
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  43. val pack: BSONSerializationPack.type
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  44. def partial: Self

    Toggles Partial: The response can be partial - if a shard is down, no error will be thrown.

    Toggles Partial: The response can be partial - if a shard is down, no error will be thrown.

    Definition Classes
    GenericQueryBuilder → QueryOps
  45. def productElementNames: Iterator[String]
    Definition Classes
    Product
  46. def projection(p: Document): Self

    Sets the projection specification to determine which fields to include in the returned documents.

    Sets the projection specification to determine which fields to include in the returned documents.

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

    Sets the projection specification to determine which fields to include in the returned documents.

    Sets the projection specification to determine which fields to include in the returned documents.

    Pjn

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

    Definition Classes
    GenericQueryBuilder
  48. val projectionOption: Option[BSONDocument]
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  49. val queryOption: Option[BSONDocument]
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  50. def readConcern: ReadConcern

    The read concern (since 3.2)

    The read concern (since 3.2)

    Definition Classes
    GenericQueryBuilder
  51. def requireOne[T](readPreference: ReadPreference)(implicit reader: Reader[T], ec: ExecutionContext): Future[T]

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head).

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head).

    T

    the results type

    readPreference

    The reactivemongo.api.ReadPreference for this query. If the ReadPreference implies that this query can be run on a secondary, the slaveOk flag will be set.

    reader

    the reader for the results type

    Definition Classes
    GenericQueryBuilder
  52. def requireOne[T](implicit reader: Reader[T], ec: ExecutionContext): Future[T]

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head).

    Sends this query and gets a future T (alias for reactivemongo.api.Cursor.head).

    T

    the results type

    reader

    the reader for the results type

    Definition Classes
    GenericQueryBuilder
  53. def skip(n: Int): Self

    Sets the number of documents to skip.

    Sets the number of documents to skip.

    Definition Classes
    GenericQueryBuilder → QueryOps
  54. def slaveOk: Self

    Toggles SlaveOk: The query is might be run on a secondary.

    Toggles SlaveOk: The query is might be run on a secondary.

    Definition Classes
    GenericQueryBuilder → QueryOps
  55. def snapshot(flag: Boolean = true): Self

    Toggles snapshot mode.

    Toggles snapshot mode.

    Definition Classes
    GenericQueryBuilder
  56. val snapshotFlag: Boolean
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  57. def sort(document: Document): Self

    Sets the sort specification for the ordering of the results.

    Sets the sort specification for the ordering of the results.

    Definition Classes
    GenericQueryBuilder
  58. val sortOption: Option[BSONDocument]
    Definition Classes
    BSONQueryBuilder → GenericQueryBuilder
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. def tailable: Self

    Toggles TailableCursor: Makes the cursor not to close after all the data is consumed.

    Toggles TailableCursor: Makes the cursor not to close after all the data is consumed.

    Definition Classes
    GenericQueryBuilder → QueryOps
  61. lazy val version: MongoWireVersion
    Attributes
    protected
    Definition Classes
    GenericQueryBuilder
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def query(selector: Document): Self
    Definition Classes
    GenericQueryBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.2) Use filter

  2. def query[Qry](selector: Qry)(implicit writer: Writer[Qry]): Self
    Definition Classes
    GenericQueryBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.2) Use filter

  3. def readPreference: ReadPreference

    The default ReadPreference

    The default ReadPreference

    Definition Classes
    GenericQueryBuilder
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.16.0) Internal: will be made private

  4. def updateOptions(update: (QueryOpts) => QueryOpts): Self
    Definition Classes
    GenericQueryBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.4) Use options or the separate query ops

  5. def →[B](y: B): (BSONQueryBuilder, B)
    Implicit
    This member is added by an implicit conversion from BSONQueryBuilder toArrowAssoc[BSONQueryBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenericQueryBuilder[BSONSerializationPack.type]

Inherited from QueryOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBSONQueryBuilder to any2stringadd[BSONQueryBuilder]

Inherited by implicit conversion StringFormat fromBSONQueryBuilder to StringFormat[BSONQueryBuilder]

Inherited by implicit conversion Ensuring fromBSONQueryBuilder to Ensuring[BSONQueryBuilder]

Inherited by implicit conversion ArrowAssoc fromBSONQueryBuilder to ArrowAssoc[BSONQueryBuilder]

Ungrouped