db.collection.findOne() (método mongosh)

Definição

db.collection.findOne(query, projection, options)

Retorna um documento que satisfaça os critérios de query especificados na coleção ou visualização.

O documento devolvido pode variar dependendo do número de documentos que correspondem aos critérios de consulta e do plano de consulta usado:

Número de documentos correspondentes	Plano de query	Resultado
0	Any	O método retorna null
1	Any	O método retorna o documento que satisfaz os critérios de consulta especificados.
2 ou mais	Varredura de collection	O método retorna o primeiro documento de acordo com a ordem natural. Em coleções limitadas, a ordem natural é a mesma que a ordem de inserção.
2 ou mais	Varredura de índice	O método retorna o primeiro documento recuperado do índice.

Importante

Se o plano de consulta for alterado para usar um índice diferente, o método poderá retornar um documento diferente. Se o seu caso de uso exigir que um registro específico seja escolhido consistentemente, você deverá usar o documento options para especificar uma classificação. Para obter detalhes sobre como usar findOne() com um documento options , consulte o exemplo.

Se você especificar um parâmetro projection, findOne() retornará um documento que contém apenas os campos projection. O campo _id está sempre incluído, a menos que seja explicitamente removido.

Observação

Embora semelhante ao método find(), o método findOne() retorna um documento em vez de um cursor.

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

Sintaxe

O método findOne() tem o seguinte formato:

db.collection.findOne( <query>, <projection>, <options> )

O método findOne() utiliza os seguintes parâmetros:

Comportamento

{ field1: <value>, field2: <value> ... }

Exemplos

Os exemplos nesta página usam dados do conjunto de dados de amostra sample_mflix. Para obter detalhes sobre como carregar esse conjunto de dados em sua implantação autogerenciada do MongoDB , consulte Carregar o conjunto de dados de amostra. Se você fez modificações nos bancos de dados de amostra, talvez seja necessário descartar e recriar os bancos de dados para executar os exemplos nesta página.

db.movies.findOne()

db.movies.findOne(
   {
      $or: [
            { title: /^T/ },
            { year: { $lt: 1950 } }
            ]
   }
)

db.movies.findOne(
   { },
   { title: 1, genres: 1, imdb: 1 }
)

db.movies.findOne(
   { cast: 'Al Pacino' },
   { _id: 0, 'imdb.votes': 0, fullplot: 0 }
)

db.movies.findOne(
   { },
   { },
   { sort: { year: 1 } }
)

var myDocument = db.movies.findOne();
if (myDocument) {
   var myTitle = myDocument.title;
   print(myTitle);
}

db.movies.findOne(
   { $expr: { $eq: [ "$title", "$$targetTitle" ] } },
   { _id: 0, title: 1, year: 1 },
   { let : { targetTitle: "The Godfather" } }
)

{ year: 1972, title: 'The Godfather' }