获取``mongo`` Shell的帮助¶

本页内容

除了 MongoDB Manual 文档之外， mongo shell还在其 “online” 帮助系统中提供额外信息。此文档提供获取这些帮助的概述。

命令行帮助¶

在命令行中使用 --help 选项查看运行 mongo shell的选项列表：

mongo --help

在 mongo shell中查看帮助列表，请输入 help：

help

在 mongo shell中：

使用 show dbs 命令查看服务器上的数据库列表：
```
show dbs
```
2.4 新版功能: show databases 是 show dbs 的别名
要查看db对象可用方法的帮助列表，可调用 db.help() 方法：
```
db.help()
```
输入不带括号 (())的 db.<method name> 查看shell中该方法的实现，如下例，将返回方法 db.updateUser() 的实现：
```
db.updateUser
```

在 mongo shell中：

使用 show collections 命令查看当前数据库中的集合列表：
```
show collections
```
使用 db.<collection>.help() 方法查看集合对象 (例如 db.<collection>)的可用方法的帮助：
```
db.collection.help()
```
<collection> 可以是一个存在的集合的名称，也可指一个不存在的集合。
输入不带括号 (())的方法名 db.<collection>.<method> 查看集合方法的实现，如下例，将返回 save() 方法的实现：
```
db.collection.save
```

当你在 mongo shell中用 find() 方法执行 read operations 时，可使用各种游标方法修改 find() 的行为，用各种JavaScript方法处理 find() 方法返回的游标。

使用 db.collection.find().help() 命令列出所有修改器和游标处理方法：
```
db.collection.find().help()
```
<collection> 可以是一个存在的集合的名称，也可指一个不存在的集合。
要查看游标方法的实现，请输入不带括号(())的 db.<collection>.find().<method> 名，如下例所示，将返回方法 toArray() 的实现：
```
db.collection.find().toArray
```

一些处理游标的有用方法：

hasNext() 检查游标集合是否还有文档。
next() 返回游标当前文档，并向前移动游标位置。
forEach(<function>) 迭代整个游标并对每个游标返回的文档执行 <function> 。 <function> 参数对应每次迭代的文档。

迭代游标，检索游标文档的例子请参看 cursor handling。所有游标方法参看 Cursor 。

在 mongo shell中获取封装类列表，例如 BinData()，在 mongo shell中使用 help misc 命令：

help misc

参见