除了 MongoDB 手册中的文档, mongo shell 在它的 "online" 帮助系统中提供了一些附加信息. 本文档提供了访问此信息的概述.
命令行帮助
查看启动 mongo shell 的选项列表和版主信息, 从命令行使用 --help 选项.
mongo --help
Shell 帮助
在 mongo shell 里面查看帮助列表, 输入 help
:
help
数据库帮助
在 mongo shell 中:
-
在服务器上查看数据库列表, 使用
show dbs
命令:show dbs
版本2.4 新功能:
show databases
是show dbs
的别名. -
你可以在
db
对象上调用 db.help() 方法来查看方法的帮助列表:db.help()
-
在 shell 中查看中查看方法的实现. 输入不带引号(())的
db.<method name>
, 下面的例子将返回方法db.updateUser()
方法的实现.db.updateUser
集合帮助
在 mongo shell 中:
-
在当前数据库中查看集合列表, 使用
show collections
命令:show collections
-
查看 collection 对象上可用方法的帮助(例如:
db.<collection>
), 使用db.<collection>.help()
方法:db.collection.help()
<collection>
可以是存在的集合的名称. 虽然你可以指定一个不存在的集合. -
查看 collection 方法的实现. 键入不带括号(())的
db.<collection>.<method>
名称. 下面的例子将返回方法save()
方法的实现.db.collection.save
游标帮助
当你在 mongo shell 中使用 find()
方法执行读操作的时候, 你可以使用各种游标方法来修改 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
另请参阅:
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。