encontrar (comando de banco de dados)

find

string

O nome da coleção ou visualizar para fazer query.

filter

documento

opcional. O predicado de query. Se não for especificado, todos os documentos na coleção corresponderão ao predicado.

sort

documento

Opcional. A especificação de classificação para a ordenação dos resultados.

projection

documento

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

As operaçõesfind() em visualizações não suportam os seguintes operadores de projeção de comando find:

• $

• $elemMatch

• $slice

• $meta

hint

string ou documento

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 é necessário se o comando incluir os campos min ou max. hint não é necessário com min ou max se o filter for uma condição de igualdade no campo _id { _id: <value> }.

skip

número inteiro positivo

Opcional. Número de documentos a ignorar. O padrão é 0.

limit

non-negative integer

Opcional. O número máximo de documentos a retornar. Se não for especificado, o padrão será sem limite. Um limite de 0 é equivalente a não definir nenhum limite.

batchSize

non-negative integer

Opcional. O número máximo de documentos que podem ser retornados em cada lote de um resultado de query. Por padrão, o comando find tem batchSize do menor dos documentos 101 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 do que 16 MiB, mas não maior. Quando definido, o batchSize é o menor de batchSize documentos ou 16 MiB de documentos.

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

Unlike the previous wire protocol version, a batchSize of 1 for the find command does not close the cursor.

Para especificar o tamanho do lote para operações subsequentes de getMore, use batchSize() no mongosh.

singleBatch

booleano

Opcional. Determina se o cursor deve ser fechado após o primeiro lote. O padrão é falso.

comment

any

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).

Qualquer comentário definido em um comando find é herdado por todos os comandos getMore subsequentes executados no cursor find.

maxTimeMS

non-negative integer

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.

Ao especificar linearizable read concern, sempre use maxTimeMS caso a maioria dos membros de suporte de dados não esteja disponível. maxTimeMS garante que a operação não bloqueie indefinidamente e, em vez disso, retorne um erro se a preocupação de leitura não puder ser executada.

maxTimeMS() não tem relação com noCursorTimeout(). maxTimeMS() limita o tempo em processamento, enquanto noCursorTimeout() evita a expiração por tempo ocioso. O tempo ocioso de um cursor não contribui para seu tempo em processamento.

readConcern

documento

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.

• "snapshot". Disponível para transações multidocumento e determinadas operações de leitura fora das transações multidocumento.

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.

max

documento

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> }.

min

documento

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> }.

returnKey

booleano

Optional. If true, returns only the index keys in the resulting documents. Defaults to false. If returnKey is true and the find command does not use an index, the returned documents are empty.

showRecordId

booleano

Opcional. Determina se o identificador de registro de cada documento deve ser retornado. Se verdadeiro, adiciona um campo $recordId aos documentos devolvidos.

tailable

booleano

Opcional. Retorna um cursor tailable para coleções limitadas.

awaitData

booleano

Optional. Use with the tailable option to block a getMore command on the cursor temporarily at the end of data rather than returning no data. After a timeout period, find returns as normal.

noCursorTimeout

booleano

Optional. Prevents the server from timing out non-session idle cursors after an inactivity period of 30 minutes. Ignored for cursors that are part of a session. For more information, see Session Idle Timeout.

allowPartialResults

booleano

opcional. Para query 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 shards consultados não estiverem disponíveis.

If find (or subsequent getMore commands) returns partial results because the queried shard(s) aren't available, the find output includes a partialResultsReturned indicator field. If the queried shards are available for the initial find command, but one or more shards become unavailable for subsequent getMore commands, only the getMore commands that run while the shards aren't available include partialResultsReturned in their output.

collation

documento

Opcional.

Opcional. Especifica a agrupamento para utilizar 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

booleano

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 has no effect if MongoDB can satisfy the specified sort using an index, or if the in-memory sort requires less than 100 megabytes of memory.

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

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

let

documento

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 usar uma variável para filtrar os resultados, você deve acessar a variável dentro do operador $expr.

For a complete example using let and variables, see Use Variables in let.

querySettings

documento

Opcional. Configurações de query que se aplicam apenas a esta execução do comando. O documento querySettings aceita os seguintes campos:

• indexHints

• queryFramework

• reject

• comment

• queryKnobs

• maxTimeMS

Para obter descrições desses campos, consulte Campos de comando.

O MongoDB não armazena essas configurações no cluster, e elas não se aplicam a outras query com a mesma forma de query. Para definir configurações de query que persistem para uma forma de query, use setQuerySettings.

O MongoDB combina as configurações que você passa no comando com quaisquer configurações de query armazenadas no cluster para a mesma forma de query. Se ambas as configurações especificarem o mesmo campo, a configuração de cluster armazenar terá precedência.