reactivemongo.api.commands.CreateUserCommand

CreateUser

case class CreateUser(name: String, pwd: Option[String], roles: List[UserRole], digestPassword: Boolean = true, writeConcern: Option[WriteConcern] = scala.None, customData: Option[P.Document] = scala.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
Serializable, Serializable, Product, Equals, CommandWithResult[UnitBox.type], CommandWithPack[P], Command, AbstractCommand, AnyRef, Any
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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CreateUser(name: String, pwd: Option[String], roles: List[UserRole], digestPassword: Boolean = true, writeConcern: Option[WriteConcern] = scala.None, customData: Option[P.Document] = scala.None)

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

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

    Implicit information
    This member is added by an implicit conversion from CreateUser to ArrowAssoc[CreateUser] 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. val customData: Option[P.Document]

    the custom data to associate with the user account

  11. val digestPassword: Boolean

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

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

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

  13. def ensuring(cond: (CreateUser) ⇒ Boolean): CreateUser

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

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

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

  15. def ensuring(cond: Boolean): CreateUser

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

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

    Definition Classes
    AnyRef

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. val name: String

    the name of the user to be created

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

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. val pwd: Option[String]

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

  26. val roles: List[UserRole]

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

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

    Definition Classes
    AnyRef

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. val writeConcern: Option[WriteConcern]

    the optional level of write concern

  32. def →[B](y: B): (CreateUser, B)

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

  2. val self: Any

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

Deprecated Value Members

  1. def x: CreateUser

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: CreateUser

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

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from CreateUser to StringFormat

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

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

Ungrouped