db.updateRole()

定义

db.updateRole( rolename, update, writeConcern )

更新用户定义的角色。 db.updateRole()方法必须在角色的数据库上运行。

重要

mongosh 方法

本页面提供 mongosh 方法的相关信息。这不是数据库命令或特定语言驱动程序（例如 Node.js）的相关文档。

有关数据库命令，请参阅 updateRole 命令。

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

对字段的更新将完全替换先前字段的值。要在不替换所有值的情况下授予或删除角色或权限，请使用以下一种或多种方法：

• db.grantRolesToRole()

• db.grantPrivilegesToRole()

• db.revokeRolesFromRole()

• db.revokePrivilegesFromRole()

警告

对 privileges 或 roles 数组的更新将完全替换先前数组的值。

db.updateRole() 方法使用以下语法：

db.updateRole(
    "<rolename>",
    {
      privileges:
          [
            { resource: { <resource> }, actions: [ "<action>", ... ] },
            ...
          ],
      roles:
          [
            { role: "<role>", db: "<database>" } | "<role>",
            ...
          ],
      authenticationRestrictions:
          [
            {
              clientSource: ["<IP>" | "<CIDR range>", ...],
              serverAddress: ["<IP>", | "<CIDR range>", ...]
            },
            ...
          ]
    },
    { <writeConcern> }
)

db.updateRole() 方法接受以下参数：

Parameter	类型	说明
rolename	字符串	要更新的用户定义角色的名称。
update	文档	一份包含该角色替换数据的文档。该数据完全替代该角色的相应数据。
writeConcern	文档	可选。操作的写关注级别。请参阅写关注规范。

update 文档指定了要更新的字段及其新值。update 文档中的每个字段都是可选的，但该文档必须至少包含一个字段。update 文档包含以下字段：

字段	类型	说明
privileges	阵列	可选。如果未指定 roles 数组，则为必填项。授予角色的权限。privileges数组的更新会覆盖之前数组的值。有关指定权限的语法，请参阅 privileges 数组。
roles	阵列	可选。如果未指定 privileges 数组，则为必填项。此角色从中继承权限的角色。roles 数组的更新会覆盖之前数组的值。
authenticationRestrictions	阵列	可选。 服务器对角色实施的身份验证限制。指定允许授予此角色的用户连接和/或可以从中进行连接的 IP 地址和 CIDR 范围的列表。

db.updateRole() 方法封装了 updateRole 命令。

兼容性

此方法可用于以下环境中托管的部署：

• MongoDB Atlas ：用于在云中部署 MongoDB 的完全托管服务

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

"readWrite"

{ role: "<role>", db: "<database>" }

行为

必需的访问权限

必须对所有数据库执行 revokeRole 操作才能更新角色。

您必须对 roles 数组中的每个角色的数据库执行 grantRole 操作才能更新该数组。

您必须对 privileges 数组中的每个权限的数据库执行 grantRole 操作才能更新该数组。如果权限的资源跨越数据库，则在 admin 数据库上必须有 grantRole。如果权限为以下任一权限，则该权限将跨越数据库：

• 所有数据库中的一个集合

• 所有集合和所有数据库

• cluster 资源

您必须对目标角色的数据库执行 setAuthenticationRestriction 操作，才能更新角色的 authenticationRestrictions 文档。

例子

以下 db.updateRole() 方法替换了 products 数据库中存在的 inventoryControl 角色的 privileges 和 roles。该方法在包含 inventoryControl 的数据库上运行：

use products
db.updateRole(
    "inventoryControl",
    {
      privileges:
          [
            {
              resource: { db:"products", collection:"clothing" },
              actions: [ "update", "createCollection", "createIndex"]
            }
          ],
      roles:
          [
            {
              role: "read",
              db: "products"
            }
          ]
    },
    { w:"majority" }
)

要查看某个角色的权限，请使用 rolesInfo 命令。