- The
mongo
Shell > - Access the
mongo
Shell Help
Access the mongo
Shell Help¶
On this page
In addition to the documentation in the MongoDB Manual, the mongo
shell provides some additional
information in its “online” help system. This document provides an
overview of accessing this help information.
Command Line Help¶
To see the list of options and help for starting the mongo
shell, use the --help
option from the command line:
mongo --help
Database Help¶
In the mongo
shell:
To see the list of databases on the server, use the
show dbs
command:show dbs
New in version 2.4:
show databases
is now an alias forshow dbs
To see the list of help for methods you can use on the
db
object, call thedb.help()
method:db.help()
To see the implementation of a method in the shell, type the
db.<method name>
without the parenthesis (()
), as in the following example which will return the implementation of the methoddb.updateUser()
:db.updateUser
Collection Help¶
In the mongo
shell:
To see the list of collections in the current database, use the
show collections
command:show collections
To see the help for methods available on the collection objects (e.g.
db.<collection>
), use thedb.<collection>.help()
method:db.collection.help()
<collection>
can be the name of a collection that exists, although you may specify a collection that doesn’t exist.To see the collection method implementation, type the
db.<collection>.<method>
name without the parenthesis (()
), as in the following example which will return the implementation of thesave()
method:db.collection.save
Cursor Help¶
When you perform read operations with
the find()
method in the
mongo
shell, you can use various cursor methods to modify
the find()
behavior and various
JavaScript methods to handle the cursor returned from the
find()
method.
To list the available modifier and cursor handling methods, use the
db.collection.find().help()
command:db.collection.find().help()
<collection>
can be the name of a collection that exists, although you may specify a collection that doesn’t exist.To see the implementation of the cursor method, type the
db.<collection>.find().<method>
name without the parenthesis (()
), as in the following example which will return the implementation of thetoArray()
method:db.collection.find().toArray
Some useful methods for handling cursors are:
hasNext()
which checks whether the cursor has more documents to return.next()
which returns the next document and advances the cursor position forward by one.forEach(<function>)
which iterates the whole cursor and applies the<function>
to each document returned by the cursor. The<function>
expects a single argument which corresponds to the document from each iteration.
For examples on iterating a cursor and retrieving the documents from the cursor, see cursor handling. See also Cursor for all available cursor methods.