sh.shardCollection()

Definição

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

Fragmenta uma coleção usando key como uma chave de fragmento. A chave de fragmento determina como o MongoDB distribui os documentos da coleção entre os fragmentos.

Observação

Alterado na versão 6.0.

A partir do MongoDB 6.0, a fragmentação de uma coleta não exige que você execute primeiro o método sh.enableSharding() para configurar o banco de dados.

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação de comandos de banco de dados nem drivers específicos de linguagem, como Node.js.

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

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

sh.shardCollection() recebe os seguintes argumentos:

Parâmetro	Tipo	Descrição
namespace	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 o valor do campo como: 1 para fragmentação baseada em distância "hashed" para especificar uma chave de shard com hash. a chave de fragmento deve ser suportada por um índice. A menos que a coleta esteja vazia, o índice deve existir antes do comando shardCollection. Se a coleta estiver vazia, o MongoDB criará o índice antes de fragmentar a coleta 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	Opcional. Especifique true para garantir que o índice subjacente imponha uma restrição única. O padrão é false. Você não pode especificar true ao usar hashed shard keys. Se especificar o documento options, você deve especificar explicitamente o valor para unique.
options	documento	Opcional. Um documento contendo campos opcionais, incluindo numInitialChunks e collation.

O argumento options suporta as seguintes opções:

Parâmetro	Tipo	Descrição
numInitialChunks	inteiro	Opcional. Especifica o número mínimo de chunks a serem criados inicialmente ao fragmentar uma coleção vazia com uma chave fragmentada com hash. O MongoDB então cria e equilibra chunks no cluster. O parâmetro numInitialChunks deve ser menor que 8192 chunks por fragmentação. O padrão é 2 chunks por fragmento. 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 chunks pelas zonas do cluster. Se fragmentar com presplitHashedZones: false ou omitido e não houver zona e faixa de zona para a collection vazia, o MongoDB tentará distribuir uniformemente o número especificado de chunks através dos shards no cluster. Se fragmentar com presplitHashedZones: false ou omitido e houver zonas e faixas de zona definidas para a collection vazia, numInitChunks não terá efeito.
collation	documento	Opcional. Se a coleta especificada para shardCollection tiver um agrupamento padrão, você deverá incluir um documento de agrupamento com``{ locale : "simple" }``, ou o comando shardCollection falhará. Pelo menos um dos índices cujos campos suportam o padrão de chave de fragmento 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. Os intervalos de zonas definidos não atendem aos requisitos.
Time series	documento	Opcional. Especifique esta opção para criar uma collection de séries temporais fragmentada. Para fragmentar uma collection de séries temporais existente, omita este parâmetro. Quando a collection especificada para shardCollection é uma collection de séries temporais e a opção timeseries não é especificada, o MongoDB usa os valores que definem a collection de séries temporais existente para preencher o campo timeseries. Para obter uma sintaxe detalhada, consulte Opções de séries temporais.

Compatibilidade

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

• MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

• 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

Uma vez que uma coleção tenha sido fragmentada, o MongoDB não fornece nenhum método para desfazer a fragmentação de uma coleção fragmentada.

Exemplos

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

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