db.dropAllRoles()¶

On this page

Definition
Behavior
Required Access
Example

Definition¶

db.dropAllRoles(writeConcern)¶

Deletes all user-defined roles on the database where you run the method.

Warning

The dropAllRoles method removes all user-defined roles from the database.

Important

mongo Shell Method

This page documents a mongo method. This is not the documentation for database commands or language-specific drivers, such as Node.js. To use the database command, see the dropAllRolesFromDatabase command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

The db.dropAllRoles() method takes the following argument:

Field	Type	Description
`writeConcern`	document	Optional. The level of write concern for the removal operation. The `writeConcern` document takes the same fields as the `getLastError` command.

Returns:	The number of user-defined roles dropped.

Behavior¶

Replica set¶

If run on a replica set, db.dropAllRoles() is executed using "majority" write concern by default.

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 and uses a write concern of majority.

copy

use products
db.dropAllRoles( { w: "majority" } )

The method returns the number of roles dropped:

copy

← db.dropRole() db.getRole() →