GenericQueryBuilder

Type Members

abstract type Self <: GenericQueryBuilder[pack.type]

Abstract Value Members

abstract def collection: Collection
abstract def commentString: Option[String]
abstract def copy(queryOption: Option[P.Document] = queryOption, sortOption: Option[P.Document] = sortOption, projectionOption: Option[P.Document] = projectionOption, hintOption: Option[P.Document] = hintOption, explainFlag: Boolean = explainFlag, snapshotFlag: Boolean = snapshotFlag, commentString: Option[String] = commentString, options: QueryOpts = options, failover: FailoverStrategy = failover, maxTimeMsOption: Option[Long] = maxTimeMsOption): Self
abstract def explainFlag: Boolean
abstract def failover: FailoverStrategy
abstract def hintOption: Option[P.Document]
abstract def maxTimeMsOption: Option[Long]
abstract def options: QueryOpts
abstract val pack: P
abstract def projectionOption: Option[P.Document]
abstract def queryOption: Option[P.Document]
abstract def snapshotFlag: Boolean
abstract def sortOption: Option[P.Document]
abstract def merge(readPreference: ReadPreference): P.Document

Annotations
@deprecated
Deprecated
(Since version 0.12.0) Will be removed from the public API

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (GenericQueryBuilder[P], B)

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to ArrowAssoc[GenericQueryBuilder[P]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def comment(message: String): Self

Adds a comment to this query, that may appear in the MongoDB logs.
def cursor[T](readPreference: ReadPreference = ReadPreference.primary, isMongo26WriteOp: Boolean = false)(implicit reader: P.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.
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
def ensuring(cond: (GenericQueryBuilder[P]) ⇒ Boolean, msg: ⇒ Any): GenericQueryBuilder[P]

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (GenericQueryBuilder[P]) ⇒ Boolean): GenericQueryBuilder[P]

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): GenericQueryBuilder[P]

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): GenericQueryBuilder[P]

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def explain(flag: Boolean = true): Self

Toggles explain mode.
def finalize(): Unit

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

Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Sets the hint document (a document that declares the index MongoDB should use for this query).
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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/
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def one[T](readPreference: ReadPreference)(implicit reader: P.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
def one[T](implicit reader: P.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
def options(options: QueryOpts): Self
def projection(p: P.Document): Self

Sets the projection document (for retrieving only a subset of fields).
def projection[Pjn](p: Pjn)(implicit writer: P.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.
def query(selector: P.Document): Self

Sets the query (the selector document).
def query[Qry](selector: Qry)(implicit writer: P.Writer[Qry]): Self

Sets the selector document.
Sets the selector document.
Qry
The type of the query. An implicit Writer[Qry] typeclass for handling it has to be in the scope.
def requireOne[T](readPreference: ReadPreference)(implicit reader: P.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
def requireOne[T](implicit reader: P.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
def snapshot(flag: Boolean = true): Self

Toggles snapshot mode.
def sort(document: P.Document): Self

Sets the sorting document.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def updateOptions(update: (QueryOpts) ⇒ QueryOpts): Self

Returns a builder with the options updated.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (GenericQueryBuilder[P], B)

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

Shadowed Implicit Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] 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
val self: Any
Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] 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

def cursor[T](implicit reader: P.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.

Annotations
@deprecated
Deprecated
(Since version 0.11.0) Use cursor() or cursor(readPreference)
def x: GenericQueryBuilder[P]
Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to ArrowAssoc[GenericQueryBuilder[P]] 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[P]]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: GenericQueryBuilder[P]
Implicit information
This member is added by an implicit conversion from GenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]] 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[P]]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

trait GenericQueryBuilder[P <: SerializationPack] extends AnyRef

Type Members

abstract type Self <: GenericQueryBuilder[pack.type]

Abstract Value Members

abstract def collection: Collection

abstract def commentString: Option[String]

abstract def explainFlag: Boolean

abstract def failover: FailoverStrategy

abstract def hintOption: Option[P.Document]

abstract def maxTimeMsOption: Option[Long]

abstract def options: QueryOpts

abstract val pack: P

abstract def projectionOption: Option[P.Document]

abstract def queryOption: Option[P.Document]

abstract def snapshotFlag: Boolean

abstract def sortOption: Option[P.Document]

abstract def merge(readPreference: ReadPreference): P.Document

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (GenericQueryBuilder[P], B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def comment(message: String): Self

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

def ensuring(cond: (GenericQueryBuilder[P]) ⇒ Boolean, msg: ⇒ Any): GenericQueryBuilder[P]

def ensuring(cond: (GenericQueryBuilder[P]) ⇒ Boolean): GenericQueryBuilder[P]

def ensuring(cond: Boolean, msg: ⇒ Any): GenericQueryBuilder[P]

def ensuring(cond: Boolean): GenericQueryBuilder[P]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explain(flag: Boolean = true): Self

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

def hint(document: P.Document): Self

final def isInstanceOf[T0]: Boolean

def maxTimeMs(p: Long): Self

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def one[T](readPreference: ReadPreference)(implicit reader: P.Reader[T], ec: ExecutionContext): Future[Option[T]]

def one[T](implicit reader: P.Reader[T], ec: ExecutionContext): Future[Option[T]]

def options(options: QueryOpts): Self

def projection(p: P.Document): Self

def projection[Pjn](p: Pjn)(implicit writer: P.Writer[Pjn]): Self

def query(selector: P.Document): Self

def query[Qry](selector: Qry)(implicit writer: P.Writer[Qry]): Self

def requireOne[T](readPreference: ReadPreference)(implicit reader: P.Reader[T], ec: ExecutionContext): Future[T]

def requireOne[T](implicit reader: P.Reader[T], ec: ExecutionContext): Future[T]

def snapshot(flag: Boolean = true): Self

def sort(document: P.Document): Self

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

def toString(): String

def updateOptions(update: (QueryOpts) ⇒ QueryOpts): Self

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (GenericQueryBuilder[P], B)

Shadowed Implicit Value Members

val self: Any

val self: Any

Deprecated Value Members

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

def x: GenericQueryBuilder[P]

def x: GenericQueryBuilder[P]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GenericQueryBuilder[P] to StringAdd

Inherited by implicit conversion any2stringfmt from GenericQueryBuilder[P] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GenericQueryBuilder[P] to ArrowAssoc[GenericQueryBuilder[P]]

Inherited by implicit conversion any2Ensuring from GenericQueryBuilder[P] to Ensuring[GenericQueryBuilder[P]]

Ungrouped