Class

reactivemongo.api

DefaultDB

Related Doc: package api

Permalink

case class DefaultDB(name: String, connection: MongoConnection, failoverStrategy: FailoverStrategy = FailoverStrategy()) 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, Serializable, Product, Equals, GenericDB[BSONSerializationPack.type], DBMetaCommands, DB, AnyRef, Any
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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultDB(name: String, connection: MongoConnection, failoverStrategy: FailoverStrategy = FailoverStrategy())

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

  4. def ->[B](y: B): (DefaultDB, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DefaultDB to ArrowAssoc[DefaultDB] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

    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

    Definition Classes
    DB

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def authenticate(user: String, password: String)(implicit timeout: FiniteDuration): Future[SuccessfulAuthentication]

    Permalink

    Authenticates the connection on this database.

    Authenticates the connection on this database.

    Definition Classes
    DB

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink

    Returns a reactivemongo.api.Collection from this database.

    Returns a reactivemongo.api.Collection from this database.

    name

    the name of the collection to resolve

    Definition Classes
    DB

  11. def collectionNames(implicit ec: ExecutionContext): Future[List[String]]

    Permalink

    Returns the names of the collections in this database.

    Returns the names of the collections in this database.

    Definition Classes
    DBMetaCommands

  12. val connection: MongoConnection

    Permalink

    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

  13. def createUser(name: String, pwd: Option[String], roles: List[UserRole], digestPassword: Boolean = true, writeConcern: WriteConcern = connection.options.writeConcern, customData: Option[BSONDocument] = None)(implicit ec: ExecutionContext): Future[Unit]

    Permalink

    Create the specified user.

    Create the specified user.

    name

    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/

  14. def defaultReadPreference: ReadPreference

    Permalink
    Definition Classes
    DB
    Annotations
    @inline()

  15. def drop()(implicit ec: ExecutionContext): Future[Unit]

    Permalink

    Drops this database.

    Drops this database.

    Definition Classes
    DBMetaCommands

  16. def ensuring(cond: (DefaultDB) ⇒ Boolean, msg: ⇒ Any): DefaultDB

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

  17. def ensuring(cond: (DefaultDB) ⇒ Boolean): DefaultDB

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

  18. def ensuring(cond: Boolean, msg: ⇒ Any): DefaultDB

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

  19. def ensuring(cond: Boolean): DefaultDB

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

  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. val failoverStrategy: FailoverStrategy

    Permalink

    A failover strategy for sending requests.

    A failover strategy for sending requests.

    Definition Classes
    DefaultDB → DB

  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  23. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DefaultDB to StringFormat[DefaultDB] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  25. def indexesManager(implicit ec: ExecutionContext): IndexesManager

    Permalink

    Returns an index manager for this database.

    Returns an index manager for this database.

    Definition Classes
    DBMetaCommands

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  27. val name: String

    Permalink

    This database name.

    This database name.

    Definition Classes
    DefaultDB → DB

  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  31. val pack: BSONSerializationPack.type

    Permalink
    Definition Classes
    DefaultDB → GenericDB

  32. def renameCollection[C <: Collection](db: String, from: String, to: String, dropExisting: Boolean = false, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext, producer: CollectionProducer[C] = ...): Future[C]

    Permalink

    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

    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

  33. def runCommand[C <: Command](command: C, failoverStrategy: FailoverStrategy)(implicit writer: Writer[C]): CursorFetcher[pack.type, Cursor]

    Permalink
    Definition Classes
    GenericDB

  34. 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]

    Permalink
    Definition Classes
    GenericDB

  35. 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]

    Permalink
    Definition Classes
    GenericDB

  36. def serverStatus(implicit ec: ExecutionContext): Future[ServerStatusResult]

    Permalink

    Returns the server status.

    Returns the server status.

    Definition Classes
    DBMetaCommands

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

    Permalink

    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

    Definition Classes
    DB
    See also

    sibling1

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

    Permalink

    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

    Definition Classes
    DB

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

    Permalink
    Definition Classes
    AnyRef

  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. def →[B](y: B): (DefaultDB, B)

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

Deprecated Value Members

  1. def command[T](command: Command[T], readPreference: ReadPreference = defaultReadPreference)(implicit ec: ExecutionContext): Future[T]

    Permalink

    Sends a command and get the future result of the command.

    Sends a command and get the future result of the command.

    command

    the command to send

    readPreference

    the ReadPreference to use for this command (defaults to MongoConnectionOptions.readPreference)

    returns

    a future containing the result of the command.

    Definition Classes
    DB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.0) Consider using reactivemongo.api.commands along with DefaultDB.runCommand methods

  2. def runCommand[C <: Command](command: C)(implicit writer: Writer[C]): CursorFetcher[pack.type, Cursor]

    Permalink
    Definition Classes
    GenericDB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC0) Use runCommand with the failoverStrategy parameter

  3. def runCommand[R, C <: Command with CommandWithResult[R]](command: C with CommandWithResult[R])(implicit writer: Writer[C], reader: Reader[R], ec: ExecutionContext): Future[R]

    Permalink
    Definition Classes
    GenericDB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC0) Use runCommand with the failoverStrategy parameter

  4. def runValueCommand[A <: AnyVal, R <: BoxedAnyVal[A], C <: Command with CommandWithResult[R]](command: C with CommandWithResult[R with BoxedAnyVal[A]], failoverStrategy: FailoverStrategy)(implicit writer: Writer[C], reader: Reader[R], ec: ExecutionContext): Future[A]

    Permalink
    Definition Classes
    GenericDB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC5) Use the alternative with ReadPreference

  5. def runValueCommand[A <: AnyVal, R <: BoxedAnyVal[A], C <: Command with CommandWithResult[R]](command: C with CommandWithResult[R with BoxedAnyVal[A]])(implicit writer: Writer[C], reader: Reader[R], ec: ExecutionContext): Future[A]

    Permalink
    Definition Classes
    GenericDB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC0) Use runValueCommand with the failoverStrategy parameter

  6. def runner: CommandWithPackRunner[pack.type]

    Permalink
    Definition Classes
    GenericDB
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12-RC0) Either use one of the runX function on the DB instance, or use reactivemongo.api.commands.Command.run directly

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 any2stringadd[DefaultDB]

Inherited by implicit conversion StringFormat from DefaultDB to StringFormat[DefaultDB]

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

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

Ungrouped