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
AnyRef, Any
Known Subclasses
DefaultDB
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DB
  2. AnyRef
  3. 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

Type Members

  1. abstract type DBType <: DB
    Attributes
    protected

Abstract Value Members

  1. abstract def abortTransaction()(implicit ec: ExecutionContext): Future[Option[DBType]]

    Ends the transaction associated with the current client session, if any otherwise does nothing (since MongoDB 3.6).

    Ends the transaction associated with the current client session, if any otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

    returns

    None if there is no session/transaction to abort or Some database reference with transaction aborted (but not session)

  2. abstract def commitTransaction()(implicit ec: ExecutionContext): Future[Option[DBType]]

    Ends the transaction associated with the current client session, if any otherwise does nothing (since MongoDB 3.6).

    Ends the transaction associated with the current client session, if any otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

    returns

    None if there is no session/transaction to abort or Some database reference with transaction aborted (but not session)

  3. 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()
  4. abstract def endSession()(implicit ec: ExecutionContext): Future[Option[DBType]]

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

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

    EXPERIMENTAL: API may change without notice.

    returns

    None if there is no session to end or Some database reference with session ended

  5. abstract def failoverStrategy: FailoverStrategy

    A failover strategy for sending requests.

  6. 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.6).

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

    EXPERIMENTAL: API may change without notice.

    returns

    None if there is no session to kill or Some database reference with session aborted

  7. abstract def name: String

    This database name.

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

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

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

    EXPERIMENTAL: API may change without notice.

    returns

    None if session is already started, or Some database reference updated with a new session

  9. abstract def startTransaction(writeConcern: Option[WriteConcern]): Option[DBType]

    Starts a transaction if none is already started with the current client session, otherwise does nothing (since MongoDB 3.6).

    Starts a transaction if none is already started with the current client session, otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

    returns

    None if there is no session/transaction to abort or Some database reference with transaction aborted (but not session)

Concrete 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 DB toany2stringadd[DB] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DB, B)
    Implicit
    This member is added by an implicit conversion from DB toArrowAssoc[DB] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = collections.bson.BSONCollectionProducer): 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

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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

  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def collection[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = collections.bson.BSONCollectionProducer): 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

  11. def defaultReadPreference: ReadPreference
    Annotations
    @inline()
  12. def ensuring(cond: (DB) => Boolean, msg: => Any): DB
    Implicit
    This member is added by an implicit conversion from DB toEnsuring[DB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (DB) => Boolean): DB
    Implicit
    This member is added by an implicit conversion from DB toEnsuring[DB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): DB
    Implicit
    This member is added by an implicit conversion from DB toEnsuring[DB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): DB
    Implicit
    This member is added by an implicit conversion from DB toEnsuring[DB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DB toStringFormat[DB] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. 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

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

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 →[B](y: B): (DB, B)
    Implicit
    This member is added by an implicit conversion from DB toArrowAssoc[DB] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDB to any2stringadd[DB]

Inherited by implicit conversion StringFormat fromDB to StringFormat[DB]

Inherited by implicit conversion Ensuring fromDB to Ensuring[DB]

Inherited by implicit conversion ArrowAssoc fromDB to ArrowAssoc[DB]

Ungrouped