reactivemongo.api

DefaultDB

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( 235871232L )
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DefaultDB
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. GenericDB
  7. DBMetaCommands
  8. DB
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type DBType = DefaultDB

    Definition Classes
    DefaultDBDB

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from DefaultDB to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (DefaultDB, B)

    Implicit information
    This member is added by an implicit conversion from DefaultDB to ArrowAssoc[DefaultDB] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. 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
  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( ... )
  13. 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
  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. 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
    DefaultDBDB
  16. val connectionState: ConnectionState

    The state of the associated connection

    The state of the associated connection

    Definition Classes
    DefaultDBDB
  17. 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/

  18. def defaultReadPreference: ReadPreference

    Definition Classes
    DB
    Annotations
    @inline()
  19. def drop()(implicit ec: ExecutionContext): Future[Unit]

    Drops this database.

    Drops this database.

    Definition Classes
    DBMetaCommands
  20. def endSession()(implicit ec: ExecutionContext): Future[DefaultDB]

    Ends the session associated with this database reference, if any otherwise does nothing (since MongoDB 3.

    Ends the session associated with this database reference, if any otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

    Definition Classes
    DefaultDBDB
  21. def ensuring(cond: (DefaultDB) ⇒ Boolean, msg: ⇒ Any): DefaultDB

    Implicit information
    This member is added by an implicit conversion from DefaultDB to Ensuring[DefaultDB] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (DefaultDB) ⇒ Boolean): DefaultDB

    Implicit information
    This member is added by an implicit conversion from DefaultDB to Ensuring[DefaultDB] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): DefaultDB

    Implicit information
    This member is added by an implicit conversion from DefaultDB to Ensuring[DefaultDB] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): DefaultDB

    Implicit information
    This member is added by an implicit conversion from DefaultDB to Ensuring[DefaultDB] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  27. val failoverStrategy: FailoverStrategy

    A failover strategy for sending requests.

    A failover strategy for sending requests.

    Definition Classes
    DefaultDBDB
  28. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from DefaultDB to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  32. def indexesManager(implicit ec: ExecutionContext): IndexesManager

    Returns an index manager for this database.

    Returns an index manager for this database.

    Definition Classes
    DBMetaCommands
  33. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  34. def killSession()(implicit ec: ExecutionContext): Future[DefaultDB]

    Kills the session (abort) associated with this database reference, if any otherwise does nothing (since MongoDB 3.

    Kills the session (abort) associated with this database reference, if any otherwise does nothing (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

    Definition Classes
    DefaultDBDB
  35. val name: String

    This database name.

    This database name.

    Definition Classes
    DefaultDBDB
  36. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  39. val pack: BSONSerializationPack.type

    Definition Classes
    DefaultDB → GenericDB
  40. 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
  41. def productIterator: Iterator[Any]

    Definition Classes
    Product
  42. def productPrefix: String

    Definition Classes
    Product
  43. 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.

    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
  44. 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
  45. 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
  46. 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
  47. def serverStatus(implicit ec: ExecutionContext): Future[ServerStatusResult]

    Returns the server status.

    Returns the server status.

    Definition Classes
    DBMetaCommands
  48. val session: Option[Session]

    Definition Classes
    DefaultDBDB
  49. 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
  50. def startSession()(implicit ec: ExecutionContext): Future[DefaultDB]

    Starts a new session, does nothing if a session has already being started (since MongoDB 3.

    Starts a new session, does nothing if a session has already being started (since MongoDB 3.6).

    EXPERIMENTAL: API may change without notice.

    Definition Classes
    DefaultDBDB
  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  52. def toString(): String

    Definition Classes
    AnyRef → Any
  53. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. def [B](y: B): (DefaultDB, B)

    Implicit information
    This member is added by an implicit conversion from DefaultDB to ArrowAssoc[DefaultDB] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from DefaultDB 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:
    (defaultDB: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from DefaultDB 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:
    (defaultDB: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. val productArity: Int

    Definition Classes
    DefaultDB → Product
    Annotations
    @deprecated
    Deprecated

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

  2. def productElement(n: Int): Any

    Definition Classes
    DefaultDB → Product
    Annotations
    @deprecated
    Deprecated

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

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

  4. def x: DefaultDB

    Implicit information
    This member is added by an implicit conversion from DefaultDB to ArrowAssoc[DefaultDB] 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:
    (defaultDB: ArrowAssoc[DefaultDB]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  5. def x: DefaultDB

    Implicit information
    This member is added by an implicit conversion from DefaultDB to Ensuring[DefaultDB] 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:
    (defaultDB: Ensuring[DefaultDB]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

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 from DefaultDB to StringAdd

Inherited by implicit conversion any2stringfmt from DefaultDB to StringFormat

Inherited by implicit conversion any2ArrowAssoc from DefaultDB to ArrowAssoc[DefaultDB]

Inherited by implicit conversion any2Ensuring from DefaultDB to Ensuring[DefaultDB]

Ungrouped