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()
Linear Supertypes
Serializable, Product, Equals, GenericDB[BSONSerializationPack.type], DBMetaCommands, DB, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultDB
  2. Serializable
  3. Product
  4. Equals
  5. GenericDB
  6. DBMetaCommands
  7. DB
  8. AnyRef
  9. 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. type DBType = DefaultDB
    Definition Classes
    DefaultDB → DB

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DefaultDB toany2stringadd[DefaultDB] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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)

    Definition Classes
    DefaultDB → DB
  7. 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.

    // Equivalent to
db.abortTransaction(failIfNotStarted = false)
    returns

    The database reference with transaction aborted (but not session)

    Definition Classes
    DB
    Annotations
    @inline()
  8. def apply[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = collections.bson.BSONCollectionProducer): 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. 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
  11. def canEqual(that: Any): Boolean
    Definition Classes
    DefaultDB → Equals
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def collection[C <: Collection](name: String, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit producer: CollectionProducer[C] = collections.bson.BSONCollectionProducer): 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
  14. 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
  15. 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.

    returns

    The database reference with transaction commited (but not session)

    Definition Classes
    DefaultDB → DB
  16. 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.

    // Equivalent to
db.commitTransaction(failIfNotStarted = false)
    returns

    The database reference with transaction commited (but not session)

    Definition Classes
    DB
    Annotations
    @inline()
  17. 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.

    Definition Classes
    DefaultDB → DB
  18. val connectionState: ConnectionState

    The state of the associated connection

    The state of the associated connection

    Definition Classes
    DefaultDB → DB
  19. 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]

    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)

    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. SCRAM-SHA-1)

    Definition Classes
    DBMetaCommands
    See also

    https://docs.mongodb.com/manual/reference/command/createUser/

  20. def defaultReadPreference: ReadPreference
    Definition Classes
    DB
    Annotations
    @inline()
  21. def drop()(implicit ec: ExecutionContext): Future[Unit]

    Drops this database.

    Drops this database.

    Definition Classes
    DBMetaCommands
  22. 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

    Definition Classes
    DefaultDB → DB
  23. 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.

    // Equivalent to
db.endSession(failIfNotStarted = false)
    returns

    The database reference with session ended

    Definition Classes
    DB
    Annotations
    @inline()
  24. def ensuring(cond: (DefaultDB) => Boolean, msg: => Any): DefaultDB
    Implicit
    This member is added by an implicit conversion from DefaultDB toEnsuring[DefaultDB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: (DefaultDB) => Boolean): DefaultDB
    Implicit
    This member is added by an implicit conversion from DefaultDB toEnsuring[DefaultDB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean, msg: => Any): DefaultDB
    Implicit
    This member is added by an implicit conversion from DefaultDB toEnsuring[DefaultDB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: Boolean): DefaultDB
    Implicit
    This member is added by an implicit conversion from DefaultDB toEnsuring[DefaultDB] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  30. val failoverStrategy: FailoverStrategy

    A failover strategy for sending requests.

    A failover strategy for sending requests.

    Definition Classes
    DefaultDB → DB
  31. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  32. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DefaultDB toStringFormat[DefaultDB] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def indexesManager(implicit ec: ExecutionContext): IndexesManager

    Returns an index manager for this database.

    Returns an index manager for this database.

    Definition Classes
    DBMetaCommands
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. 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

    Definition Classes
    DefaultDB → DB
  38. 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.

    // Equivalent to
db.killSession(failIfNotStarted = false)
    returns

    The database reference with session aborted

    Definition Classes
    DB
    Annotations
    @inline()
  39. val name: String

    This database name.

    This database name.

    Definition Classes
    DefaultDB → DB
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. val pack: BSONSerializationPack.type
    Definition Classes
    DefaultDB → GenericDB
  44. 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
  45. def productElementName(n: Int): String
    Definition Classes
    Product
  46. def productElementNames: Iterator[String]
    Definition Classes
    Product
  47. def productIterator: Iterator[Any]
    Definition Classes
    Product
  48. def productPrefix: String
    Definition Classes
    Product
  49. def renameCollection[C <: Collection](db: String, from: String, to: String, dropExisting: Boolean = false, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext, producer: CollectionProducer[C] = collections.bson.BSONCollectionProducer): Future[C]

    Renames a collection.

    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
  50. 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
  51. 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
  52. 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
  53. def serverStatus(implicit ec: ExecutionContext): Future[ServerStatusResult]

    Returns the server status.

    Returns the server status.

    Definition Classes
    DBMetaCommands
  54. 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
  55. 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.

    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.

    Definition Classes
    DefaultDB → DB
  56. 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.

    // Equivalent to
db.startSession(failIfAlreadyStarted = false)
    returns

    The database reference updated with a new session

    Definition Classes
    DB
    Annotations
    @inline()
  57. 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.

    // Equivalent to
db.startTransaction(aWriteConcern, failIfAlreadyStarted = false)
    writeConcern

    the write concern for the transaction operation

    returns

    The database reference with transaction.

    Definition Classes
    DefaultDB → DB
  58. 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.

    // Equivalent to
db.startTransaction(aWriteConcern, failIfAlreadyStarted = false)
    writeConcern

    the write concern for the transaction operation

    returns

    The database reference with transaction.

    Definition Classes
    DB
    Annotations
    @inline()
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. def toString(): String
    Definition Classes
    DefaultDB → AnyRef → Any
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

  2. val productArity: Int
    Definition Classes
    DefaultDB → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.0) DefaultDB will no longer be a Product

  3. def productElement(n: Int): Any
    Definition Classes
    DefaultDB → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.0) DefaultDB will no longer be a Product

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

    Definition Classes
    DB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.0) Use sibling1

    See also

    sibling1

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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenericDB[BSONSerializationPack.type]

Inherited from DBMetaCommands

Inherited from DB

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDefaultDB to any2stringadd[DefaultDB]

Inherited by implicit conversion StringFormat fromDefaultDB to StringFormat[DefaultDB]

Inherited by implicit conversion Ensuring fromDefaultDB to Ensuring[DefaultDB]

Inherited by implicit conversion ArrowAssoc fromDefaultDB to ArrowAssoc[DefaultDB]

Ungrouped