DB - ReactiveMongo API 0.20 - reactivemongo.api.DB

Type Members

abstract type DBType <: DB

Attributes
protected

Abstract Value Members

abstract def abortTransaction(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Aborts the transaction associated with the current client session (since MongoDB 4.
Aborts the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
returns
The database reference with transaction aborted (but not session)
abstract def commitTransaction(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Commits the transaction associated with the current client session (since MongoDB 4.
Commits the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def commitIt(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.commitTransaction(failIfNotStarted = true)
```
returns
The database reference with transaction commited (but not session)
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(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Ends (closes) the session associated with this database reference (since MongoDB 3.
Ends (closes) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
returns
The database reference with session ended
abstract def failoverStrategy: FailoverStrategy

A failover strategy for sending requests.
abstract def killSession(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Kills (aborts) the session associated with this database reference (since MongoDB 3.
Kills (aborts) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
returns
The database reference with session aborted
abstract def name: String

This database name.
abstract def startSession(failIfAlreadyStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Starts a new session (since MongoDB 3.
Starts a new session (since MongoDB 3.6).
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def startIt(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.startSession(failIfAlreadyStarted = true)
```
failIfAlreadyStarted
if true fails if a session is already started
returns
The database reference updated with a new session, if none is already started with the current reference.
abstract def startTransaction(writeConcern: Option[WriteConcern], failIfAlreadyStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Starts a transaction (since MongoDB 4.
Starts a transaction (since MongoDB 4.0), if none is already started with the current client session otherwise does nothing.
It fails if no session is previously started (see startSession).
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.{ DefaultDB, WriteConcern }

def doIt(db: DefaultDB, aWriteConcern: Option[WriteConcern])(
  implicit ec: ExecutionContext) =
  db.startTransaction(aWriteConcern, failIfAlreadyStarted = true)
```
writeConcern
the write concern for the transaction operation
returns
The database reference with transaction.

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 DB to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
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()
final def ==(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def abortTransaction()(implicit ec: ExecutionContext): Future[DBType]

Aborts the transaction associated with the current client session (since MongoDB 4.
Aborts the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def equivalentTo(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.abortTransaction(failIfNotStarted = false)
```
returns
The database reference with transaction aborted (but not session)

Annotations
@inline()
def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

Returns a reactivemongo.api.Collection reference from this database (alias for the collection method).
Returns a reactivemongo.api.Collection reference from this database (alias for the collection method).
C
the Collection type
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

See also
MongoConnection.authenticate
def clone(): AnyRef

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

Returns a reactivemongo.api.Collection reference from this database.
Returns a reactivemongo.api.Collection reference from this database.
C
the Collection type
name
the name of the collection to resolve
failoverStrategy
the failover strategy to override the default one
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def resoleColl(db: DB)(implicit ec: ExecutionContext) =
  db.collection("acoll")
```
final def commitTransaction()(implicit ec: ExecutionContext): Future[DBType]

Commits the transaction associated with the current client session (since MongoDB 4.
Commits the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def equivalentTo(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.commitTransaction(failIfNotStarted = false)
```
returns
The database reference with transaction commited (but not session)

Annotations
@inline()
final def endSession()(implicit ec: ExecutionContext): Future[DBType]

Ends (closes) the session associated with this database reference (since MongoDB 3.
Ends (closes) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def equivalentTo(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.endSession(failIfNotStarted = false)
```
returns
The database reference with session ended

Annotations
@inline()
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
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
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
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
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

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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def killSession()(implicit ec: ExecutionContext): Future[DBType]

Kills (aborts) the session associated with this database reference (since MongoDB 3.
Kills (aborts) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def equivalentTo(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.killSession(failIfNotStarted = false)
```
returns
The database reference with session aborted

Annotations
@inline()
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def startSession()(implicit ec: ExecutionContext): Future[DBType]

Starts a new session (since MongoDB 3.
Starts a new session (since MongoDB 3.6), does nothing if a session has already being started .
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.DefaultDB

def equivalentTo(db: DefaultDB)(implicit ec: ExecutionContext) =
  db.startSession(failIfAlreadyStarted = false)
```
returns
The database reference updated with a new session

Annotations
@inline()
final def startTransaction(writeConcern: Option[WriteConcern])(implicit ec: ExecutionContext): Future[DBType]

Starts a transaction (since MongoDB 4.
Starts a transaction (since MongoDB 4.0), if none is already started with the current client session otherwise does nothing.
It fails if no session is previously started (see startSession).
EXPERIMENTAL: API may change without notice.
```
import scala.concurrent.ExecutionContext
import reactivemongo.api.{ DefaultDB, WriteConcern }

def equivalentTo(db: DefaultDB, aWriteConcern: Option[WriteConcern])(
  implicit ec: ExecutionContext) =
  db.startTransaction(aWriteConcern, failIfAlreadyStarted = false)
```
writeConcern
the write concern for the transaction operation
returns
The database reference with transaction.

Annotations
@inline()
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
@throws( ... )
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

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

def defaultReadPreference: ReadPreference

Annotations
@deprecated @inline()
Deprecated
(Since version 0.19.4) Internal: will be made private
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
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

Annotations
@deprecated
Deprecated
(Since version 0.19.4) Use connection.database(name)
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
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

DB

sealed trait DB extends AnyRef

Type Members

abstract type DBType <: DB

Abstract Value Members

abstract def abortTransaction(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

abstract def commitTransaction(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

abstract def connection: MongoConnection

abstract def endSession(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

abstract def failoverStrategy: FailoverStrategy

abstract def killSession(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

abstract def name: String

abstract def startSession(failIfAlreadyStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

abstract def startTransaction(writeConcern: Option[WriteConcern], failIfAlreadyStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DB, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def abortTransaction()(implicit ec: ExecutionContext): Future[DBType]

def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

final def asInstanceOf[T0]: T0

def authenticate(user: String, password: String)(implicit ec: ExecutionContext): Future[SuccessfulAuthentication]

def clone(): AnyRef

def collection[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): C

final def commitTransaction()(implicit ec: ExecutionContext): Future[DBType]

final def endSession()(implicit ec: ExecutionContext): Future[DBType]

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

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def killSession()(implicit ec: ExecutionContext): Future[DBType]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def startSession()(implicit ec: ExecutionContext): Future[DBType]

final def startTransaction(writeConcern: Option[WriteConcern])(implicit ec: ExecutionContext): Future[DBType]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (DB, B)

Shadowed Implicit Value Members

val self: Any

val self: Any

Deprecated Value Members

def defaultReadPreference: ReadPreference

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

def sibling1(name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext): Future[DefaultDB]

def x: DB

def x: DB

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