使用 mongo Shell帮助

在本页面

[success] Note

下面的文档是MongoDB服务器下载.中包含的mongo shell。有关新的MongoDB Shell ,mongosh的信息,请参考mongosh文档

要了解这两种shell的区别,请参阅Comparison of the mongo Shell and mongosh.

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

命令行帮助

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

mongo --help

Shell帮助

当需要查看帮助列表时,请在mongoshell中键入help

help

数据库帮助

mongo shell中:

  • 当需要查看服务器上的数据库列表,请使用show dbs命令:

show dbs

show databaseshow dbs的别名

  • 当需要查看可在db对象上使用的方法的帮助列表,请调用db.help()方法:

db.help()
  • 当需要查看在 shell中查看某些方法的具体实现,请键入不带括号(())的db.<method name>,如以下示例所示,它将返回方法db.updateUser()的实现:

db.updateUser

如果部署使用访问控制运行,则该操作将根据用户权限返回不同的值。 有关详细信息,请参见listDatabases行为。

表级别帮助

mongo shell中:

  • 要查看当前数据库中的集合列表,请使用show collections命令:

show collections

另可参考:show collections

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

db.collection.help()

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

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

db.collection.save

游标相关帮助

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

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

db.collection.find().help()

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

  • 要查看cursor方法的实现,请输入不带括号(())的db.<collection>.find().<method>名称,如以下示例所示,它将返回toArray()方法的实现:

db.collection.find().toArray

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

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

  • next()返回下一个文档,并将光标位置向前移动一个。

  • 迭代整个游标,并将<function>应用于光标返回的每个文档。<function>期望一个参数,该参数对应于每次迭代的文档。

    有关迭代游标和从游标中检索文档的示例,请参见 cursor handling。有关所有可用的游标方法,另请参见Cursor

包装对象帮助

要获取mongo shell中可用的包装器类的列表,例如BinData(),请在mongo shell中键入help misc

help misc

另可参考: mongo Shell Methods

译者:王恒 金江

校对:杨帅