cursor.forEach()
Definição
cursor.forEach(function)
Importante
Método mongosh
Esta página documenta um método
mongosh
. Esta não é a documentação de um driver de idioma específico, como Node.js.Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.
Itera o cursor para aplicar um JavaScript
function
a cada documento a partir do 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
Observação
Este comando é aceito em todos os clusters do MongoDB Atlas. Para obter informações sobre o suporte do Atlas a todos os comandos, consulte Comandos não suportados.
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 tem a seguinte sintaxe:
db.collection.find().forEach( <function> )
Campos de método
O método aceita o seguinte campo:
Campo | Tipo | Descrição |
---|---|---|
function | Código JavaScript | Função a ser aplicada a cada documento retornado do cursor. A assinatura de função inclui um campo que armazena o documento atual que é lido no cursor. |
Exemplos
Crie a coleção users
:
db.users.insertMany( [ { name: "John" }, { name: "Jane" } ] )
O exemplo seguinte utiliza forEach()
com o método find()
para imprimir os nomes de usuário que são lidos a partir da coleção users
. myDoc
armazena o documento atual.
db.users.find().forEach( function( myDoc ) { print( "User name: " + myDoc.name ) } )
Saída de exemplo:
User name: John User name: Jane
A partir de mongosh
2.1.0, você também pode usar for-of
loops. O exemplo a seguir retorna os mesmos resultados do exemplo anterior:
for ( const myDoc of db.users.find() ) { print( "User name: " + myDoc.name ) }
Saiba mais
Para um método que tem funcionalidade semelhante, consulte cursor.map()
.