定义
setClusterParametersetClusterParameteris an administrative command for modifying values of cluster parameters. Cluster parameters are configurable parameters which affect all nodes in a replica set or sharded cluster.您必须对
admin数据库发出setClusterParameter命令。
兼容性
此命令可用于以下环境中托管的部署:
MongoDB Enterprise:基于订阅、自我管理的 MongoDB 版本
MongoDB Community:源代码可用、免费使用且可自行管理的 MongoDB 版本
重要
MongoDB Atlas 集群不支持此命令。有关 Atlas 对所有命令的支持的信息,请参阅不支持的命令。
语法
db.adminCommand( { setClusterParameter: { <parameter>: <value> } } )
有关可用的集群参数(包括示例),请参阅用于自我托管部署的集群参数。
行为
您只能在
admin数据库上运行setClusterParameter。 如果在任何其他数据库上运行该命令,MongoDB 都会返回错误。您只能在副本集主节点或分片集群上运行
setClusterParameter。您无法在独立运行的实例部署上运行
setClusterParameter。setClusterParameter一次仅接受一个参数。
访问控制
启用身份验证后, setClusterParameter仅当用户身份验证为具有有权访问setClusterParameter操作的角色时才起作用。
持久性
使用setClusterParameter所做的参数修改会保留在副本集和分片集群上。 这可确保使用setClusterParameter所做的参数修改在重启后仍然有效。
Stable API
When using Stable API V1 with apiStrict set to true, you cannot use setClusterParameter to modify cluster parameters.