/ /

Acceder a `mongo` Ayuda de shell

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 5.0, consulta el Procedimientos de actualización de MongoDB 6.0 .

Advertencia

El siguiente documento se relaciona con el mongo shell, incluida en la descarga del servidor MongoDB. Para obtener información sobre la nueva MongoDB Shell (mongosh), consulta la documentación de mongosh.

Para entender las diferencias entre los dos shells, consulte Comparación entre el mongo Shell y mongosh.

Además de la documentación en el Manual de MongoDB, el shell mongo ofrece información adicional en su sistema de ayuda "en linea". Este documento proporciona una descripción general del acceso a esta información de ayuda.

Ayuda de línea de comandos

Para ver la lista de opciones y la ayuda para iniciar el shell mongo, utiliza la opción --help desde la línea de comandos:

mongo --help

Ayuda de shell

Para ver la lista de ayuda, en el mongo shell, escribe help:

help

Ayuda de base de datos

En la shell mongo:

Para ver la lista de bases de datos en el servidor, usa el comando show dbs: [1]
```
show dbs
```
show databases es un alias para show dbs.
Para ver la lista de ayudas para los métodos que puedes utilizar en el objeto db, llama al método db.help():
```
db.help()
```
Para ver la implementación de un método en el shell, escribe el db.<method name> sin el paréntesis (()), como en el siguiente ejemplo que devolverá la implementación del método db.updateUser():
```
db.updateUser
```

[1]	Si la implementación se ejecuta con control de acceso, la operación retorna diferentes valores en función de los privilegios de los usuarios. Consulta comportamiento de listDatabases para obtener más detalles.

Ayuda de la colección

En la shell mongo:

Para ver la lista de colecciones en la base de datos actual, utilizar el comando show collections:
```
show collections
```
Para ver la ayuda de los métodos disponibles en los objetos de la colección (por ejemplo, db.<collection>), utiliza el método db.<collection>.help():
```
db.collection.help()
```
<collection> puede ser el nombre de una colección que exista, aunque puede especificar una colección que no exista.
Para ver la implementación del método de colección, escribe el nombre db.<collection>.<method> sin el paréntesis (()), como en el siguiente ejemplo que devolverá la implementación del método insertOne():
```
db.collection.insertOne
```

Ayuda del cursor

Cuando realiza operaciones de lectura con el método find() en el shell mongo, puedes utilizar varios métodos de cursor para modificar el comportamiento del find() y varios métodos de JavaScript para gestionar el cursor que devuelve el método find().

Para enumerar los métodos disponibles de manejo de modificadores y cursores, usa el comando db.collection.find().help():
```
db.collection.find().help()
```
<collection> puede ser el nombre de una colección que exista, aunque puede especificar una colección que no exista.
Para ver la implementación del método cursor, escribe el nombre db.<collection>.find().<method> sin los paréntesis (()), como en el siguiente ejemplo que devolverá la implementación del método toArray():
```
db.collection.find().toArray
```

Algunos métodos útiles para manejar cursores son:

hasNext() que comprueba si el cursor tiene más documentos para devolver.
next() que devuelve el siguiente documento y avanza la posición del cursor hacia adelante en uno.
forEach(<function>) que itera por todo el cursor y aplica el <function> a cada documento devuelto por el cursor. El <function> espera un único argumento que corresponde al documento de cada iteración.

Para ejemplos sobre la iteración de un cursor y la recuperación de documentos del cursor, consulta manejo de cursor. Consulta también cursor para ver todos los métodos de cursor disponibles.

Ayuda de objeto contenedor

Para obtener una lista de las clases contenedoras disponibles en el mongo shell, como BinData(), escribe help misc en el mongo shell:

help misc

Tip

mongosh Métodos

Volver

Configura el shell de mongo

Escribir scripts para la shell de mongo