Acesse a `mongo` shell ajuda do shell

Esta versão da documentação foi arquivada e não é mais suportada. Para atualizar seu sistema do 5.0, consulte osprocedimentos de atualização do MongoDB 6.0 .

Aviso

O documento a seguir pertence ao mongo shell, incluído no download do MongoDB Server. Para obter informações sobre a nova shell MongoDB (),mongosh consulte a documentação mongosh.

Para entender as diferenças entre as duas conchas, consulte Comparação da shell mongo e mongosh.

Além da documentação no Manual do MongoDB, o shell mongo fornece algumas informações adicionais em seu sistema de ajuda "online". Este documento fornece uma visão geral de como acessar essas informações de ajuda.

Ajuda da linha de comando

Para ver a lista de opções e ajuda para iniciar o shell mongo , use a opção --help da linha de comando:

mongo --help

Ajuda da Shell

Para visualizar a lista de ajuda, na shell mongo , digite help:

help

Ajuda do Banco de Dados

mongo shellNa :

Para ver a lista de bancos de dados no servidor, use o comando show dbs : [1]
```
show dbs
```
show databases é um alias para show dbs.
Para ver a lista de ajuda para os métodos que você pode usar no objeto db , chame o método db.help() :
```
db.help()
```
Para visualizar a implementação de um método na shell, digite o db.<method name> sem o parêntese (()), como no exemplo a seguir, que retornará a implementação do método db.updateUser():
```
db.updateUser
```

[1]	Se o sistema for executado com controle de acesso, a operação retornará valores diferentes com base nos privilégios do usuário. Consulte Comportamento do listDatabases para obter detalhes.

Ajuda de coleção

mongo shellNa :

Para visualizar a lista de coleções no banco de dados atual, utilize o comando show collections:
```
show collections
```
Para ver a ajuda para os métodos disponíveis nos objetos de coleção (por exemplo, db.<collection>), use o método db.<collection>.help() :
```
db.collection.help()
```
<collection> pode ser o nome de uma collection que existe, embora você possa especificar uma collection que não existe.
Para ver a implementação do método de coleção, digite o nome db.<collection>.<method> sem o parêntese (()), como no exemplo a seguir, que retornará a implementação do método insertOne() :
```
db.collection.insertOne
```

Ajuda do cursor

Ao executar operações de leitura com o método find() no shell mongo , você pode usar vários métodos de cursor para modificar o comportamento find() e vários métodos JavaScript para lidar com o cursor retornado pelo método find() .

Para listar os métodos de manuseio do modificador e cursor disponíveis, utilize o comando db.collection.find().help():
```
db.collection.find().help()
```
<collection> pode ser o nome de uma collection que existe, embora você possa especificar uma collection que não existe.
Para visualizar a implementação do método do cursor, digite o nome do db.<collection>.find().<method> sem o parêntese (()), como no exemplo a seguir, que retornará a implementação do método toArray() :
```
db.collection.find().toArray
```

Alguns métodos úteis para lidar com cursores são:

hasNext() que verifica se o cursor tem mais documentos para retornar.
next() que retorna o próximo documento e avança a posição do cursor para frente por um.
forEach(<function>) que itera todo o cursor e aplica o <function> a cada documento retornado pelo cursor. O <function> espera um único argumento que corresponda ao documento de cada iteração.

Para obter exemplos sobre como iterar um cursor e recuperar os documentos do cursor, consulte manuseio de cursor. Consulte também Cursor para todos os métodos de cursor disponíveis.

Ajuda do Objeto Wrapper

Para obter uma lista das classes de wrapper disponíveis na shell mongo , como BinData(), digite help misc na shell mongo :

help misc

Dica

mongosh Métodos

Voltar

Configure o shell mongo

Escrever scripts para o shell mongo