class DefaultDB extends DB with DBMetaCommands with GenericDB[Pack] with Product with Serializable
The default DB implementation, that mixes in the database traits.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- DefaultDB
- Serializable
- Product
- Equals
- GenericDB
- DBMetaCommands
- DB
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- type DBMetaWriter[T] = BSONDocumentWriter[T]
Type of writer to serialization database metadata
Type of writer to serialization database metadata
- Definition Classes
- DBMetaCommands
- type DBType = DefaultDB
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): (DefaultDB, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def abortTransaction(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]
Aborts the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
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)
- final def abortTransaction()(implicit ec: ExecutionContext): Future[DBType]
Aborts the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
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)
- Definition Classes
- DB
- Annotations
- @inline()
- def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = Serialization.defaultCollectionProducer): 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
- Definition Classes
- DB
- 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
- Definition Classes
- DB
- See also
MongoConnection.authenticate
- def canEqual(that: Any): Boolean
- Definition Classes
- DefaultDB → Equals
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def collection[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = Serialization.defaultCollectionProducer): 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")
- Definition Classes
- DB
- def collectionNames(implicit ec: ExecutionContext): Future[List[String]]
Returns the names of the collections in this database.
Returns the names of the collections in this database.
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.DefaultDB def listCollections(db: DefaultDB)( implicit ec: ExecutionContext): Future[List[String]] = db.collectionNames
- Definition Classes
- DBMetaCommands
- def commitTransaction(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]
Commits the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
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)
- final def commitTransaction()(implicit ec: ExecutionContext): Future[DBType]
Commits the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .
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)
- Definition Classes
- DB
- Annotations
- @inline()
- val 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.
- val connectionState: ConnectionState
The state of the associated connection
The state of the associated connection
- def createUser[T](user: String, pwd: Option[String], customData: Option[T], roles: List[UserRole], digestPassword: Boolean, writeConcern: commands.WriteConcern, restrictions: List[AuthenticationRestriction], mechanisms: List[AuthenticationMode])(implicit ec: ExecutionContext, w: DBMetaWriter[T]): Future[Unit]
Create the user with given properties.
Create the user with given properties.
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.{ DefaultDB, ScramSha256Authentication, ScramSha1Authentication, WriteConcern } import reactivemongo.api.commands.UserRole def createReadWriteUser(db: DefaultDB, name: String)( implicit ec: ExecutionContext): Future[Unit] = db.createUser( user = name, pwd = None, // no initial password customData = None, // no custom data roles = List(UserRole("readWrite")), digestPassword = true, writeConcern = WriteConcern.Default, restrictions = List.empty, mechanisms = List( ScramSha1Authentication, ScramSha256Authentication))
- T
the type of custom data associated with the created user
- user
the name of the user to be created
- pwd
the user password (not required if the database uses external credentials)
- customData
the custom data to associate with the user account
- roles
the roles granted to the user, possibly an empty to create users without roles
- digestPassword
when true, the mongod instance will create the hash of the user password (default:
true
)- writeConcern
the optional level of write concern
- restrictions
the authentication restriction
- mechanisms
the authentication mechanisms (e.g. ScramSha1Authentication)
- Definition Classes
- DBMetaCommands
- def drop()(implicit ec: ExecutionContext): Future[Unit]
Drops this database.
Drops this database.
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.DefaultDB def dropDB(db: DefaultDB)( implicit ec: ExecutionContext): Future[Unit] = db.drop()
- Definition Classes
- DBMetaCommands
- def endSession(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DefaultDB]
Ends (closes) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
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
- final def endSession()(implicit ec: ExecutionContext): Future[DBType]
Ends (closes) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
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
- Definition Classes
- DB
- Annotations
- @inline()
- def ensuring(cond: (DefaultDB) => Boolean, msg: => Any): DefaultDB
- def ensuring(cond: (DefaultDB) => Boolean): DefaultDB
- def ensuring(cond: Boolean, msg: => Any): DefaultDB
- def ensuring(cond: Boolean): DefaultDB
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val failoverStrategy: FailoverStrategy
A failover strategy for sending requests.
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def indexesManager(implicit ec: ExecutionContext): Aux[Pack]
Returns an index manager for this database.
Returns an index manager for this database.
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.DefaultDB import reactivemongo.api.indexes.NSIndex def listIndexes(db: DefaultDB)( implicit ec: ExecutionContext): Future[List[String]] = db.indexesManager.list().map(_.flatMap { ni: NSIndex => ni.index.name.toList })
- Definition Classes
- DBMetaCommands
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def killSession(failIfNotStarted: Boolean)(implicit ec: ExecutionContext): Future[DefaultDB]
Kills (aborts) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
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
- final def killSession()(implicit ec: ExecutionContext): Future[DBType]
Kills (aborts) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .
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
- Definition Classes
- DB
- Annotations
- @inline()
- val name: String
This database name.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val pack: Pack
- Definition Classes
- DefaultDB → GenericDB
- def ping(readPreference: ReadPreference = ReadPreference.nearest)(implicit ec: ExecutionContext): Future[Boolean]
Tests if the server, resolved according to the given read preference, responds to commands.
Tests if the server, resolved according to the given read preference, responds to commands.
- returns
true if successful (even if the server is write locked)
- Definition Classes
- DBMetaCommands
- Since
MongoDB 3.0
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.DefaultDB def pingDB(db: DefaultDB)( implicit ec: ExecutionContext): Future[Boolean] = db.ping() // with default ReadPreference
- def productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- Product
- def renameCollection[C <: Collection](db: String, from: String, to: String, dropExisting: Boolean = false, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext, producer: CollectionProducer[C] = Serialization.defaultCollectionProducer): Future[C]
Renames a collection. Can only be executed if the this database reference is the
admin
one.import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.DefaultDB def addCollSuffix( admin: DefaultDB, coll: String, suffix: String)(implicit ec: ExecutionContext): Future[Unit] = admin.renameCollection("myDB", coll, coll + suffix).map(_ => {})
- db
the name of the database where the collection exists with the
current
name- from
the current name of the collection, in the specified
db
- to
the new name of this collection (inside the same
db
)- dropExisting
If a collection of name
to
already exists, then drops that collection before renaming this one.- returns
a failure if the dropExisting option is false and the target collection already exists
- Definition Classes
- DBMetaCommands
- def runCommand(command: Document, failoverStrategy: FailoverStrategy): CursorFetcher[pack.type, Cursor]
Run a raw command (represented by a document).
Run a raw command (represented by a document).
import reactivemongo.api.FailoverStrategy import reactivemongo.api.bson.BSONDocument def getUsers(db: reactivemongo.api.DefaultDB) = db.runCommand(BSONDocument("usersInfo" -> 1), FailoverStrategy.default)
- command
the command to be executed on the current database
- failoverStrategy
the failover strategy to override the default one
- returns
A cursor for the command results
- Definition Classes
- GenericDB
- def runCommand[C <: Command](command: C, failoverStrategy: FailoverStrategy)(implicit writer: Writer[C]): CursorFetcher[pack.type, Cursor]
- C
the reactivemongo.api.commands.Command type
- command
the command to be executed on the current database
- failoverStrategy
the failover strategy to override the default one
- writer
the writer for the command
- returns
A cursor for the command results
- Definition Classes
- GenericDB
- def runCommand[R, C <: Command with CommandWithResult[R]](command: C with CommandWithResult[R], failoverStrategy: FailoverStrategy)(implicit writer: Writer[C], reader: Reader[R], ec: ExecutionContext): Future[R]
- R
the result type
- C
the reactivemongo.api.commands.Command type
- command
the command to be executed on the current database
- failoverStrategy
the failover strategy to override the default one
- writer
the writer for the command
- reader
the reader for the result of command execution
- returns
A single result from command execution
- Definition Classes
- GenericDB
- def runValueCommand[A <: AnyVal, R <: BoxedAnyVal[A], C <: Command with CommandWithResult[R]](command: C with CommandWithResult[R with BoxedAnyVal[A]], failoverStrategy: FailoverStrategy, readPreference: ReadPreference)(implicit writer: Writer[C], reader: Reader[R], ec: ExecutionContext): Future[A]
- R
the result type
- C
the reactivemongo.api.commands.Command type
- command
the command to be executed on the current database
- failoverStrategy
the failover strategy to override the default one
- writer
the writer for the command
- reader
the reader for the result of command execution
- returns
A single result from command execution
- Definition Classes
- GenericDB
- def startSession(failIfAlreadyStarted: Boolean)(implicit ec: ExecutionContext): Future[DefaultDB]
Starts a new session (since MongoDB 3.6).
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.
- final def startSession()(implicit ec: ExecutionContext): Future[DBType]
Starts a new session (since MongoDB 3.6), does nothing if a session has already being started .
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
- Definition Classes
- DB
- Annotations
- @inline()
- def startTransaction(writeConcern: Option[WriteConcern], failIfAlreadyStarted: Boolean)(implicit ec: ExecutionContext): Future[DBType]
Starts a transaction (since MongoDB 4.0), if none is already started with the current client session otherwise does nothing.
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.
- final def startTransaction(writeConcern: Option[WriteConcern])(implicit ec: ExecutionContext): Future[DBType]
Starts a transaction (since MongoDB 4.0), if none is already started with the current client session otherwise does nothing.
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.
- Definition Classes
- DB
- Annotations
- @inline()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- DefaultDB → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def createUser(user: String, pwd: Option[String], customData: Option[BSONDocument], roles: List[UserRole], digestPassword: Boolean, writeConcern: commands.WriteConcern, restrictions: List[AuthenticationRestriction], mechanisms: List[AuthenticationMode])(implicit ec: ExecutionContext): Future[Unit]
- Definition Classes
- DBMetaCommands
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.1) Use
createUser
withDBMetaWriter
- def createUser(user: String, pwd: Option[String], roles: List[UserRole], digestPassword: Boolean = true, writeConcern: commands.WriteConcern = connection.options.writeConcern, customData: Option[BSONDocument] = None)(implicit ec: ExecutionContext): Future[Unit]
- Definition Classes
- DBMetaCommands
- Annotations
- @deprecated
- Deprecated
(Since version 0.18.4) Use
createUser
with complete authentication options
- def defaultReadPreference: ReadPreference
- Definition Classes
- DB
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 0.19.4) Internal: will be made private
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
- val productArity: Int
- Definition Classes
- DefaultDB → Product
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) DefaultDB will no longer be a Product
- def productElement(n: Int): Any
- Definition Classes
- DefaultDB → Product
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) DefaultDB will no longer be a Product
- def serverStatus(implicit ec: ExecutionContext): Future[ServerStatusResult]
Returns the server status.
Returns the server status.
- Definition Classes
- DBMetaCommands
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.4) Will be removed (not maintained): use
db.runCommand(BSONDocument("serverStatus" -> 1)
with custom reader
- def sibling(name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext): DefaultDB
Returns the database of the given name on the same MongoConnection.
- 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
- Definition Classes
- DB
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.4) Use
connection.database(name)
- def →[B](y: B): (DefaultDB, B)
- Implicit
- This member is added by an implicit conversion from DefaultDB toArrowAssoc[DefaultDB] 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.