sharedCollection

Definição

shardCollection

Fragmenta uma collection para distribuir seus documentos entre shards. Você deve executar enableSharding em um banco de dados antes de executar o comando shardCollection . O comando shardCollection deve ser executado no banco de dados admin .

Para executar shardCollection, utilize o método db.runCommand( { <command> } ).

Dica

Em mongosh, esse comando também pode ser executado por meio do método auxiliar sh.shardCollection().

Os métodos auxiliares são práticos para os usuários mongosh, mas podem não retornar o mesmo nível de informações que os comandos do banco de dados. Nos casos em que a praticidade não for necessária ou os campos de retorno adicionais forem necessários, use o comando de banco de dados.

shardCollection tem o seguinte formato:

{
   shardCollection: "<database>.<collection>",
   key: { <field1>: <1|"hashed">, ... },
   unique: <boolean>,
   numInitialChunks: <integer>,
   presplitHashedZones: <boolean>,
   collation: { locale: "simple" }
}

shardCollection tem os seguintes campos:

Campo	Tipo	Descrição
shardCollection	string	O namespace da collection para fragmentar no formato <database>.<collection>.
key	documento	O documento que especifica o campo ou campos a serem usados como a chave de shard. { <field1>: <1|"hashed">, ... } Defina os valores do campo como: 1 para fragmentação baseada em distância "hashed" para especificar uma hashed shard key. A chave de fragmento deve ser suportada por um índice. A menos que a coleção esteja vazia, o índice deve existir antes do comando shardCollection. Se a coleção estiver vazia, o MongoDB criará o índice antes de fragmentar a coleção se o índice que pode suportar a chave de fragmentação ainda não existir. Consulte também Índices de chaves de shard
unique	booleano	Especifique true para garantir que o índice subjacente imponha uma restrição exclusiva. O padrão é false. Você não pode especificar true ao usar hashed shard keys.
numInitialChunks	inteiro	Especifica o número inicial de chunks para criar em todos os shards no cluster ao compartilhar uma collection vazia com uma hashed shard key. Em seguida, o MongoDB cria e equilibra os chunks no cluster. numInitialChunks deve resultar em menos de 8192 por shard. Se a collection não estiver vazia ou a chave de shard não contiver um campo hashed, a operação retornará um erro. Se fragmentar com presplitHashedZones: true, o MongoDB tentará distribuir uniformemente o número especificado de partes pelas zonas do cluster. Se fragmentar com presplitHashedZones: false ou omitido e não houver zona e faixa de zona para a coleção vazia, o MongoDB tentará distribuir uniformemente o número especificado de partes através dos fragmentos no cluster. Se fragmentar com presplitHashedZones: false ou omitido e houver zonas e faixas de zona definidas para a coleção vazia, numInitChunks não terá efeito.
collation	documento	Opcional. Se a collection especificada para shardCollection tiver um agrupamento padrão, você precisa incluir um documento de agrupamento com { locale : "simple" }, senão o comando shardCollection falha. Pelo menos um dos índices cujos campos suportam o padrão de chave de shard deve ter o agrupamento simples.
presplitHashedZones	booleano	Opcional. Especifique true para executar a criação e distribuição inicial de chunks para uma collection vazia ou inexistente com base nas zonas e faixas de zonas definidas para a collection. Apenas para fragmentação hashed . shardCollection com presplitHashedZones: true retorna um erro se alguma das seguintes afirmações for verdadeira: A chave de shard não contém um campo hashed (ou seja, não é um índice hashed de campo único ou um índice hashed composto). A collection não tem zonas ou faixas de zonas definidas. As faixas de zona definidas não atendem aos requisitos.

Considerações

Exemplo

A seguinte operação habilita a fragmentação para a collection people no banco de dados de records e utiliza o campo zipcode como a chave de shard:

db.adminCommand( { shardCollection: "records.people", key: { zipcode: 1 } } )