setUserWriteBlockMode （データベースコマンド）

定義

setUserWriteBlockMode

バージョン 6.0 で追加。

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

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

レプリカセットでの書込みをすでにブロックしている場合、指定された reason が書込みブロックを最初に有効にしたときに指定した理由と一致しないと、global: true を使用して setUserWriteBlockMode に対する後続の呼び出しが失敗し、IllegalOperation エラーが発生します。エラーメッセージには、現在の理由と、失敗したコマンドで指定された理由の両方が含まれます。シャーディングされたクラスターでは、この制約は強制されません。

注意

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

互換性

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

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

重要

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

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

重要

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

構文

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

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

コマンドフィールド

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

フィールド	タイプ	説明
`setUserWriteBlockMode`	integer	このフィールドを`1`に設定します。
`global`	ブール値	`true`に設定すると、クラスターへの書込みがブロックされます。クラスターで書込みを有効にするには、 `global: false`を設定します。
`reason`	string	任意。書込みをブロックする理由を指定します。次の値を受け入れます。 `"Unspecified"` - 理由を指定しない場合は、デフォルトでとなります。 `"ClusterToClusterMigrationInProgress"` - 進行中のクラスター間の移行によりブロックされた書込みを示します。 `"DiskUseThresholdExceeded"` - ディスク使用量がしきい値を超えたため、ブロックされた書込みを示します。

必要なアクセス権

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