警告
以下文档涉及mongo Shell,包含在MongoDB Server下载中。有关新MongoDB Shell ()mongosh 的信息,请参阅mongosh文档。
要了解这两个 Shell 之间的差异,请参阅mongo shell和 mongosh 的比较。
除了MongoDB手册中的文档外, mongo shell还在其“在线”帮助系统中提供了一些附加信息。 本文档概述了如何访问此帮助信息。
命令行帮助
要查看启动mongo shell的选项列表和帮助,请命令行使用--help选项:
mongo --help
Shell 帮助
要查看帮助列表,请在mongo shell中键入 help:
help
数据库帮助
在mongo shell中:
要查看服务器上的数据库列表,请使用
show dbs命令: [ 1 ]show dbs show databases是show dbs的别名。要查看可用于
db对象的方法的帮助列表,请调用db.help()方法:db.help() 要在shell中查看方法的实施,请键入不带括号 (
()) 的db.<method name>,如以下示例,该示例将返回方法db.updateUser()的实施:db.updateUser
| [1] | 如果部署在访问权限控制下运行,则该操作会根据用户权限返回不同的值。 有关详细信息,请参阅listDatabases 行为。 |
集合帮助
在mongo shell中:
要查看当前数据库中的集合列表,请使用
show collections命令:show collections 要查看集合对象上可用方法的帮助(例如
db.<collection>),使用db.<collection>.help()方法:db.collection.help() <collection>可以是存在的集合名称,但也可以指定不存在的集合。要查看集合方法的实施,请键入不带括号的
db.<collection>.<method>名称 (()),如下示例,该示例将返回insertOne()方法的实施:db.collection.insertOne
游标帮助
当您在 find()中使用mongoshell 方法执行 读操作 时,您可以使用各种游标方法来修改 行为,并使用各种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>需要一个与每次迭代中的文档相对应的单个参数。
包装器对象帮助
要获取mongo shell中可用的包装器类的列表(例如 BinData()),请在mongo shell中键入 help misc:
help misc