class DefaultDB extends DB with DBMetaCommands with GenericDB[BSONSerializationPack.type] with Product with Serializable
The default DB implementation, that mixes in the database traits.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- DefaultDB
- Serializable
- Serializable
- Product
- Equals
- GenericDB
- DBMetaCommands
- DB
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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
apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = ...): 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
- 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
-
def
canEqual(that: Any): Boolean
- Definition Classes
- DefaultDB → Equals
-
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
- 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.
- Definition Classes
- DBMetaCommands
-
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(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]
Create the specified user.
Create the specified user.
- user
the name of the user to be created
- pwd
the user password (not required if the database uses external credentials)
- 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
- customData
the custom data to associate with the user account
- Definition Classes
- DBMetaCommands
- See also
https://docs.mongodb.com/manual/reference/command/createUser/
-
def
defaultReadPreference: ReadPreference
- Definition Classes
- DB
- Annotations
- @inline()
-
def
drop()(implicit ec: ExecutionContext): Future[Unit]
Drops this database.
Drops this database.
- Definition Classes
- DBMetaCommands
-
def
endSession()(implicit ec: ExecutionContext): Future[DefaultDB]
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.
- 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: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
failoverStrategy: FailoverStrategy
A failover strategy for sending requests.
-
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()
-
def
indexesManager(implicit ec: ExecutionContext): IndexesManager
Returns an index manager for this database.
Returns an index manager for this database.
- Definition Classes
- DBMetaCommands
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
killSession()(implicit ec: ExecutionContext): Future[DefaultDB]
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.
-
val
name: String
This database name.
-
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()
-
val
pack: BSONSerializationPack.type
- 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. (since MongoDB 3.0)
- returns
true if successful (even if the server is write locked)
- Definition Classes
- DBMetaCommands
-
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] = ...): Future[C]
Renames a collection. Can only be executed if the this database reference is the
admin
one.- 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[C <: Command](command: C, failoverStrategy: FailoverStrategy)(implicit writer: Writer[C]): CursorFetcher[pack.type, Cursor]
- failoverStrategy
the failover strategy to override the default one
- 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]
- failoverStrategy
the failover strategy to override the default one
- 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]
- failoverStrategy
the failover strategy to override the default one
- Definition Classes
- GenericDB
-
def
serverStatus(implicit ec: ExecutionContext): Future[ServerStatusResult]
Returns the server status.
Returns the server status.
- Definition Classes
- DBMetaCommands
- val session: Option[Session]
-
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
-
def
startSession()(implicit ec: ExecutionContext): Future[DefaultDB]
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.
-
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): (DefaultDB, B)
Deprecated Value Members
-
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
sibling(name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext): DefaultDB
Returns the database of the given name on the same MongoConnection.