setUserWriteBlockMode（数据库命令）

定义

setUserWriteBlockMode

6.0版本新增。

setUserWriteBlockMode命令会阻止和取消阻止对整个集群的写入。

During cluster synchronization, mongosync uses the setUserWriteBlockMode command to block writes on both the source and destination clusters. For more information, see the HTTP API start command.

如果您已经阻止了对副本集的写入，则如果指定的 reason 与您最初启用写入阻止时提供的原因不匹配，则后续使用 global: true 调用 setUserWriteBlockMode 会失败并显示 IllegalOperation 错误。错误消息包括当前原因和失败命令中指定的原因。分片集群不会实施此约束。

注意

具有bypassWriteBlockingMode特权的用户和应用程序可以绕过该阻止并继续执行写入。

兼容性

此命令可用于以下环境中托管的部署：

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

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

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

语法

该命令具有以下语法：

db.adminCommand(
   {
     setUserWriteBlockMode: 1,
     global: <boolean>,
     reason: <string>  // Optional
   }
)

命令字段

该命令接受以下字段：

必需的访问权限

要执行setUserWriteBlockMode命令，用户必须具有setUserWriteBlockMode特权。

例子

1. 启用用户写入阻止模式：

   db.adminCommand( {
      setUserWriteBlockMode: 1,
      global: true
   } )

2. 向collection添加一条记录：

   db.names.insertOne( { name: "George Washington Cable" } )

   服务器阻止写入，因为已启用用户写入阻止。

   示例输出：

   MongoServerError: User writes blocked

3. 禁用用户写入块模式：

   db.adminCommand( {
      setUserWriteBlockMode: 1,
      global: false
   } )

4. 向collection添加一条记录：

   db.names.insertOne( { name: "George Washington Cable" } )

   insertOne()方法可写入集合。 服务器允许写入，因为用户写入块已禁用。