mongosh帮助

本文档概述了 mongosh.

提示：

在 中访问帮助时mongosh，您可以交替使用.help()和 .help语法。

命令行帮助

mongosh要查看用于运行可执行文件和连接到部署的选项，请使用--help 命令行中的选项：

mongosh --help

mongoshshell 帮助

要查看控制台中可用的命令列表mongosh，请help在正在运行的mongosh控制台中键入：

help

数据库帮助

您可以从控制台内部查看数据库级别的信息 mongosh：

默认情况下mongosh在提示中显示当前数据库。您还可以通过运行命令查看当前数据库db：

db

显示可用数据库

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

show dbs

show databases是 的别名show dbs。

提示：

数据库列表将根据您的访问权限而改变。有关查看数据库的访问限制的详细信息，请参阅listDatabases.

显示数据库方法

查看列表数据库方法你可以在db对象上使用，运行 db.help():

db.help()

输出类似于以下缩写列表：

Database Class:
  getMongo                      Returns the current database connection
  getName                       Returns the name of the DB
  getCollectionNames            Returns an array containing the names of all collections in the current database.
  getCollectionInfos            Returns an array of documents with collection information, i.e. collection name and options, for the current database.
  runCommand                    Runs an arbitrary command on the database.
  adminCommand                  Runs an arbitrary command against the admin database.
  ...

显示特定数据库方法的帮助

要在 中查看特定数据库方法的帮助mongosh，请键入 db.<method name>，然后键入.help或.help()。以下示例返回帮助db.adminCommand() 方法：

db.adminCommand.help()

输出类似于以下内容：

db.adminCommand({ serverStatus: 1 }):
  Runs an arbitrary command against the admin database.
  For more information on usage: https://www.mongodb.com/docs/manual/reference/method/db.adminCommand

显示数据库方法的其他使用详细信息

要查看 中数据库方法的其他使用详细信息mongosh，请键入db.<method name>不带括号 ( ()) 的。以下示例返回有关的详细信息 db.adminCommand()方法：

db.adminCommand

输出类似于以下内容：

[Function: adminCommand] AsyncFunction {
  apiVersions: [ 1, Infinity ],
  serverVersions: [ '3.4.0', '999.999.999' ],
  returnsPromise: true,
  topologies: [ 'ReplSet', 'Sharded', 'LoadBalanced', 'Standalone' ],
  returnType: { type: 'unknown', attributes: {} },
  deprecated: false,
  platforms: [ 0, 1, 2 ],
  isDirectShellCommand: false,
  acceptsRawInput: false,
  shellCommandCompleter: undefined,
  help: [Function (anonymous)] Help
}

收款帮助

您可以从控制台内部查看集合级别信息 mongosh。

这些帮助方法接受集合名称，<collection>但您也可以使用通用术语“集合”，甚至可以使用不存在的集合。

列出当前数据库中的集合

要查看当前数据库中的集合列表，请使用以下 show collections命令：

show collections

输出show collections指示集合是否是 时间序列集合或只读查看。

managementFeedback          [view]
survey
weather                     [time-series]
system.buckets.weather
system.views

在前面的示例中：

• managementFeedback是一个看法
• weather是一个时间序列
• survey是一个集合
• system.buckets.weather是系统生成的集合，支持weather时间序列
• system.views是一个系统生成的集合，支持对其他集合的视图

显示收集方法

要查看集合对象上可用的方法列表，请使用以下 db.<collection>.help()方法：

db.collection.help()

<collection>可以是现有或不存在的集合的名称。

输出类似于以下缩写列表：

Collection Class:
  aggregate          Calculates aggregate values for the data in a collection or a view.
  bulkWrite          Performs multiple write operations with controls for order of execution.
  count              Returns the count of documents that would match a find() query for the collection or view.
  countDocuments     Returns the count of documents that match the query for a collection or view.
  deleteMany         Removes all documents that match the filter from a collection.
  deleteOne          Removes a single document from a collection.
  ...

显示特定收集方法的帮助

要在 中查看特定收集方法的帮助mongosh，请使用 db.<collection>.<method name>，然后使用.help或 .help()。

以下示例显示帮助db.collection.insertOne():

db.collection.insertOne.help()

输出类似于以下内容：

db.collection.insertOne(document, options):
Inserts a document into a collection.
For more information on usage: https://www.mongodb.com/docs/manual/reference/method/db.collection.insertOne

显示收集方法的其他详细信息

要查看集合方法的其他详细信息，请键入方法名称， db.<collection>.<method>不带括号 ( ())。

以下示例返回有关的详细信息 insertOne()方法：

db.collection.insertOne

输出类似于以下内容：

[Function: insertOne] AsyncFunction {
  apiVersions: [ 1, Infinity ],
  serverVersions: [ '3.2.0', '999.999.999' ],
  returnsPromise: true,
  topologies: [ 'ReplSet', 'Sharded', 'LoadBalanced', 'Standalone' ],
  returnType: { type: 'unknown', attributes: {} },
  deprecated: false,
  platforms: [ 0, 1, 2 ],
  isDirectShellCommand: false,
  acceptsRawInput: false,
  shellCommandCompleter: undefined,
  help: [Function (anonymous)] Help
}

游标帮助

修改读取操作那个用 find(), 使用游标方法。

要列出可用的修饰符和游标处理方法，请使用以下 db.collection.find().help()命令：

db.collection.find().help()

此帮助调用接受集合名称，<collection>但您也可以使用通用术语“集合”，甚至可以使用不存在的集合。

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

• hasNext()检查游标是否有更多文档。
• next()返回下一个文档并将光标位置向前移动一个。
• forEach() 将 应用于 <function>游标返回的每个文档。

有关可用游标方法的列表，请参见光标。

BSON 类帮助

mongosh提供帮助方法BSON类。帮助方法提供了 BSON 类的简要概述和包含更多信息的链接。

要访问 BSON 类的帮助，请.help()在类名或类的实例化实例上运行：

<BSON class>.help()
// or
<BSON class>().help()

例如，要查看ObjectIdBSON 类的帮助，请运行以下命令之一：

ObjectId.help()

ObjectId().help()

mongosh两种方法返回相同的输出.help()：

The ObjectId BSON Class:
For more information on usage: https://mongodb.github.io/node-mongodb-native/3.6/api/ObjectID.html

mongosh为以下 BSON 类提供帮助方法：

• BinData
• Code
• DBRef
• MinKey
• MaxKey
• NumberDecimal
• NumberInt
• NumberLong
• ObjectId
• Symbol （已弃用）
• Timestamp

命令助手

mongosh提供以下方法和命令来包装某些数据库命令并获取有关您的部署的信息：

翻译：韩鹏帅

原文：mongosh Help