dropAllRolesFromDatabase

On this page

Definition

  • dropAllRolesFromDatabase
    • Deletes all user-defined roles on the database where you run the command.

Warning

The dropAllRolesFromDatabase removes all user-defined roles from the database.

The dropAllRolesFromDatabase command takes the following form:

{
  dropAllRolesFromDatabase: 1,
  writeConcern: { <write concern> }
}

The command has the following fields:

FieldTypeDescription
dropAllRolesFromDatabaseintegerSpecify 1 to drop all user-defined roles from the database where the command is run.
writeConcerndocumentOptional. The level of write concern for the removal operation. The writeConcern document takes the same fields as the getLastError command.

Required Access

You must have the dropRole action on a database to drop a role from that database.

Example

The following operations drop all user-defined roles from the products database:

use products
db.runCommand(
   {
     dropAllRolesFromDatabase: 1,
     writeConcern: { w: "majority" }
   }
)

The n field in the results document reports the number of roles dropped:

{ "n" : 4, "ok" : 1 }