db.collection.analyzeShardKey()

Nesta página

Definição

Compatibilidade
Sintaxe
Campos
Comportamento
Controle de acesso
Saída
Exemplos
Saiba mais

Definição

db.collection.analyzeShardKey(key, opts): Calcula métricas para avaliar uma chave de fragmento para uma coleção fragmentada ou não fragmentada. As métricas são baseadas em queries de amostra. Você pode utilizar o configureQueryAnalyzer para configurar a amostragem de query em uma collection.

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

Importante

Este comando não é suportado em clusters M0, M2 e M5 . Para obter mais informações, consulte Comandos não suportados.

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

Sintaxe

db.collection.analyzeShardKey() tem esta sintaxe:

db.collection.analyzeShardKey(
   <shardKey>,
   {
     keyCharacteristics: <bool>,
     readWriteDistribution: <bool>,
     sampleRate: <double>,
     sampleSize: <int>
   }
 )

Campos

Campo	Tipo	necessidade	Descrição
`key`	documento	Obrigatório	Chave de fragmento para analisar. Pode ser uma chave de fragmento candidata para uma coleção não fragmentada ou uma coleção fragmentada ou a chave de fragmento atual para uma coleção fragmentada. Não há valor padrão.
`opts.keyCharacteristics`	booleano	Opcional	Se as métricas sobre as características da chave de shard são calculadas ou não. Para obter detalhes, consulte keyChaacteristics. Padrão é `true`.
`opts.readWriteDistribution`	booleano	Opcional	Se as métricas sobre a distribuição de leitura e escrita são ou não calculadas. Para obter detalhes, consulte readWriteDistribution. Padrão é `true`.
`opts.sampleRate`	double	Opcional	A proporção dos documentos na collection a serem amostradas ao calcular as métricas sobre as características da chave de shard. Se você definir `sampleRate`, não poderá definir `sampleSize`. Deve ser maior que `0`, até e inclusive `1`. Não há valor padrão.
`opts.sampleSize`	inteiro	Opcional	O número de documentos a serem amostrados ao calcular as métricas sobre as características da chave de fragmento. Se você definir `sampleSize`, não poderá definir `sampleRate`. Se ele e `sampleRate` não forem especificados, o tamanho da amostra assumirá como padrão o tamanho de amostra definido por `analyzeShardKeyCharacteristicsDefaultSampleSize`.

Comportamento

Para saber mais sobre comportamento, consulte Compoartamento de analyzeShardKey.

Controle de acesso

Para obter detalhes, consulte o Controle de acesso analyzeShardKey.

Saída

Para obter saída de amostra, consulte Saída analyzeShardKey.

Exemplos

Por exemplo, consulte Exemplos de analyzeShardKey.

Saiba mais

Voltar

db.coleção.aggregate()

db.collection.bulkWrite