find

espécie

Opcional. A especificação de projeção para determinar quais campos incluir nos documentos devolvidos. Consulte Projeção e Operadores de Projeção.

As operações find() nas exibições não são compatíveis com os seguintes operadores de query e projeção:

• $

• $elemMatch

• $slice

• $meta

Opcional. Especificação do índice. Especifique o nome do índice como uma string ou o padrão da chave do índice. Se especificado, o sistema de query considerará apenas os planos usando o índice sugerido.

Com a seguinte exceção, hint será exigido se o comando incluir os campos min e/ou max ; hint não é necessário com min e/ou max se filter for uma condição de igualdade no campo _id { _id: <value> }.

Opcional. O número de documentos a retornar no primeiro lote. O padrão é 101. Um batchSize de 0 significa que o cursor será estabelecido, mas nenhum documento será retornado no primeiro lote.

Ao contrário da versão anterior do protocolo de conexão, um tamanho de lote 1 para o comando find não fecha o cursor.

Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:

• mensagens de log do mongod, no campo attr.command.cursor.comment.

• Saída do perfil do banco de dados, no campo command.comment.

• Saída de currentOp, no campo command.comment.

Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc).

Opcional.

Especifica um limite de tempo em milissegundos. Se você não especificar um valor para maxTimeMS, as operações não atingirão o tempo limite. Um valor 0 especifica explicitamente o comportamento ilimitado padrão.

O MongoDB encerra as operações que excedem o limite de tempo alocado usando o mesmo mecanismo de db.killOp(). O MongoDB só encerra uma operação em um de seus pontos de interrupção designados.

Opcional. Especifica a read concern.

A opção readConcern tem a seguinte sintaxe: readConcern: { level: <value> }

Os possíveis níveis de read concern são:

• "local". Esse é o read concern padrão para operações de leitura em relação ao primário e secundários.

• "available". Disponível para operações de leitura em relação às primárias e secundárias. "available" se comporta da mesma forma que "local" em relação aos secundários primários e não fragmentados. A query retorna os dados mais recentes da instância.

• "majority". Disponível para conjuntos de réplica que usam o mecanismo de armazenamento WiredTiger.

• "linearizable". Disponível apenas para operações de leitura no primary.

Para obter mais informações sobre os read concern, consulte Níveis de read concern.

O comando getMore utiliza o nível readConcern especificado no comando find de origem.

Opcional. O limite superior exclusivo para um índice específico. Consulte cursor.max() para detalhes.

Para utilizar o campo max, o comando também deve utilizar hint a menos que a filter especificada seja uma condição de igualdade no campo _id { _id: <value> }.

Opcional. O limite inferior inclusivo para um índice específico. Consulte cursor.min() para obter detalhes.

Para utilizar o campo min, o comando também deve utilizar hint a menos que a filter especificada seja uma condição de igualdade no campo _id { _id: <value> }.

Opcional. Para queries em relação a uma coleção fragmentada, permite que o comando (ou comandos subsequentes do getMore) retorne resultados parciais, ao invés de um erro, se um ou mais fragmentos analisados não estiverem disponíveis.

Se find (ou comandos getMore subsequentes) retornarem resultados parciais porque o(s) fragmento(s) consultado(s) na query não está/estão disponível(is), a saída encontrada incluirá um campo indicador partialResultsReturned. Se os fragmento consultados na query estiverem disponíveis para o comando find inicial, mas um ou mais fragmentos ficarem indisponíveis para comandos getMore subsequentes, somente os comandos getMore executados enquanto os fragmentos não estiverem disponíveis incluirão partialResultsReturned em seu resultado.

Opcional.

Especifica o agrupamento a ser usado para a operação.

A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de strings, como regras para letras maiúsculas e marcas de acento.

A opção de agrupamento tem a seguinte sintaxe:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

Ao especificar agrupamento, o campo locale é obrigatório; todos os outros campos de agrupamento são opcionais. Para obter descrições dos campos, consulte Documento de agrupamento.

Se o agrupamento não for especificado, mas a coleção tiver um agrupamento padrão (consulte db.createCollection()), a operação usará o agrupamento especificado para a coleção.

Se nenhum agrupamento for especificado para a coleção ou para as operações, o MongoDB usa a comparação binária simples usada nas versões anteriores para comparações de strings.

Você não pode especificar vários agrupamentos para uma operação. Por exemplo, você não pode especificar agrupamentos diferentes por campo ou, se estiver realizando uma busca com uma classificação, não poderá usar um agrupamento para a busca e outro para a classificação.

allowDiskUse

Opcional.

Utilize esta opção para substituir o allowDiskUseByDefault para uma query específica. Você pode usar esta opção para:

• Proibir o uso do disco em um sistema onde o uso do disco é permitido por padrão.

• Permitir o uso do disco em um sistema onde o uso do disco é proibido por padrão.

A partir do MongoDB 6.0, se allowDiskUseByDefault estiver configurado como true e o servidor exigir mais de 100 megabytes de memória para um estágio de execução do pipeline, o MongoDB gravará automaticamente arquivos temporários em disco, a menos que a consulta especifique { allowDiskUse: false }.

Para detalhes, consulte allowDiskUseByDefault.

allowDiskUse não terá efeito se o MongoDB puder satisfazer a classificação especificada utilizando um índice, ou se a classificação de bloqueio exigir menos de 100 megabytes de memória.

Para obter mais documentação completa sobre allowDiskUse, consulte cursor.allowDiskUse().

Para obter mais informações sobre restrições de memória para ordenações de bloqueio grandes, consulte Uso de ordenação e índice.

Opcional.

Especifica um documento com uma lista de variáveis. Isso permite que você melhore a legibilidade do comando separando as variáveis do texto da query.

A sintaxe do documento é:

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

A variável é definida para o valor retornado pela expressão e não pode ser alterada posteriormente.

Para acessar o valor de uma variável no comando, use o prefixo de dois cifrões ($$) junto com o nome da variável no formato $$<variable_name>. Por exemplo: $$targetTotal.

Para um exemplo completo utilizando let e variáveis, consulte Utilizar Variáveis no let.