Trait/Object

reactivemongo.api

DB

Related Docs: object DB | package api

Permalink

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

    Permalink
    Attributes
    protected

Abstract Value Members

  1. abstract def connection: MongoConnection

    Permalink

    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]

    Permalink

    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.

  3. abstract def failoverStrategy: FailoverStrategy

    Permalink

    A failover strategy for sending requests.

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

    Permalink

    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.

  5. abstract def name: String

    Permalink

    This database name.

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

    Permalink

    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.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

    Permalink

    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

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

    Permalink

    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

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

    Permalink

    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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

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

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

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

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

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

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

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

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

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

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

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

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

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

Deprecated Value Members

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

    Permalink

    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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DB to any2stringadd[DB]

Inherited by implicit conversion StringFormat from DB to StringFormat[DB]

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

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

Ungrouped