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"))
- Alphabetic
- By Inheritance
- DB
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
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()
-
abstract
def
endSession()(implicit ec: ExecutionContext): Future[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.
-
abstract
def
failoverStrategy: FailoverStrategy
A failover strategy for sending requests.
-
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.
-
abstract
def
name: String
This database name.
-
abstract
def
startSession()(implicit ec: ExecutionContext): Future[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.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (DB, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
collectionmethod).Returns a reactivemongo.api.Collection from this database (alias for the
collectionmethod).- name
the name of the collection to resolve
- failoverStrategy
the failover strategy to override the default one
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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
-
def
defaultReadPreference: ReadPreference
- Annotations
- @inline()
- def ensuring(cond: (DB) ⇒ Boolean, msg: ⇒ Any): DB
- def ensuring(cond: (DB) ⇒ Boolean): DB
- def ensuring(cond: Boolean, msg: ⇒ Any): DB
- def ensuring(cond: Boolean): DB
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
- @native() @throws( ... )
- def →[B](y: B): (DB, B)
Deprecated Value Members
-
def
sibling(name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext): DefaultDB
Returns the database of the given name on the same MongoConnection.