trait DBMetaCommands extends AnyRef
A mixin that provides commands about this database itself.
- Self Type
- DBMetaCommands with DB
- Alphabetic
- By Inheritance
- DBMetaCommands
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- type DBMetaWriter[T] = BSONDocumentWriter[T]
Type of writer to serialization database metadata
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toany2stringadd[DBMetaCommands] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DBMetaCommands, B)
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toArrowAssoc[DBMetaCommands] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def collectionNames(implicit ec: ExecutionContext): Future[List[String]]
Returns the names of the collections in this database.
- 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 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)
- See also
https://docs.mongodb.com/manual/reference/command/createUser/
- def drop()(implicit ec: ExecutionContext): Future[Unit]
Drops this database.
- def ensuring(cond: (DBMetaCommands) => Boolean, msg: => Any): DBMetaCommands
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toEnsuring[DBMetaCommands] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DBMetaCommands) => Boolean): DBMetaCommands
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toEnsuring[DBMetaCommands] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DBMetaCommands
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toEnsuring[DBMetaCommands] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DBMetaCommands
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toEnsuring[DBMetaCommands] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toStringFormat[DBMetaCommands] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def indexesManager(implicit ec: ExecutionContext): IndexesManager
Returns an index manager for this database.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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)
- def renameCollection[C <: Collection](db: String, from: String, to: String, dropExisting: Boolean = false, failoverStrategy: FailoverStrategy = failoverStrategy)(implicit ec: ExecutionContext, producer: CollectionProducer[C] = Serialization.defaultCollectionProducer): Future[C]
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
- def serverStatus(implicit ec: ExecutionContext): Future[ServerStatusResult]
Returns the server status.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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
withDBMetaWriter
- 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
- def →[B](y: B): (DBMetaCommands, B)
- Implicit
- This member is added by an implicit conversion from DBMetaCommands toArrowAssoc[DBMetaCommands] 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.