MongoDB Manual (Version 4.2)> The mongo Shell > Access the mongo Shell Help除了MongoDB文档手册,mongo shell通过在线帮助系统提供了一些额外的信息。本文概述了如何访问这些帮助信息。
- 命令行帮助
- shell帮助
- 数据库帮助
- 集合帮助
- 游标帮助
- 包装对象 帮助
命令行帮助
通过在命令行输入--help来查看mongo shell的帮助文档
mongo --helpshell帮助
在mongo shell中输入help查看帮助文档
help数据库帮助
在mongo shell中：
- 查看服务器数据库列表使用 show dbs命令
show dbsshow databases是show dbs的别称
- 使用db.help()查看db对象的全部帮助方法
db.help()- 在mongo shell中使用不带括号的db.< method name >命令查看一个方法的实现，如下返回方法 db.updateUser()的实现。
db.updateUser如果以访问控制模式运行，根据用户权限不同返回不同的值。可以到listDatabases Behavior 查看详情。
集合帮助
在mongo shell中：
- 使用show collections查看当前数据库全部集合列表。
show collections也可以查看show collections
- 使用db.< collection >.help()查看集合可使用的帮助方法：
db.collection.help()集合名字可以是已存在的也可以是不存在的。
- 在mongo shell中使用不带括号的db.< collection >.< method >命令查看一个集合方法的实现，如下返回 save()方法的实现。
db.collection.save游标帮助
当你在mongo shell中通过find()方法执行读操作，你可以使用各种游标方法修改find()行为，各种JavaScript方法控制游标返回的结果。
- 使用 db.collection.find().help()命令列出可用的修饰符和游标处理方法：
db.collection.find().help()集合名字可以是已存在的也可以是不存在的。
- 在mongo shell中使用不带括号的db.< collection >.find().< method >命令查看一个游标方法的实现，如下返回 toArray()方法的实现。
db.collection.find().toArray处理游标的一些有用方法是：
- hasNext()检查游标是否有更多文档返回
- next()返回下一个文档，并且游标前进一位。
- forEach(< function >)迭代所有游标并将< function >作用于每个文档。< function >需要一个参数对应于每个迭代的文档。
可以通过cursor handling查看更多迭代游标和检索文档的示例。通过Cursor查看更多可用的游标方法。
包装对象帮助
在mongo shell中输入BinData()或者help misc，可以得到一个可用的包装器类列表。
help misc参见mongo shell 方法集。
原文链接：https://docs.mongodb.com/manual/tutorial/access-mongo-shell-help/
译者：金江 MongoDB中文社区翻译小组成员
往期翻译：
The mongo Shell
— mongo 命令行
— 配置 mongo shell
MongoDB CRUD操作
— MongoDB中的CRUD操作
— 批量写操作
— 读关注
数据模型
— MongoDB数据建模介绍
事务
— 事务
— 事务操作
索引
— 2dsphere索引
— 哈希索引
— 索引属性
— 在集合上创建索引
— 度量索引使用情况
安全
— 安全检查列表
— 启用访问控制
— 身份验证
— 审计
—— 配置审计
—— 配置审计过滤器
—— 系统事件审计消息
— 网络和配置强化
— 安全参考
—— system.roles 集合
—— system.users 集合
—— 资源文档
—— 权限操作
复制
— 副本集成员
— 副本集Oplog
— 副本集数据同步
— 副本集部署架构
分片
— 分片键
管理
— 产品说明
— 操作检查表
— 性能
— 备份方法
存储
—— WiredTiger存储引擎
—— 内存存储引擎
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
