updateZoneKeyRange

定義

updateZoneKeyRange

updateZoneKeyRange管理コマンドは、シャードキー値の範囲とゾーンの間の関連付けを作成または削除できます。

updateZoneKeyRangeデータベースコマンドとそのヘルパーsh.updateZoneKeyRange()とsh.addTagRange()は、シャーディングされていないコレクションまたは存在しないコレクションで実行できます。

Tip

mongoshでは、このコマンドはsh.updateZoneKeyRange()ヘルパー メソッドを通じて実行することもできます。

ヘルパー メソッドはmongoshユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。

updateZoneKeyRange を実行するには、db.runCommand( { <command> } ) メソッドを使用します。

管理データベースでaddShardToZoneを実行する必要があります。

互換性

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

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

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

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

db.adminCommand(
   {
     updateZoneKeyRange: <string>,
     min: <document>,
     max: <document>,
     zone: <string> | <null>
   }
)

コマンドフィールド

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

動作

updateZoneKeyRangeに渡される最小境界と最大境界に一致するゾーン範囲がない場合、削除されるものはありません。

updateZoneKeyRangeインスタンスに接続されている場合にのみmongos を発行します。

mongosh は 2 つのヘルパー メソッドを提供します。

• sh.updateZoneKeyRange() 、 シャードキー 値の範囲をゾーンに追加するため。

• sh.removeRangeFromZone() ゾーンから シャードキー 値の範囲を削除するため。

シャーディングされたコレクションの既存の範囲と下限と上限が重複するシャードキー値の範囲は作成できません。 たとえば、 1から10の既存の範囲がある場合、 5から20の新しい範囲は作成できません。新しい範囲は既存の範囲と重複するためです。

ゾーンには複数のデータ範囲を関連付けることができますが、範囲は最大で 1 つのゾーンに関連付けることができます。

範囲とゾーンの間の関連付けを削除しても、 updateZoneKeyRangeはゾーンを削除しません。 ゾーンとシャードの間の関連付けを削除するには、 removeShardFromZoneコマンドを使用します。

シャーディングされたクラスター内のゾーンの詳細については、ゾーンのマニュアル ページを参照してください。

セキュリティ

認証 を使用して実行されているシャーディングされたクラスターの場合は、次のいずれかとして認証する必要があります。

• configデータベース内のさまざまなコレクションに対して指定されたアクションを含む特権を持つユーザー:

  • findconfig.shardsコレクションの

  • コレクションのfind 、 、 。updateremoveconfig.tags

  または、あるいは、

• クラスター リソースでenableSharding を含む 権限 を持つユーザー。

clusterAdminまたはclusterManagerの組み込みロールには、 updateZoneKeyRangeを発行するための適切な権限があります。 詳細については、ロールベースのアクセス制御に関するドキュメントページを参照してください。

例

シャーディングされたコレクションexampledb.collectionとシャードキーが{ a : 1 }の場合、次の操作を実行すると、 alphaゾーンに下限が1で上限が10の範囲が作成されます。

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1 },
      max : { a : 10 },
      zone : "alpha"
   }
)

次の操作では、 nullをzoneフィールドに渡すことで、以前に作成した範囲が削除されます。

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1 },
      max : { a : 10 },
      zone : null
   }
)

minとmaxは、ターゲット範囲の境界と完全に一致する必要があります。 次の操作は、以前に作成した範囲を削除しようとしますが、 minの限界として{ a : 0 }を指定します。

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 0 },
      max : { a : 10 },
      zone : null
   }
)

{ a : 0 }と{ a : 10 }の範囲は既存の範囲を含みますが、完全一致ではないため、 updateZoneKeyRangeは何も削除しません。

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1, b : 1 },
      max : { a : 10, b : 10 },
      zone : "alpha"
   }
)