cursor.batchSize()

Definição

cursor.batchSize(size)

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação de um driver de idioma específico, como 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 devolvidos em cada lote do resultado de uma query. Por padrão, o tamanho do lote inicial é o menor de 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. Quando definido, o batchSize é o menor entre batchSize documentos ou 16 MiB de documentos.

Um batchSize de 0 significa que o cursor está estabelecido, mas nenhum documento é retornado 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.

O método batchSize() utiliza o seguinte campo:

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: 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

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