sh.reshardCollection() (método mongosh)

Definição

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

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

Antes de refragmentar uma coleção, leia os requisitos de refragmentação e as limitações de refragmentação.

Importante

Método mongosh

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

Para o comando do banco de dados, consulte o comando reshardCollection.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

sh.reshardCollection() usa os seguintes campos:

Campo	Tipo	Descrição
namespace	string	O namespace da collection para fragmentar no formato "<database>.<collection>".
key	documento	O documento que especifica o novo 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 faixa "hashed" para especificar uma chave de shard com hash. Consulte também Índices de chaves de shard
unique	booleano	Opcional. Especifique se há uma restrição de exclusividade na chave de shard. Somente false é suportado. O padrão é false. unique: false não remove as restrições de exclusividade existentes. Um índice único que existe na coleção antes de você refragmentar permanece único após a conclusão da operação de refragmentação. A nova chave de shard com hash deve satisfazer os requisitos de índices únicos para quaisquer índices únicos existentes.
options	documento	opcional. Um documento contendo campos opcionais, incluindo numInitialChunks, numSamplesPerChunk, collation, zones e forceRedistribution.

O campo options suporta os seguintes campos:

Campo	Tipo	Descrição
numInitialChunks	inteiro	Opcional. Especifica o número inicial de chunks para criar em todos os shards no cluster ao refragmentar uma collection. O valor padrão é 90. Em seguida, o MongoDB cria e equilibra os chunks no cluster. numInitialChunks deve resultar em menos de 8192 por shard. Se você ver o erro "A chave de shard fornecida não tem cardinalidade suficiente para criar o número necessário de blocos", refaça a coleta com um valor numInitialChunks menor. As operações de refragmentação ignoram a configuração numInitialChunks quando a chave de fragmento contém um prefixo com hash. Em vez disso, o MongoDB divide deterministicamente o espaço de chave hasheada entre os destinatários, usando a mesma abordagem da criação inicial de partes para coleções vazias com hash.
numSamplesPerChunk	inteiro	opcional. Especifica o número de documentos a serem amostrados em novas partes. Por padrão, o MongoDB amostra 10 documentos em cada parte. Novidades na versão 8.0.20.
collation	documento	Opcional. Se a coleção especificada para reshardCollection tiver um agrupamento padrão, você precisa incluir um documento de agrupamento com { locale : "simple" }, senão o comando reshardCollection falha.
zones	array	Opcional. Especifica as zonas da collection. Para manter ou adicionar zonas, especifique as zonas da sua collection em uma array: [ {s min: <document with same shape as shardkey>, max: <document with same shape as shardkey>, zone: <string> | null }, ... ]
forceRedistribution	booleano	Opcional. Se definida como true, a operação será executada mesmo que a nova chave de shard seja igual à chave de shard antiga. Use com a opção zones para mover dados para zonas específicas. Novidades na versão 8.0.

Compatibilidade

Esse método está disponível em implantações hospedadas nos seguintes ambientes:

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

• MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

• MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Considerações

As compilações de índice que ocorrem durante a refragmentação podem falhar silenciosamente.

• Não crie índices durante o processo de refragmentação.

• Não inicie o processo de refragmentação se houver construções de índice em andamento.

Se a collection que você está refragmentando usar MongoDB Search, o índice de pesquisa ficará indisponível quando a operação de refragmentação for concluída. Você precisa refragmentar manualmente o índice de pesquisa assim que a operação de refragmentação for concluída.

Processo de refragmentação

Em uma operação de refragmentação de collection, um fragmento (shard) pode ser um:

• doador, que atualmente armazena chunks para a coleção fragmentada.

• receptor, que armazena novos chunks para a coleção fragmentada com base nas chaves de fragmento e nas zonas.

Um shard pode ser doador e um receptor ao mesmo tempo.

O servidor de configuração primário é sempre o gerenciador de refragmentação e inicia cada fase da operação de refragmentação.

Exemplos

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

Saiba mais

• Refragmentar uma collection