Docs Menu

Docs HomeMongoDB Manual

setUserWriteBlockMode

On this page

  • Definition
  • Syntax
  • Command Fields
  • Required Access
  • Example
setUserWriteBlockMode

New in version 6.0.

The setUserWriteBlockMode command blocks and unblocks writes to the entire cluster.

During cluster-to-cluster sync, mongosync, the cluster-to-cluster synchronization tool, uses the setUserWriteBlockMode command to block writes on the destination cluster. For more information, see the HTTP API start command.

Note

Users and applications with the bypassWriteBlockingMode privilege can bypass the block and continue to perform writes.

The command has the following syntax:

db.adminCommand(
{
setUserWriteBlockMode: 1,
global: <boolean>
}
)

The command takes the following fields:

Field
Type
Description
setUserWriteBlockMode
integer
Set this field to 1.
global
boolean
Blocks writes on a cluster when set to true. To enable writes on a cluster, set global: false.

To execute the setUserWriteBlockMode command, the user must have the setUserWriteBlockMode privilege.

  1. Enable user write block mode:

    db.adminCommand( {
    setUserWriteBlockMode: 1,
    global: true
    } )
  2. Add a record to the collection:

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

    The server blocks the write because the user write block is enabled.

    Example Output:

    MongoServerError: User writes blocked
  3. Disable user write block mode:

    db.adminCommand( {
    setUserWriteBlockMode: 1,
    global: false
    } )
  4. Add a record to the collection:

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

    The insertOne() method writes to a collection. The server allows the write because the user write block is disabled.

←  setDefaultRWConcernshutdown →
Share Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.