Métodos de cursor

O MongoDB 5.0 é o fim da vida útil a partir de de 2024 outubro. Esta versão da documentação não é mais suportada. Para atualizar sua 5.0 implantação do, consulte o MongoDB 6.0 procedimentos de atualização.

Observação

Métodos de mongosh

Os métodos listados nesta página de índice são mongosh métodos. Esta não é a documentação de Node.js ou de outros métodos de driver específicos da linguagem de programação.

Na maioria dos casos, os métodos mongosh funcionam da mesma forma que os métodos legado do shell mongo . No entanto, alguns métodos legado não estão disponíveis em mongosh.

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

Esses métodos modificam a forma como a consulta subjacente é executada.

Observação

Para obter detalhes sobre um método específico, incluindo sintaxe e exemplos, clique no link para a página de referência do método.

Nome	Descrição
`cursor.addOption()`	Adiciona sinalizadores de protocolo de fio especiais que modificam o comportamento da consulta.
`cursor.allowDiskUse()`	Permite que o MongoDB use arquivos temporários no disco para armazenar dados que excedam o limite de memória do sistema de 100 megabytes durante o processamento de uma operação de classificação por bloqueio.
`cursor.allowPartialResults()`	Permite que operações `db.collection.find()` em uma coleção fragmentada retornem resultados parciais, em vez de um erro, se um ou mais fragmentos consultados não estiverem disponíveis.
`cursor.batchSize()`	Controla o número de documentos que o MongoDB retornará ao cliente em uma única mensagem de rede.
`cursor.close()`	Feche um cursor e libere os recursos do servidor associado.
`cursor.isClosed()`	Retorna `true` se o cursor estiver fechado.
`cursor.collation()`	Especifica o agrupamento do cursor retornado por `db.collection.find()`.
`cursor.comment()`	Adicione um comentário à consulta para permitir o rastreamento nos registros e na coleção system.profile.
`cursor.count()`	Modifica o cursor para retornar o número de documentos no conjunto de resultados, em vez de retornar os documentos em si.
`cursor.explain()`	Informa sobre o plano de execução da consulta para um cursor.
`cursor.forEach()`	Aplica uma função JavaScript para cada documento em um cursor.
`cursor.hasNext()`	Retorna "verdadeiro" se o cursor tiver documentos e eles puderem ser iterados.
`cursor.hint()`	Força o MongoDB a usar um índice específico para uma consulta.
`cursor.isExhausted()`	Retorna `true` se o cursor estiver fechado e não houver objetos restantes no lote.
`cursor.itcount()`	Calcula o total de documentos no cursor através da busca e iteração do conjunto de resultados no lado do cliente.
`cursor.limit()`	Restringe o tamanho do conjunto de resultados de um cursor.
`cursor.map()`	Aplica uma função em cada documento em um cursor e coleta os resultados em uma array.
`cursor.max()`	Especifica um limite do índice superior exclusivo para um cursor. Para uso com `cursor.hint()`
`cursor.maxTimeMS()`	Especifica um limite de tempo cumulativo em milissegundos para operações de processamento em um cursor.
`cursor.min()`	Especifica um limite do índice inferior inclusivo para um cursor. Para uso com `cursor.hint()`
`cursor.next()`	Retorna o próximo documento em um cursor.
`cursor.noCursorTimeout()`	Instrui o servidor para evitar fechar um cursor automaticamente após um período de inatividade.
`cursor.objsLeftInBatch()`	Retorna o número de documentos deixados no lote do cursor atual.
`cursor.pretty()`	Configura o cursor para exibir os resultados em um formato de leitura fácil.
`cursor.readConcern()`	Especifica uma referência de leitura para uma operação `find()`.
`cursor.readPref()`	Especifica uma preferência de leitura para um cursor para controlar como o cliente direciona as consultas para um conjunto de réplicas.
`cursor.returnKey()`	Modifica o cursor para retornar as chaves de índice em vez dos documentos.
`cursor.showRecordId()`	Adiciona um campo de ID do mecanismo de armazenamento interno a cada documento retornado pelo cursor.
`cursor.size()`	Retorna uma contagem dos documentos no cursor após aplicar os métodos `skip()` e `limit()`.
`cursor.skip()`	Retorna um cursor que só começa a retornar resultados após pular ou ignorar vários documentos.
`cursor.sort()`	Retorna os resultados seguindo uma ordem específica de classificação.
`cursor.tailable()`	Marca o cursor como rastreável. Válido somente para cursores acima de coleções limitadas.
`cursor.toArray()`	Retorna uma array com todos os documentos obtidos pelo cursor.
`cursor.tryNext()`	Retorna o próximo elemento na iteração, se disponível ou não.

Voltar

db.collection.watch

cursor.addOption