Database Manual / Reference / Database Commands / Role Management

dropAllRolesFromDatabase (database command数据库命令)

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.dropAllRolesFromDatabase从数据库中删除所有用户定义的角色。

Tip

In mongosh, this command can also be run through the db.dropAllRoles() helper method.在mongosh中，此命令也可以通过db.dropAllRoles()辅助方法运行。

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. 助手方法对mongosh用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。 In cases where the convenience is not needed or the additional return fields are required, use the database command.如果不需要便利性或需要额外的返回字段，请使用database命令。

Compatibility兼容性

This command is available in deployments hosted in the following environments:此命令在以下环境中托管的部署中可用：

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud：云中MongoDB部署的完全托管服务

Important

This command is not supported in M0 and Flex clusters. For more information, see Unsupported Commands.M0和Flex集群不支持此命令。有关详细信息，请参阅不支持的命令。

  • MongoDB Enterprise: The subscription-based, self-managed version of MongoDB：MongoDB的基于订阅的自我管理版本
  • MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB：MongoDB的源代码可用、免费使用和自我管理版本

Syntax语法

The command has the following syntax:该命令具有以下语法：

db.runCommand(
   {
     dropAllRolesFromDatabase: 1,
     writeConcern: { <write concern> },
     comment: <any>
   }
)

Command Fields命令字段

The command has the following fields:该命令包含以下字段：

Field字段Type类型Description描述
dropAllRolesFromDatabaseinteger整数Specify 1 to drop all user-defined roles from the database where the command is run.指定1可从运行命令的数据库中删除所有用户定义的角色。
writeConcerndocument文档/includes/source/fact-write-concern-spec-link.rst
commentany任意

Optional. 可选。A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:用户提供了要附加到此命令的注释。设置后，此注释将与此命令的记录一起出现在以下位置：

A comment can be any valid BSON type (string, integer, object, array, etc).注释可以是任何有效的BSON类型（字符串、整数、对象、数组等）。

Required Access所需访问权限

You must have the dropRole action on a database to drop a role from that database.您必须对数据库执行dropRole操作，才能从该数据库中删除角色。

Example示例

The following operations drop all user-defined roles from the products database:以下操作将从products数据库中删除所有用户定义的角色：

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

The n field in the results document reports the number of roles dropped:结果文档中的n字段报告了删除的角色数：

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