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

定義

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

key をシャードキーとして使用してコレクションをシャーディングします。シャードキーは、MongoDB がコレクションのドキュメントをシャード間でどのように分散するかを決定します。

注意

バージョン6.0で変更。

MongoDB 6.0 以降では、コレクションをシャーディングする場合、最初に sh.enableSharding() メソッドを実行してデータベースを構成する必要はありません。

重要

mongosh メソッド

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

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

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

sh.shardCollection() 以下の引数を取ります。

Parameter	タイプ	説明
namespace	string	"<database>.<collection>"形式でシャーディングするコレクションの名前空間。
key	ドキュメント	シャードキー として使用するフィールドを指定するドキュメント。 { <field1>: <1|"hashed">, ... } フィールド値を次のいずれかに設定します。 1 、範囲ベースのシャーディング用 "hashed" ハッシュされたシャードキーを指定します。 シャードキーはインデックスでサポートされている必要があります。コレクションが空でない限り、shardCollection コマンドの前にインデックスが存在している必要があります。コレクションが空の場合、シャードキーをサポートできるインデックスがまだ存在しない場合には、MongoDB はコレクションをシャーディングする前にインデックスを作成します。 「シャードキー インデックス」も参照してください
unique	ブール値	任意。基礎のインデックスがユニーク制約を強制するようにするには、true を指定します。デフォルトは false です。 ハッシュされたシャードキーを使用する場合、 trueは指定できません。 options ドキュメントを指定する場合は、unique の値を明示的に指定する必要があります。
options	ドキュメント	任意。numInitialChunks や collation などの任意フィールドを含むドキュメント。

options 引数は以下のオプションをサポートしています。

Parameter	タイプ	説明
numInitialChunks	integer	任意。空のコレクションをハッシュされたシャードキーでシャーディングするときに最初に作成するチャンクの最小数を指定します。次に、MongoDB はクラスター全体でチャンクを作成し、バランスをとります。numInitialChunks パラメーターは、シャードあたり 8192 チャンク未満である必要があります。デフォルトはシャードあたり 2 チャンク。 コレクションが空でない場合、またはシャードキーにハッシュされたフィールドが含まれていない場合、操作はエラーを返します。 presplitHashedZones: true でシャーディング場合、 MongoDB は指定された数のチャンクをクラスター内のゾーン全体に均等に分散しようとします。 presplitHashedZones: false または省略でシャーディング、空のコレクションにゾーンとゾーン範囲が定義されていない場合、 MongoDB は指定された数のチャンクをクラスター内のシャード全体に均等に分散しようとします。 presplitHashedZones: false または省略でシャーディング、空のコレクションに対してゾーンとゾーン範囲が定義されている場合、numInitChunks は効果がありません。
collation	ドキュメント	任意。shardCollection に指定されたコレクションにデフォルトの照合がある場合は、``{ locale : "simple" }`` を使用して照合ドキュメントを含める必要があります。そうしないと、shardCollection コマンドは失敗します。フィールドがシャードキー パターンをサポートするインデックスの少なくとも 1 つには、単純照合が必要です。
presplitHashedZones	ブール値	任意。 コレクションに定義されたゾーンとゾーン範囲に基づいて、空または存在しないコレクションの初期チャンク作成と分散を実行するには、 trueを指定します。 ハッシュされたシャーディングのみ。 shardCollection() 次のいずれかに当てはまる場合、 presplitHashedZones: trueと はエラーを返します。 シャードキーにはハッシュされたフィールドが含まれていません（単一フィールド ハッシュされたインデックスまたはハッシュされた複合インデックス ではない）。 コレクションには、定義されたゾーンまたはゾーン範囲はありません。 定義されたゾーン範囲が要件を満たしていません。
時系列	ドキュメント	任意。 新しいシャーディングされた時系列コレクションを作成するには、このオプションを指定します。 既存の時系列コレクションをシャーディングするには、このパラメーターを省略します。 shardCollectionに指定されたコレクションが時系列コレクションで、かつtimeseriesオプションが指定されていない場合、MongoDB は既存の時系列コレクションを定義する値を使用してtimeseriesフィールドに入力します。 詳細な構文については「 時系列オプション 」を参照してください。

互換性

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

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

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

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

Considerations

MongoDB には、いったんシャーディングされたコレクションで、シャーディングを解除するメソッドがありません。

例

sh.shardCollection("records.people", { zipcode: 1 } )

sh.shardCollection(
  "phonebook.contacts",
  { last_name: "hashed" },
  false,
  {
    numInitialChunks: 5,
    collation: { locale: "simple" }
  }
)