sh.shardCollection()

定義

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

Shards a collection using the key as a the シャードキー. The shard key determines how MongoDB distributes the collection's documents among the shards.

注意

バージョン 6.0 での変更。

Starting in MongoDB 6.0, sharding a collection does ではない require you to first run the sh.enableSharding() method to configure the database.

重要

mongosh メソッド

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

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

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

sh.shardCollection() takes the following arguments:

Parameter	タイプ	説明
namespace	string	"<database>.<collection>"形式でシャーディングするコレクションの名前空間。
key	ドキュメント	シャードキー として使用するフィールドを指定するドキュメント。 { <field1>: <1|"hashed">, ... } Set the field value to either: 範囲ベースのシャーディングの場合は1 "hashed" でハッシュされたシャードキーを指定します。 シャードキーはインデックスでサポートされている必要があります。コレクションが空でない限り、shardCollection コマンドの前にインデックスが存在している必要があります。コレクションが空の場合、シャードキーをサポートできるインデックスがまだ存在しない場合には、MongoDB はコレクションをシャーディングする前にインデックスを作成します。 「シャードキー インデックス」も参照してください
unique	ブール値	Optional. Specify true to ensure that the underlying index enforces a unique constraint. Defaults to false. ハッシュされたシャードキーを使用する場合、 trueは指定できません。 For レガシー mongo shell, you must explicitly specify the value for unique if you specify the options document. mongosh doesn't require unique when you specify the options document.
options	ドキュメント	Optional. A document containing optional fields, including numInitialChunks and collation.

The options argument supports the following options:

Parameter	タイプ	説明
numInitialChunks	integer	Optional. Specifies the minimum number of chunks to create initially when sharding an empty collection with a ハッシュされたシャードキー. MongoDB then creates and balances chunks across the cluster. The numInitialChunks parameter must be less than 8192 chunks per shard. Defaults to 2 chunks per shard. コレクションが空でない場合、またはシャードキーにハッシュされたフィールドが含まれていない場合、操作はエラーを返します。 presplitHashedZones: true でシャーディング場合、 MongoDB は指定された数のチャンクをクラスター内のゾーン全体に均等に分散しようとします。 presplitHashedZones: false または省略でシャーディング、空のコレクションにゾーンとゾーン範囲が定義されていない場合、 MongoDB は指定された数のチャンクをクラスター内のシャード全体に均等に分散しようとします。 presplitHashedZones: false または省略でシャーディング、空のコレクションに対してゾーンとゾーン範囲が定義されている場合、numInitialChunks は効果がありません。
collation	ドキュメント	Optional. If the collection specified to shardCollection has a default collation, you must include a collation document with``{ locale : "simple" }``, or the shardCollection command fails. At least one of the indexes whose fields support the shard key pattern must have the simple collation.
presplitHashedZones	ブール値	任意。 コレクションに定義されたゾーンとゾーン範囲に基づいて、空または存在しないコレクションの初期チャンク作成と分散を実行するには、 trueを指定します。 ハッシュされたシャーディングのみ。 次のいずれかに当てはまる場合、 shardCollection()とpresplitHashedZones: trueはエラーを返します。 シャードキーにはハッシュされたフィールドが含まれていません（単一フィールド ハッシュされたインデックスまたはハッシュされた複合インデックス ではない）。 コレクションには、定義されたゾーンまたはゾーン範囲はありません。 The defined zone ranges do not meet the requirements.
時系列	ドキュメント	任意。 新しいシャーディングされた時系列コレクションを作成するには、このオプションを指定します。 既存の時系列コレクションをシャーディングするには、このパラメーターを省略します。 shardCollectionに指定されたコレクションが時系列コレクションで、かつtimeseriesオプションが指定されていない場合、MongoDB は既存の時系列コレクションを定義する値を使用してtimeseriesフィールドに入力します。 詳細な構文については「時系列オプション 」を参照してください。

互換性

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

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

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

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

Considerations

例

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

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