reactivemongo.api

DBMetaCommands

trait DBMetaCommands extends AnyRef

A mixin that provides commands about this database itself.

Self Type
DBMetaCommands with DB
Annotations
@deprecated
Deprecated

(Since version 0.19.8) Internal: will be made private

Linear Supertypes
AnyRef, Any
Known Subclasses
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

Type Members

  1. type DBMetaWriter[T] = BSONDocumentWriter[T]

    Type of writer to serialization database metadata

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.

    Returns the names of the collections in this database.

    import scala.concurrent.{ ExecutionContext, Future }
    import reactivemongo.api.DefaultDB
    
    def listCollections(db: DefaultDB)(
      implicit ec: ExecutionContext): Future[List[String]] =
      db.collectionNames
  11. def createUser[T](user: String, pwd: Option[String], customData: Option[T], roles: List[UserRole], digestPassword: Boolean, writeConcern: commands.WriteConcern, restrictions: List[AuthenticationRestriction], mechanisms: List[AuthenticationMode])(implicit ec: ExecutionContext, w: (DBMetaCommands.this)#DBMetaWriter[T]): Future[Unit]

    Create the user with given properties.

    Create the user with given properties.

    import scala.concurrent.{ ExecutionContext, Future }
    
    import reactivemongo.api.{
      DefaultDB,
      ScramSha256Authentication,
      ScramSha1Authentication,
      WriteConcern
    }
    import reactivemongo.api.commands.UserRole
    
    def createReadWriteUser(db: DefaultDB, name: String)(
      implicit ec: ExecutionContext): Future[Unit] =
      db.createUser(
        user = name,
        pwd = None, // no initial password
        customData = None, // no custom data
        roles = List(UserRole("readWrite")),
        digestPassword = true,
        writeConcern = WriteConcern.Default,
        restrictions = List.empty,
        mechanisms = List(
          ScramSha1Authentication, ScramSha256Authentication))
    T

    the type of custom data associated with the created 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. ScramSha1Authentication)

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

    Drops this database.

    Drops this database.

    import scala.concurrent.{ ExecutionContext, Future }
    import reactivemongo.api.DefaultDB
    
    def dropDB(db: DefaultDB)(
      implicit ec: ExecutionContext): Future[Unit] = db.drop()
  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.

    Returns an index manager for this database.

    import scala.concurrent.{ ExecutionContext, Future }
    
    import reactivemongo.api.DefaultDB
    import reactivemongo.api.indexes.NSIndex
    
    def listIndexes(db: DefaultDB)(
      implicit ec: ExecutionContext): Future[List[String]] =
      db.indexesManager.list().map(_.flatMap { ni: NSIndex =>
        ni.index.name.toList
      })
  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.

    returns

    true if successful (even if the server is write locked)

    Since

    MongoDB 3.0

    import scala.concurrent.{ ExecutionContext, Future }
    import reactivemongo.api.DefaultDB
    
    def pingDB(db: DefaultDB)(
      implicit ec: ExecutionContext): Future[Boolean] =
      db.ping() // with default ReadPreference
  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.

    import scala.concurrent.{ ExecutionContext, Future }
    import reactivemongo.api.DefaultDB
    
    def addCollSuffix(
      admin: DefaultDB,
      coll: String,
      suffix: String)(implicit ec: ExecutionContext): Future[Unit] =
      admin.renameCollection("myDB", coll, coll + suffix).map(_ => {})
    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. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. 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 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]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) Use createUser with DBMetaWriter

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.4) Use createUser with complete authentication options

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

    Returns the server status.

    Returns the server status.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.4) Will be removed (not maintained): use db.runCommand(BSONDocument("serverStatus" -> 1) with custom reader

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

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