Database Manual / Reference / Database Commands / Role Management

dropRole (database command数据库命令)

Definition定义

dropRole

Deletes a user-defined role from the database on which you run the command.从运行命令的数据库中删除用户定义的角色。

Tip

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

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.如果不需要便利性或需要额外的返回字段，请使用数据库命令。

Compatibility兼容性

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

  • 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的源代码可用、免费使用和自我管理版本

Important

This command is not supported in MongoDB Atlas clusters. MongoDB Atlas集群不支持此命令。For information on Atlas support for all commands, see Unsupported Commands.有关Atlas支持所有命令的信息，请参阅不支持的命令。

Syntax语法

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

db.runCommand(
   {
     dropRole: "<role>",
     writeConcern: { <write concern> },
     comment: <any>
   }
)

Command Fields命令字段

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

Field字段Type类型Description描述
dropRolestring字符串The name of the user-defined role to remove from the database.要从数据库中删除的用户定义角色的名称。
writeConcerndocument文档Optional. 可选。The level of write concern for the operation. 操作的写入关注级别。See Write Concern Specification.请参阅写入关注规范。
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类型（字符串、整数、对象、数组等）。

Behavior行为

Authentication认证

When a role is dropped on a mongod, previously authenticated users remain logged in to the database but immediately lose the role's privileges.当一个角色在mongod上被删除时，之前经过身份验证的用户仍会登录到数据库，但会立即失去该角色的权限。

When a role is dropped on a mongos, previously authenticated users remain logged in to the database but lose the role's privileges when the cache refreshes. 当在mongos上删除角色时，以前经过身份验证的用户仍会登录到数据库，但在缓存刷新时会失去角色的权限。The cache refreshes automatically after the time specified with the userCacheInvalidationIntervalSecs parameter or manually when you run the invalidateUserCache command.在使用userCacheInvalidationIntervalSecs参数指定的时间之后，缓存会自动刷新，或者在运行invalidateUserCache命令时手动刷新。

Required Access所需访问权限

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

Example示例

The following operations remove the readPrices role from the products database:以下操作将从products数据库中删除readPrices角色：

use products
db.runCommand(
   {
     dropRole: "readPrices",
     writeConcern: { w: "majority" }
   }
)