--注意:
1)下述文档属于下载MongoDB服务器包含的mongo shell。新MongoDB shell,mongosh,更多信息请参考mongosh文档。
为了理解两个shell间的差别,请参考mongo shell和mongsh比较部分。
除了MongDB手册中的文档,mongo shell在线帮助系统还提供了一些另外的信息。该文档提供了访问这些帮助信息的概览。
一.命令行帮助
为了查看启动mongo shell的选项和帮助,从命令行使用--help选项:
$ mongo --help
二.shell帮助
为了查看帮助列表,在mongo shell中输入help:
> help
三.数据库帮助
mongo shell中:
1.查看服务器上数据库列表,使用show dbs命令:
> show dbs
show databases为show dbs的别名。
2.查看您能使用的数据库对象方法的帮助列表,调用db.help()方法:
> db.help()
3.查看shell中方法的实现,输入不带括号(())的db.<method name>,就像下例中将返回db.updateUser()的实现:
> db.updateUser
四.集合帮助
mongo shell中:
1.查看当前数据库中集合列表,用show collections命令:
> show collections
2.查看集合对象(例如:db.<collection>)可用方法的帮助,用db.<collection>.help()方法:
> db.collection.help()
<collection>可以是存在集合的名字,虽然您能指定一个不存在的集合。
3.查看集合方法的实现,输入不带括号(())的db.<collection>.<methord>名字,如下例所示将返回save()方法的实现:
> db.collection.save
五.游标帮助
当您在mongo shell中用find()方法执行读操作时,您能用各种游标方法修改find()行为和用各种JavaScript方法处理从find()方法返回的游标。
1.为了列出可用的修饰符和游标处理方法,使用db.collection.find().help()命令:
> db.collection.find().help()
<collection>能是存在集合的名字,虽然您能指定一个不存在的集合。
2.为了查看游标方法的实现,输入不带括号(())的db.<collection>.find().<mthod>名字,就如下例所示将返回toArray()方法的实现:
> db.collection.find().toArray
一些处理游标的有用的方法为:
1)hasNext():检查游标是否有更多的文档返回;
2)next():返回下一个文档并将游标位置向前移动一位;
3)forEach(<function>):迭代整个游标且对游标返回的每个文档应用<function>。<function>希望有一个与每次迭代返回文档相对应的参数。
游标迭代和获取文档相关的例子,请参考游标处理相关文档。有关所有可用游标方法请参考游标相关文档。
六.封装对象帮助
为了查看mongo shell中可用封装类的列表,像BinData(),在mongo shell中输入help misc:
> help misc