sh.reshardCollection()

定義

sh.reshardCollection(namespace, key, unique, options)

バージョン 5.0 で追加

The sh.reshardCollection() method changes the shard key for a collection and changes the distribution of your data.

Before you reshard a collection, read the the reshard requirements and reshard limitations.

重要

mongosh メソッド

このページでは、mongosh メソッドについて記載しています。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、reshardCollection コマンドを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

sh.reshardCollection()は次のフィールドを取ります。

フィールド	タイプ	説明
namespace	string	"<database>.<collection>"形式でシャーディングするコレクションの名前空間。
key	ドキュメント	シャードキーとして使用する新しいフィールドを指定するドキュメント。 { <field1>: <1|"hashed">, ... } フィールド値を次のいずれかに設定します。 範囲ベースのシャーディングの場合は1 "hashed" でハッシュされたシャードキーを指定します。 「シャードキー インデックス」も参照してください
unique	ブール値	任意。 シャードキーに一意の制約があるかどうかを指定します。 falseのみがサポートされています。 デフォルトはfalseです。
options	ドキュメント	Optional. A document containing optional fields, including numInitialChunks, collation, zones and forceRedistribution.

The options field supports the following fields:

フィールド	タイプ	説明
numInitialChunks	integer	任意。 コレクションを 再シャーディングする ときに、クラスター内のすべてのシャードにわたって作成するチャンクの初期数を指定します。 デフォルト値は 90 です。 次に、 MongoDB はクラスター全体でチャンクを作成し、バランスをとります。 numInitialChunks の結果は、シャードあたり 8192 未満である必要があります。 If you see the error "The shard key provided does not have enough cardinality to make the required number of chunks", reshard the collection with a lower numInitialChunks value.
collation	ドキュメント	Optional. If the collection specified to reshardCollection has a default collation, you must include a collation document with { locale : "simple" }, or the reshardCollection command fails.
zones	配列	任意。 コレクションの ゾーン を指定します。 ゾーン を維持または追加するには、コレクションの ゾーン を以下のように配列で指定します。 [ { min: <document with same shape as shardkey>, max: <document with same shape as shardkey>, zone: <string> | null }, ... ]
forceRedistribution	ブール値	Optional. If set to true, the operation runs even if the new shard key is the same as the old shard key. Use with the zones option to move data to specific zones. バージョン8.0の新機能。

互換性

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

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

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

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

Considerations

リシャーディング中に発生するインデックスビルドが、暗黙で失敗する可能性があります。

• リシャーディング プロセスの実行中はインデックスを作成しないでください。

• インデックスのビルドが進行中の場合は、リシャーディングプロセスを開始しないでください。

再シャーディング プロセス

コレクションの再シャーディング操作では、シャードは次のようになります。

• ドナーは、シャーディングされたコレクションのチャンクを現在保存しています。

• 受信者。シャードキーとゾーンに基づいてシャーディングされたコレクションの新しいチャンクを保存します。

シャードは同時にドナーでも受信者でもあることができます。

コンフィギュレーションサーバーのプライマリは常にリシャーディング コーディネーターであり、リシャーディング操作の各フェーズを開始します。

例

sh.reshardCollection( "sales.orders", { order_id: 1 } )

{
  ok: 1,
  '$clusterTime': {
    clusterTime: Timestamp(1, 1624887954),
    signature: {
      hash: Binary(Buffer.from("0000000000000000000000000000000000000000", "hex"), 0),
      keyId: 0
    }
  },
  operationTime: Timestamp(1, 1624887947)
}

sh.reshardCollection(
  "sales.orders",
  { order_id: 1 },
  { forceRedistribution: true }
)

{
  ok: 1,
  '$clusterTime': {
    clusterTime: Timestamp({ t: 1733502241, i: 20 }),
    signature: {
      hash: Binary.createFromBase64('AAAAAAAAAAAAAAAAAAAAAAAAAAA=', 0),
      keyId: Long('0')
    }
  },
  operationTime: Timestamp({ t: 1733502241, i: 20 })
}

sh.addShardToZone( "shard2", "NewZone" )
sh.addShardToZone( "shard3", "NewZone" )

sh.reshardCollection(
  "test.scores",
  { "studentId": 1, "testId": 1},
  { zones: [ {
    min: { "studentId": MinKey(), "testId": MinKey() },
    max: { "studentId": MaxKey(), "testId": MaxKey() },
    zone: "NewZone" }
    ]
} )

{
   ok: 1,
   '$clusterTime': {
   clusterTime: Timestamp( { t: 1699484530, i: 54 } ),
   signature: {
   hash: Binary.createFromBase64( "90ApBDrSSi4XnCpV3OWIH4OGO0Y=", 0 ),
   keyId: Long( "7296989036055363606" )
   } },
   operationTime: Timestamp( { t: 1699484530, i: 54 } )
}

詳細

• コレクションの再シャーディング