cursor.batchSize() (método mongosh)

Definição

cursor.batchSize(size)

Importante

Método mongosh

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

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

O número máximo de documentos que podem ser retornados em cada lote de um resultado de query. Por padrão, o tamanho inicial do lote é o menor entre 101 documentos ou 16 mebibytes (MiB) de documentos. Os lotes subsequentes têm um tamanho máximo de 16 MiB. Esta opção pode impor um limite menor que 16 MiB, mas não um maior. Quando configurado, o batchSize é o menor entre batchSize documentos ou 16 MiB de documentos.

Em clusters sharded, mongos não encaminha o valor batchSize para shards individuais. As operações getMore subsequentes em um cluster retornam até 16 MiB de documentos por lote, independentemente do batchSize configurado.

Um batchSize de 0 significa que o cursor está estabelecido, mas nenhum documento é devolvido no primeiro lote.

Observação

Se o tamanho do lote for muito grande, o cursor alocará mais recursos do que necessita, o que poderá ter um impacto negativo no desempenho da query. Se o tamanho do lote for muito pequeno, o cursor exigirá mais viagens de ida e volta na rede para recuperar os resultados da query, o que pode impactar negativamente o desempenho da query.

Ajuste batchSize para um valor apropriado às suas necessidades de banco de dados, carga e aplicativo.

The batchSize() method takes the following field:

Campo	Tipo	Descrição
size	inteiro	O número máximo de documentos que podem ser devolvidos em cada lote do resultado de uma query. O tamanho do lote inicial padrão é menor ou 101 documentos ou 16 mebibytes (MiB) de documentos. Os lotes subsequentes têm um tamanho máximo de 16 MiB. Esta opção pode impor um limite menor que 16 MiB, mas não maior. O padrão se aplica a drivers e mongo shell. Para obter detalhes, consulte Lotes de cursores.

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

Exemplo

O exemplo a seguir define batchSize para os resultados de uma query (especificamente, find()) como 10:

db.inventory.find().batchSize(10)

Saiba mais

• Lotes de cursores

• cursor.next()

• getMore