Class

reactivemongo.api.commands.CreateUserCommand

CreateUser

Related Doc: package CreateUserCommand

Permalink

case class CreateUser(name: String, pwd: Option[String], roles: List[UserRole], digestPassword: Boolean = true, writeConcern: Option[WriteConcern] = None, customData: Option[P.Document] = None) extends Command with CommandWithPack[P] with CommandWithResult[UnitBox.type] with Product with Serializable

The createUser command.

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CreateUser
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CommandWithResult
  7. CommandWithPack
  8. Command
  9. AbstractCommand
  10. AnyRef
  11. 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 CreateUser(name: String, pwd: Option[String], roles: List[UserRole], digestPassword: Boolean = true, writeConcern: Option[WriteConcern] = None, customData: Option[P.Document] = None)

    Permalink

    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

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 CreateUser to any2stringadd[CreateUser] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CreateUser, B)

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val customData: Option[P.Document]

    Permalink

    the custom data to associate with the user account

  9. val digestPassword: Boolean

    Permalink

    when true, the mongod instance will create the hash of the user password (default: true)

  10. def ensuring(cond: (CreateUser) ⇒ Boolean, msg: ⇒ Any): CreateUser

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  15. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val name: String

    Permalink

    the name of the user to be created

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. val pwd: Option[String]

    Permalink

    the user password (not required if the database uses external credentials)

  24. val roles: List[UserRole]

    Permalink

    the roles granted to the user, possibly an empty to create users without roles

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

    Permalink
    Definition Classes
    AnyRef
  26. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. val writeConcern: Option[WriteConcern]

    Permalink

    the optional level of write concern

  30. def [B](y: B): (CreateUser, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CommandWithResult[UnitBox.type]

Inherited from CommandWithPack[P]

Inherited from Command

Inherited from AbstractCommand

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CreateUser to any2stringadd[CreateUser]

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

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

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

Ungrouped