sh.reshardCollection()（mongoshメソッド）

定義

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

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

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

重要

mongosh メソッド

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

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

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

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

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

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

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

互換性

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

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

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

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

Considerations

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

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

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

リシャーディングしているコレクションがMongoDB Search を使用している場合、リシャーディング操作の完了時に検索インデックスは使用できなくなります。再シャーディング操作が完了してから、検索インデックスを手動で再構築する必要があります。

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

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

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

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

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

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

例

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 } )
}

詳細

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