cursor.showRecordId() (método mongosh)

Definição

cursor.showRecordId()

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação para um driver específico de idioma, como Node.js.

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

Anexa o campo $recordId aos documentos retornados por uma query. $recordId é a chave interna que identifica exclusivamente um documento em uma collection. formato $recordId :

'$recordId': Long(<int>)

Retorna:	Um objeto de cursor modificado que contém os campos do documento e o campo $recordId anexado.

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 utiliza esta coleção pizzas :

db.pizzas.insertMany( [   { type: "pepperoni", size: "small", price: 4 },   { type: "cheese", size: "medium", price: 7 },   { type: "vegan", size: "large", price: 8 }] )

O exemplo find() a seguir usa showRecordId() para anexar $recordId aos campos do documento pizza na saída:

db.pizzas.find().showRecordId()

Saída de exemplo:

[   {      _id: ObjectId("62ffc70660b33b68e8f30435"),      type: 'pepperoni',      size: 'small',      price: 4,      '$recordId': Long("1")   },   {      _id: ObjectId("62ffc70660b33b68e8f30436"),      type: 'cheese',      size: 'medium',      price: 7,      '$recordId': Long("2")   },   {      _id: ObjectId("62ffc70660b33b68e8f30437"),      type: 'vegan',      size: 'large',      price: 8,      '$recordId': Long("3")   }]