reactivemongo.api

DBMetaCommands

trait DBMetaCommands extends AnyRef

A mixin that provides commands about this database itself.

Self Type
DBMetaCommands with DB
Linear Supertypes
AnyRef, Any
Known Subclasses
DefaultDB
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DBMetaCommands
  2. AnyRef
  3. 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

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 DBMetaCommands to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (DBMetaCommands, B)

    Implicit information
    This member is added by an implicit conversion from DBMetaCommands to ArrowAssoc[DBMetaCommands] 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

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

    Returns the names of the collections in this database.

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

    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

    See also

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

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

    Drops this database.

  13. def ensuring(cond: (DBMetaCommands) ⇒ Boolean, msg: ⇒ Any): DBMetaCommands

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

  14. def ensuring(cond: (DBMetaCommands) ⇒ Boolean): DBMetaCommands

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

  15. def ensuring(cond: Boolean, msg: ⇒ Any): DBMetaCommands

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

  16. def ensuring(cond: Boolean): DBMetaCommands

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

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

    Definition Classes
    AnyRef

  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  19. def finalize(): Unit

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

  20. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Returns an index manager for this database.

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  28. 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)

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

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

    Returns the server status.

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

    Definition Classes
    AnyRef

  32. def toString(): String

    Definition Classes
    AnyRef → Any

  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. def →[B](y: B): (DBMetaCommands, B)

    Implicit information
    This member is added by an implicit conversion from DBMetaCommands to ArrowAssoc[DBMetaCommands] 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 DBMetaCommands 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:
    (dBMetaCommands: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

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

Deprecated Value Members

  1. def x: DBMetaCommands

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DBMetaCommands

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DBMetaCommands to StringAdd

Inherited by implicit conversion any2stringfmt from DBMetaCommands to StringFormat

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

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

Ungrouped