sh.reshardCollection()

定義

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

バージョン 5.0 で追加

sh.reshardCollection()メソッドは、コレクションのシャードキーを変更し、データの分散状況を変える。

コレクションを再シャーディングする前に、 の再シャーディング要件と再シャーディングの制限をお読みください。

重要

mongosh メソッド

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

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

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

sh.reshardCollection() は、次のフィールドがあります。

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

optionsフィールドは次のフィールドをサポートしています。

フィールド	タイプ	説明
numInitialChunks	integer	任意。 コレクションを 再シャーディングする ときに、クラスター内のすべてのシャードにわたって作成するチャンクの初期数を指定します。 デフォルト値は 90 です。 次に、 MongoDB はクラスター全体でチャンクを作成し、バランスをとります。 numInitialChunks の結果は、シャードあたり 8192 未満である必要があります。 「提供されたシャードキーの濃度が十分でなく、必要な数のチャンクを作成できません」というエラーが表示された場合は、numInitialChunks 値を低くしてコレクションを再シャーディングします。
collation	ドキュメント	任意。 reshardCollectionに指定されたコレクションにデフォルトの照合がある場合は、 { locale : "simple" }を使用して照合ドキュメントを含める必要があります 。そうしないと、 reshardCollectionコマンドは失敗します。
zones	配列	任意。 コレクションの ゾーン を指定します。 ゾーン を維持または追加するには、コレクションの ゾーン を以下のように配列で指定します。 [ { min: <document with same shape as shardkey>, max: <document with same shape as shardkey>, zone: <string> | null }, ... ]
forceRedistribution	ブール値	任意。 trueに設定されている場合、新しいシャードキーが古いシャードキーと同じであっても操作は実行されます。 データを特定のゾーンに移動するには、 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 } )
}

詳細

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