/ /

Administración

Docs Home

Desarrollo

Comandos de base de datos

Administración

Docs Home

Desarrollo

Comandos de base de datos

Administración

setUserWriteBlockMode (comando de base de datos)

Definición

setUserWriteBlockMode

Novedades en la versión 6.0.

El comando setUserWriteBlockMode bloquea y desbloquea la escritura en todo el clúster.

Durante la sincronización de clúster a clúster, mongosync, la herramienta de Cluster-to-Cluster Sync, utiliza el comando setUserWriteBlockMode para bloquear las escrituras en el clúster de destino. Para obtener más información, consulta la API HTTP comando de inicio.

Si ya bloqueaste las escrituras en un set de réplicas, las llamadas posteriores a setUserWriteBlockMode con global: true fallarán con un error IllegalOperation si el reason especificado no coincide con el motivo que proporcionaste al habilitar inicialmente el bloqueo de escrituras. El mensaje de error incluye tanto el motivo actual como el motivo especificado en el comando fallido. Los clústeres fragmentados no aplican esta restricción.

Nota

Usuarios y aplicaciones con el bypassWriteBlockingMode el privilegio puede eludir el bloqueo y continuar realizando guardados.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Importante

Este comando no es compatible con los clústeres M0 y Flex. Para obtener más información, consulta Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

El comando tiene la siguiente sintaxis:

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

Campos de comandos

El comando toma los siguientes campos:

Campo	Tipo	Descripción
`setUserWriteBlockMode`	entero	Establece este campo a `1`.
`global`	booleano	Bloquea las escrituras en un clúster cuando se establece en `true`. Para habilitar las escrituras en un clúster, establezca `global: false`.
`reason`	string	opcional. Especifica el motivo para bloquear los guardados. Acepta los siguientes valores: `"Unspecified"` - Por defecto cuando no proporcionas ningún motivo. `"ClusterToClusterMigrationInProgress"` - Indica escrituras bloqueadas debido a la migración en curso de un clúster a otro. `"DiskUseThresholdExceeded"` - Indica operaciones de guardado bloqueadas porque el uso del disco ha superado un umbral.

Acceso requerido

Para ejecutar el comando setUserWriteBlockMode, el usuario debe tener el setUserWriteBlockMode privilegio.

Ejemplo

Habilitar el modo de bloque de escritura de usuario:
```
db.adminCommand( {
   setUserWriteBlockMode: 1,
   global: true
} )
```
Añada un registro a la colección:
```
db.names.insertOne( { name: "George Washington Cable" } )
```
El servidor bloquea la escritura porque el bloqueo de escritura del usuario está habilitado.
Ejemplo de salida:
```
MongoServerError: User writes blocked
```
Deshabilitar el modo de bloqueo de escritura de usuario:
```
db.adminCommand( {
   setUserWriteBlockMode: 1,
   global: false
} )
```
Añada un registro a la colección:
```
db.names.insertOne( { name: "George Washington Cable" } )
```
El método escribe en una colección. El servidor permite la escritura porque el bloqueo de escritura del usuario está insertOne() deshabilitado.

Volver

setQuerySettings

shutdown