访问 mongo shell 帮助

除了 MongoDB 手册中的文档外，mongo shell 还在其 “联机” 帮助系统中提供了一些附加信息。本文档提供了访问此帮助信息的概述。

命令行帮助

要查看启动 mongo shell 的选项和帮助列表，请使用命令行中的 --help 选项：

mongo --help

Shell帮助

若要查看帮助列表，请在 mongo shell 中键入帮助：

help

数据库帮助

在 mongo shell 中：

• 要查看服务器上的数据库列表，请使用 show dbs 命令：

show dbs

show databases 是 show dbs的别名。

• 要查看可以在 db 对象上使用的方法的帮助列表，请调用 db.help() 方法：

db.help()

• 要查看 shell 中方法的实现，请键入 db.<方法名称>，而不带括号(())，如下面的示例所示，该示例将返回方法 db.updateUser() 的实现：

db.updateUser

集合帮助

在 mongo shell 中：

• 若要查看当前数据库中的集合列表，请使用 “show collections” 命令：

show collections

• 要查看集合对象 (例如 db.<collection>) 上可用的方法的帮助，请使用 db.<collection>.help() 方法：

db.collection.help()

<collection> 可以是存在的集合的名称，但您可以指定不存在的集合。

mongodb广告位

• 要查看集合方法实现，请键入 db.<collection>.<method>name，而不带括号(())，如下面的示例所示，它将返回 save() 方法的实现：

db.collection.save

光标帮助

当您使用 mongo shell 中的 find() 方法执行读取操作时，可以使用各种游标方法来修改 find() 行为，并使用各种 JavaScript 方法来处理从 find() 方法返回的游标。

• 要列出可用的修饰符和游标处理方法，请使用 db.collection.find().help() 命令：

db.collection.find().help()

<collection> 可以是存在的集合的名称，但您可以指定不存在的集合。

• 要查看游标方法的实现，请键入 db.<collection>.find().<method>name 而不带括号(())，如下面的示例所示，它将返回 toArray() 方法的实现：

db.collection.find().toArray

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

• hasNext() 它检查游标是否有更多文档要返回。

• next() 返回下一个文档，并将光标位置向前推进一个。

• forEach(<function>) 它迭代整个游标并对游标返回的每个文档应用<function>。<function>需要一个与每次迭代中的文档相对应的参数。

包装对象帮助

要获取 mongo shell 中可用的包装类的列表，如：BinData()。在 mongo shell 中执行 help misc。如下：

help misc