setUserWriteBlockMode

項目一覧

定義

setUserWriteBlockMode

バージョン 6.0 で追加。

setUserWriteBlockModeコマンドは、クラスター全体への書込みのブロックとブロック解除を実行します。

Cluster-to-Cluster Sync中に、クラスタ間同期ツールである mongosync は setUserWriteBlockMode コマンドを使用して宛先クラスターへの書込みをブロックします。詳しくは、 HTTP API startコマンドを参照してください。

bypassWriteBlockingMode特権を持つユーザーとアプリケーションは、ブロックをバイパスして書込みを引き続き実行できます。

このコマンドは、次の環境でホストされている配置で使用できます。

このコマンドは、 MongoDB Atlasクラスターではサポートされていません。すべてのコマンドの Atlas サポートの詳細については、「サポートされていないコマンド」を参照してください。

このコマンドの構文は、次のとおりです。

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

このコマンドは、次のフィールドを使用します。

フィールド	タイプ	説明
`setUserWriteBlockMode`	integer	このフィールドを`1`に設定します。
`global`	ブール値	`true`に設定すると、クラスターへの書込みがブロックされます。クラスターで書込みを有効にするには、 `global: false`を設定します。

setUserWriteBlockModeコマンドを実行するには、ユーザーにsetUserWriteBlockMode特権が必要です。

ユーザー書込みブロックモードを有効にします。
```
db.adminCommand( {
   setUserWriteBlockMode: 1,
   global: true
} )
```
コレクションにレコードを追加します。
```
db.names.insertOne( { name: "George Washington Cable" } )
```
ユーザーの書込みブロックが有効になっているため、サーバーは書込みをブロックします。
出力例:
```
MongoServerError: User writes blocked
```
ユーザーの書込みブロックモードを無効にします。
```
db.adminCommand( {
   setUserWriteBlockMode: 1,
   global: false
} )
```
コレクションにレコードを追加します。
```
db.names.insertOne( { name: "George Washington Cable" } )
```
insertOne()メソッドはコレクションに書き込みます。ユーザーの書込みブロックが無効になっているため、サーバーは書込みを許可します。

戻る

setQuerySettings

shutdown