setClusterParameter
定义
setClusterParameter
setClusterParameter
是用于修改集群参数值的管理命令。集群参数是可配置的参数,会影响副本集或分片集群中的所有节点。您必须对
admin
数据库发出setClusterParameter
命令。setClusterParameter
命令仅在自托管安装中可用。setClusterParameter
命令在 MongoDB Atlas 中不可用。
兼容性
此命令可用于以下环境中托管的部署:
MongoDB Atlas:用于云中 MongoDB 部署的完全托管服务
注意
所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息,请参阅不支持的命令。
MongoDB Enterprise:基于订阅、自我管理的 MongoDB 版本
MongoDB Community:源代码可用、免费使用且可自行管理的 MongoDB 版本
语法
db.adminCommand( { setClusterParameter: { <parameter>: <value> } } )
有关可用的集群参数(包括示例),请参阅用于自我托管部署的集群参数。
行为
您只能在
admin
数据库上运行setClusterParameter
。 如果在任何其他数据库上运行该命令,MongoDB 都会返回错误。您只能在副本集主节点或分片集群上运行
setClusterParameter
。您无法在独立运行的实例部署上运行
setClusterParameter
。setClusterParameter
一次仅接受一个参数。
访问控制
启用身份验证后, setClusterParameter
仅当用户身份验证为具有有权访问setClusterParameter
操作的角色时才起作用。
持久性
使用setClusterParameter
所做的参数修改会保留在副本集和分片集群上。 这可确保使用setClusterParameter
所做的参数修改在重启后仍然有效。
Stable API
当使用 apiStrict 设置为 true
的Stable API V1 时,将无法使用 setClusterParameter
来修改集群参数。