访问 mongo Shell 帮助

在本页面

除了MongoDB Manual中的文档之外，mongo shell 在其“在线”帮助系统中提供了一些其他信息。本文档概述了访问此帮助信息的过程。

命令行帮助

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

mongo --help

Shell Help

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

help

Database Help

在mongo shell 中：

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

show databases是show dbs的别名。

  • 要查看可在db对象上使用的方法的帮助列表，请调用db.help()方法：
db.help()
  • 要查看 Shell 中方法的实现，请键入db.<method name>而不带括号(())，如以下示例所示，它将返回方法db.updateUser()的实现：
db.updateUser

Collection Help

在mongo shell 中：

  • 要查看当前数据库中的集合列表，请使用show collections命令：
show collections
  • 要查看集合对象上可用方法的帮助(例如db.<collection>)，请使用db.<collection>.help()方法：
db.collection.help()

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

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

Cursor Help

在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