reactivemongo.api

DB

sealed trait DB extends AnyRef

The reference to a MongoDB database, obtained from a reactivemongo.api.MongoConnection.

You should consider the provided reactivemongo.api.DefaultDB implementation.

import reactivemongo.api._

val connection = MongoConnection(List("localhost:27017"))
val db = connection.database("plugin")
val collection = db.map(_("acoll"))
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DB
  2. AnyRef
  3. 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

Type Members

  1. abstract type DBType <: DB

    Attributes
    protected

Abstract Value Members

  1. abstract def connection: MongoConnection

    The reactivemongo.api.MongoConnection that will be used to query this database.

    The reactivemongo.api.MongoConnection that will be used to query this database.

    Annotations
    @transient()
  2. abstract def endSession()(implicit ec: ExecutionContext): Future[DBType]

    Ends the session associated with this database reference, if any otherwise does nothing (since MongoDB 3.

    Ends the session associated with this database reference, if any otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

  3. abstract def failoverStrategy: FailoverStrategy

    A failover strategy for sending requests.

  4. abstract def killSession()(implicit ec: ExecutionContext): Future[DBType]

    Kills the session (abort) associated with this database reference, if any otherwise does nothing (since MongoDB 3.

    Kills the session (abort) associated with this database reference, if any otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

  5. abstract def name: String

    This database name.

  6. abstract def startSession()(implicit ec: ExecutionContext): Future[DBType]

    Starts a new session, does nothing if a session has already being started (since MongoDB 3.

    Starts a new session, does nothing if a session has already being started (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

Concrete 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 DB to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (DB, B)

    Implicit information
    This member is added by an implicit conversion from DB to ArrowAssoc[DB] 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. def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

    Returns a reactivemongo.api.Collection from this database (alias for the collection method).

    Returns a reactivemongo.api.Collection from this database (alias for the collection method).

    name

    the name of the collection to resolve

    failoverStrategy

    the failover strategy to override the default one

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def authenticate(user: String, password: String)(implicit ec: ExecutionContext): Future[SuccessfulAuthentication]

    Authenticates the connection on this database.

    Authenticates the connection on this database.

    user

    the name of the user

    password

    the user password

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def collection[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

    Returns a reactivemongo.api.Collection from this database.

    Returns a reactivemongo.api.Collection from this database.

    name

    the name of the collection to resolve

    failoverStrategy

    the failover strategy to override the default one

  13. def defaultReadPreference: ReadPreference

    Annotations
    @inline()
  14. def ensuring(cond: (DB) ⇒ Boolean, msg: ⇒ Any): DB

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  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 DB to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. def sibling1(name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext): Future[DefaultDB]

    Returns the database of the given name on the same MongoConnection.

    Returns the database of the given name on the same MongoConnection.

    name

    the name of the collection to resolve

    failoverStrategy

    the failover strategy to override the default one

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

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (DB, B)

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

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

Deprecated Value Members

  1. def sibling(name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext): DefaultDB

    Returns the database of the given name on the same MongoConnection.

    Returns the database of the given name on the same MongoConnection.

    name

    the name of the collection to resolve

    failoverStrategy

    the failover strategy to override the default one

    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.0) Use sibling1

    See also

    sibling1

  2. def x: DB

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

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: DB

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DB to StringAdd

Inherited by implicit conversion any2stringfmt from DB to StringFormat

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

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

Ungrouped