`mongosh` 方法

在此页面上

Collection

Cursor
Database
查询计划缓存
批量写入操作
用户管理
角色管理
复制
分片
构造函数
连接
原生
客户端字段级加密 (Client-Side Field Level Encryption)

注意

MongoDB 中的 JavaScript

虽然这些方法使用了 JavaScript，但与 MongoDB 的大多数交互并不使用 JavaScript，而是使用交互应用程序语言中的一致驱动程序。

注意

有关特定方法（包括事务语法和示例）的详细信息，请单击该方法的参考页面链接。

Collection

名称	说明
`db.collection.aggregate()`	提供对聚合管道的访问权限。
`db.collection.bulkWrite()`	提供批量写入操作功能。
`db.collection.count()`	封装 `count`，返回集合中或视图中文档的计数。
`db.collection.countDocuments()`	使用 `$sum` 表达式封装 `$group` 聚合阶段，返回集合或视图中文档的计数。
`db.collection.createIndex()`	在集合上构建索引。
`db.collection.createIndexes()`	为集合构建一个或多个索引。
`db.collection.dataSize()`	返回集合的大小。封装 `collStats` 的输出中的 `size` 字段。
`db.collection.deleteOne()`	删除集合中的单个文档。
`db.collection.deleteMany()`	删除集合中的多个文档。
`db.collection.distinct()`	返回具有指定字段的不同值的文档数组。
`db.collection.drop()`	从数据库中删除指定的集合。
`db.collection.dropIndex()`	删除集合的指定索引。
`db.collection.dropIndexes()`	删除集合上的所有索引。
`db.collection.ensureIndex()`	已删除。使用 `db.collection.createIndex()`。
`db.collection.estimatedDocumentCount()`	封装 `count`，返回集合或视图中文档的大致计数。
`db.collection.explain()`	返回各种方法的查询执行信息。
`db.collection.find()`	对集合或视图执行查询，并返回游标对象。
`db.collection.findAndModify()`	以原子方式修改并返回单个文档。
`db.collection.findOne()`	执行查询并返回单个文档。
`db.collection.findOneAndDelete()`	查找并更新单个文档。
`db.collection.findOneAndReplace()`	查找并更新单个文档。
`db.collection.findOneAndUpdate()`	查找并更新单个文档。
`db.collection.getIndexes()`	返回说明集合上现有索引的一组文档。
`db.collection.getShardDistribution()`	对于分片集群中的集合，`db.collection.getShardDistribution()` 报告数据段分布的数据。
`db.collection.getShardVersion()`	分片集群的内部诊断方法。
`db.collection.hideIndex()`	在查询规划器中隐藏索引。
`db.collection.insertOne()`	将新文档插入集合。
`db.collection.insertMany()`	将多份文档插入集合。
`db.collection.isCapped()`	报告集合是否为固定大小集合。
`db.collection.latencyStats()`	返回集合的延迟统计信息。
`db.collection.mapReduce()`	执行 map-reduce 样式的数据聚合。
`db.collection.reIndex()`	重新构建集合上的所有现有索引。
`db.collection.remove()`	从集合删除文档。
`db.collection.renameCollection()`	更改集合的名称。
`db.collection.replaceOne()`	替换集合中的单个文档。
`db.collection.stats()`	报告集合的状态。提供 `collStats` 的封装器。
`db.collection.storageSize()`	报告集合使用的总大小（以字节为单位）。提供 `collStats` 输出的 `storageSize` 字段的封装器。
`db.collection.totalIndexSize()`	报告集合上索引使用的总大小。提供 `collStats` 输出的 `totalIndexSize` 字段的封装器。
`db.collection.totalSize()`	报告集合的总大小，其中包括集合中所有文档和所有索引的大小。
`db.collection.unhideIndex()`	从查询规划器中取消隐藏索引。
`db.collection.updateOne()`	修改集合中的单个文档。
`db.collection.updateMany()`	修改集合中的多个文档。
`db.collection.watch()`	在集合上建立变更流。
`db.collection.validate()`	对集合执行诊断操作。

Cursor

名称	说明
`cursor.addOption()`	添加可修改查询行为的特殊传输协议标志。
`cursor.allowDiskUse()`	允许 MongoDB 在处理阻塞排序操作时使用磁盘上的临时文件来存储超过 100 MB 系统内存限制的数据。
`cursor.allowPartialResults()`	如果一个或多个查询的分片不可用，则允许对分片集合进行 `db.collection.find()` 操作，以返回部分结果，而不是错误。
`cursor.batchSize()`	控制 MongoDB 将在单个网络消息中返回到客户端的文档数量。
`cursor.close()`	关闭游标并释放关联的服务器资源。
`cursor.isClosed()`	如果游标关闭，则返回 `true`。
`cursor.collation()`	指定 `db.collection.find()` 返回的游标的排序规则。
`cursor.comment()`	将注释附加到查询，以允许在日志和 system.profile 集合中进行跟踪。
`cursor.count()`	修改游标，以返回结果集中的文档数量，而不是文档本身。
`cursor.explain()`	报告游标的查询执行计划。
`cursor.forEach()`	对游标中的每个文档应用 JavaScript 函数。
`cursor.hasNext()`	如果游标包含文档且可迭代，则返回 true。
`cursor.hint()`	强制 MongoDB 对查询使用特定索引。
`cursor.isExhausted()`	如果游标已关闭且批处理中没有剩余对象，则返回 `true`。
`cursor.itcount()`	通过获取和迭代结果集，计算游标客户端中的文档总数。
`cursor.limit()`	限制游标结果集的大小。
`cursor.map()`	将函数应用于游标中的每个文档，并收集数组中的返回值。
`cursor.max()`	指定游标的排除式索引上限。用于结合使用 `cursor.hint()`
`cursor.maxTimeMS()`	指定在游标上处理操作的累计时间限制（以毫秒为单位）。
`cursor.min()`	指定游标的包含式索引下限。用于结合使用 `cursor.hint()`
`cursor.next()`	返回游标中的下一个文档。
`cursor.noCursorTimeout()`	指示服务器避免在一段时间不活动后自动关闭游标。
`cursor.objsLeftInBatch()`	返回当前游标批处理中剩余文档的数量。
`cursor.pretty()`	将游标配置为以易于阅读的格式显示结果。
`cursor.readConcern()`	为 `find()` 操作指定读关注。
`cursor.readPref()`	为游标指定读取偏好，以控制客户端如何将查询定向到副本集。
`cursor.returnKey()`	修改游标以返回索引键而不是文档。
`cursor.showRecordId()`	向游标返回的每个文档添加内部存储引擎 ID 字段。
`cursor.size()`	应用 `skip()` 和 `limit()` 方法后，返回游标中文档的计数。
`cursor.skip()`	返回一个游标，该游标仅在传递或跳过多个文档后才开始返回结果。
`cursor.sort()`	根据排序规范返回排序的结果。
`cursor.tailable()`	将游标标记为循环式。仅对超过固定大小集合的游标有效。
`cursor.toArray()`	返回一个数组，其中包含游标返回的所有文档。

Database

名称	说明
`db.adminCommand()`	对 `admin` 数据库运行命令。
`db.aggregate()`	运行不需要底层集合的管理/诊断管道。
`db.commandHelp()`	返回数据库命令的帮助信息。
`db.createCollection()`	创建新的集合或视图。通常用于创建固定大小集合。
`db.createView()`	创建视图。
`db.currentOp()`	报告当前正在进行的操作。
`db.dropDatabase()`	删除当前数据库。
`db.fsyncLock()`	刷新写入磁盘并锁定数据库，以防止写入操作并协助备份操作。封装 `fsync`。
`db.fsyncUnlock()`	支持在使用 `db.fsyncLock()` 锁定的数据库上继续写入。
`db.getCollection()`	返回集合或视图对象。用于访问名称在 `mongosh` 中无效的集合。
`db.getCollectionInfos()`	返回当前数据库中所有集合和视图的集合信息。
`db.getCollectionNames()`	列出当前数据库中的所有集合和视图。
`db.getLogComponents()`	返回该日志消息详细程度。
`db.getMongo()`	返回当前连接的 `Mongo()` 连接对象。
`db.getName()`	返回当前数据库的名称。
`db.getProfilingStatus()`	返回反映当前分析级别和分析阈值的文档。
`db.getReplicationInfo()`	返回包含复制统计数据的文档。
`db.getSiblingDB()`	提供对指定数据库的访问权限。
`db.hello()`	返回报告副本集状态的文档。
`db.help()`	显示常见 `db` 对象方法的说明。
`db.hostInfo()`	返回一个文档，其中包含有关运行 MongoDB 的系统的信息。封装 `hostInfo`
`db.killOp()`	终止指定的操作。
`db.listCommands()`	显示常用数据库命令列表。
`db.logout()`	已弃用。结束已经过身份验证的会话。
`db.printCollectionStats()`	打印每个集合的统计信息。封装 `db.collection.stats()`。
`db.printReplicationInfo()`	从主节点的角度打印副本集的状态报告。
`db.printSecondaryReplicationInfo()`	从从节点的角度打印副本集的状态。
`db.printShardingStatus()`	打印分片配置和数据段范围的报告。
`db.resetError()`	在 MongoDB 5.0 中删除。重置上次错误状态。
`db.rotateCertificates()`	执行在线 TLS 证书轮换。封装 `rotateCertificates`。
`db.runCommand()`	运行数据库命令。
`db.serverBuildInfo()`	返回显示 `mongod` 实例的编译参数的文档。封装 `buildInfo`。
`db.serverCmdLineOpts()`	返回一个文档，其中包含有关用于启动 MongoDB 实例的运行时的信息。封装 `getCmdLineOpts`。
`db.serverStatus()`	返回体现数据库进程状态概况的文档。
`db.setLogLevel()`	设置单个日志消息详细级别。
`db.setProfilingLevel()`	修改数据库分析的当前级别。
`db.shutdownServer()`	安全彻底地关闭当前 `mongod` 或 `mongos` 进程。
`db.stats()`	返回报告当前数据库状态的文档。
`db.version()`	返回 `mongod` 实例的版本。
`db.watch()`	打开变更流游标，以便数据库报告其所有非 `system` 集合的情况。无法在 `admin`、`local` 或 `config` 数据库中打开。

查询计划缓存

名称	说明
`db.collection.getPlanCache()`	返回一个接口，用于访问查询计划缓存对象和集合的相关 PlanCache 方法。
`PlanCache.clear()`	清除集合的所有缓存查询计划。可通过特定集合的计划缓存对象访问，即 `db.collection.getPlanCache().clear()`。
`PlanCache.clearPlansByQuery()`	清除指定查询结构的缓存查询计划。可通过特定集合的计划缓存对象访问，即 `db.collection.getPlanCache().clearPlansByQuery()`
`PlanCache.help()`	显示可用于集合的查询计划缓存的方法。可通过特定集合的计划缓存对象访问，即 `db.collection.getPlanCache().help()`。
`PlanCache.list()`	返回集合的计划缓存信息。可通过特定集合的计划缓存对象访问，即 `db.collection.getPlanCache().list()`。

批量写入操作

名称	说明
`db.collection.initializeOrderedBulkOp()`	为有序的操作列表初始化 `Bulk()` 操作构建器。
`db.collection.initializeUnorderedBulkOp()`	为无序的操作列表初始化 `Bulk()` 操作构建器。
`Bulk()`	批量操作构建器。
`Bulk.execute()`	批量执行操作列表。
`Bulk.find()`	指定更新或删除操作的查询条件。
`Bulk.find.arrayFilters()`	指定筛选器，确定要为 `update` 或 `updateOne` 操作更新数组的哪些元素。
`Bulk.find.collation()`	指定查询条件的排序规则。
`Bulk.find.delete()`	将多文档删除操作添加到操作列表中。
`Bulk.find.deleteOne()`	将单个文档删除操作添加到操作列表中。
`Bulk.find.hint()`	指定用于更新/替换操作的索引。
`Bulk.find.remove()`	`Bulk.find.delete()` 的别名。
`Bulk.find.removeOne()`	`Bulk.find.deleteOne()` 的别名。
`Bulk.find.replaceOne()`	将单个文档替换操作添加到操作列表中。
`Bulk.find.updateOne()`	将单文档更新操作添加到操作列表中。
`Bulk.find.update()`	将 `multi` 更新操作添加到操作列表中。
`Bulk.find.upsert()`	为更新操作指定 `upsert: true`。
`Bulk.getOperations()`	返回在 `Bulk()` 操作对象中执行的写入操作数组。
`Bulk.insert()`	将插入操作添加到操作列表中。
`Bulk.toJSON()`	返回 JSON 文档，其中包含 `Bulk()` 操作对象中的操作和批次数。
`Bulk.toString()`	以字符串形式返回 `Bulk.toJSON()` 结果。

用户管理

名称	说明
`db.auth()`	验证数据库的用户身份。
`db.changeUserPassword()`	更改现有用户的密码。
`db.createUser()`	创建新用户。
`db.dropUser()`	删除单个用户。
`db.dropAllUsers()`	删除与数据库关联的所有用户。
`db.getUser()`	返回指定用户的信息。
`db.getUsers()`	返回与数据库关联的所有用户的信息。
`db.grantRolesToUser()`	向用户分配角色及其特权。
`db.removeUser()`	已弃用。从数据库中删除用户。
`db.revokeRolesFromUser()`	从用户中删除角色。
`db.updateUser()`	更新用户数据。
`passwordPrompt()`	提示将密码作为直接在各种 `mongosh` 用户身份验证/管理方法中指定密码的替代方法。

角色管理

名称	说明
`db.createRole()`	创建角色并指定其特权。
`db.dropRole()`	删除用户定义的角色。
`db.dropAllRoles()`	删除与数据库关联的所有用户定义的角色。
`db.getRole()`	返回指定角色的信息。
`db.getRoles()`	返回数据库中所有用户定义角色的信息。
`db.grantPrivilegesToRole()`	为用户定义的角色分配特权。
`db.revokePrivilegesFromRole()`	从用户定义的角色中删除指定特权。
`db.grantRolesToRole()`	指定用户定义角色继承相关特权的角色。
`db.revokeRolesFromRole()`	从角色中删除继承的角色。
`db.updateRole()`	更新用户定义的角色。

复制

名称	说明
`rs.add()`	将节点添加到副本集。
`rs.addArb()`	将仲裁节点添加到副本集。
`rs.conf()`	返回副本集配置文档。
`rs.freeze()`	阻止当前节点在一段时间内寻求选举为主节点。
`rs.help()`	返回副本集函数的基本帮助文本。
`rs.initiate()`	初始化新的副本集。
`rs.printReplicationInfo()`	从主节点的角度打印副本集状态的格式化报告。
`rs.printSecondaryReplicationInfo()`	从从节点的角度打印副本集状态的格式化报告。
`rs.reconfig()`	通过应用新的副本集配置对象来重新配置副本集。
`rs.remove()`	从副本集中删除节点。
`rs.status()`	返回包含副本集状态信息的文档。
`rs.stepDown()`	导致当前的主节点变为强制选举的从节点。
`rs.syncFrom()`	设置该副本集节点与哪个节点进行同步，复写默认的同步目标选择逻辑。

分片

名称	说明
`sh.abortReshardCollection()`	中止重新分片操作。版本 5.0 中的新增功能。
`sh.addShard()`	将分片添加到分片集群。
`sh.addShardTag()`	此方法的别名为`sh.addShardToZone()` 。
`sh.addShardToZone()`	将分片与区域关联。支持在分片集群中配置区域。
`sh.addTagRange()`	此方法的别名为`sh.updateZoneKeyRange()` 。
`sh.balancerCollectionStatus()`	返回有关分片集合的数据段是否均衡的信息。
`sh.commitReshardCollection()`	强制重分区操作以阻止写入并完成。版本 5.0 中的新增功能。
`sh.disableBalancing()`	禁用分片数据库中单个集合的均衡。不影响分片集群中其他集合的均衡。
`sh.enableBalancing()`	如果之前使用 `sh.disableBalancing()` 禁用了分片集合负载均衡器进程，则激活此进程。
`sh.disableAutoSplit()`	禁用分片集群自动分割。
`sh.enableAutoSplit()`	启用分片集群自动分割。
`sh.enableSharding()`	在特定数据库上启用分片。
`sh.getBalancerState()`	返回布尔值，报告当前使用已启用负载均衡器。
`sh.removeTagRange()`	此方法的别名为`sh.removeRangeFromZone()` 。
`sh.removeRangeFromZone()`	删除一系列分片键与一个区域之间的关联。支持在分片集群中配置区域。
`sh.help()`	返回 `sh` 方法的帮助文本。
`sh.isBalancerRunning()`	返回一个布尔值，用于报告负载均衡器进程当前是否正在迁移数据段。
`sh.moveChunk()`	迁移分片集群中的数据段。
`sh.removeShardTag()`	此方法是`sh.removeShardFromZone()`的别名。
`sh.removeShardFromZone()`	删除分片与区域之间的关联。用于管理区域分片。
`sh.reshardCollection()`	启动重新分片操作以更改集合的分片键，从而更改数据的分布。版本 5.0 中的新增功能。
`sh.setBalancerState()`	启用或禁用在分片之间迁移数据段的负载均衡器。
`sh.shardCollection()`	为集合启用分片。
`sh.splitAt()`	使用分片键的特定值作为分界点，将现有数据段分成两个数据段。
`sh.splitFind()`	将包含与查询匹配的文档的现有数据段分成两个大致相等的数据段。
`sh.startBalancer()`	启用负载均衡器并等待均衡开始。
`sh.status()`	将分片集群的状态报告为 `db.printShardingStatus()`。
`sh.stopBalancer()`	禁用负载均衡器并等待任何正在进行的均衡轮次完成。
`sh.waitForBalancer()`	内部。等待负载均衡器状态发生变化。
`sh.waitForBalancerOff()`	内部。等待负载均衡器停止运行。
`sh.waitForPingChange()`	内部。等待分片集群中一个 `mongos` 的 ping 状态发生变化。
`sh.updateZoneKeyRange()`	将一系列分片键与一个区域关联。支持在分片集群中配置区域。
`convertShardKeyToHashed()`	返回输入的哈希值。

构造函数

名称	说明
`BinData()`	返回二进制数据对象。
`BulkWriteResult()`	来自 `Bulk.execute()` 的副本集的封装器。
`Date()`	创建日期对象。默认情况下，创建一个包含当前日期的日期对象。
`ObjectId()`	返回对象标识符。
`ObjectId.getTimestamp()`	返回对象标识符的时间戳部分。
`ObjectId.toString()`	显示对象标识符的字符串表示。
UUID()	将 32 字节十六进制字符串转换为 UUID BSON 子类型。
`WriteResult()`	来自写入方法的副本集的封装器。
`WriteResult.hasWriteError()`	返回布尔值，指明结果是否包括 `WriteResult.writeError`。
`WriteResult.hasWriteConcernError()`	返回布尔值，指明结果是否包括 `WriteResult.writeConcernError`。

连接

名称	说明
connect()	连接到 MongoDB 实例以及该实例上的指定数据库。
`Mongo()`	创建新连接对象。
`Mongo.getDB()`	返回数据库对象。
`Mongo.getReadPrefMode()`	返回 MongoDB 连接的当前读取偏好模式。
`Mongo.getReadPrefTagSet()`	返回为该 MongoDB 连接设置的读取偏好标签集。
`Mongo.setCausalConsistency()`	启用或禁用连接对象的因果一致性。
`Mongo.setReadPref()`	设置该 MongoDB 连接的读取偏好。
`Mongo.startSession()`	对该连接对象启动会话。
`Mongo.watch()`	打开部署的变更流游标，以报告其所有数据库中的所有非 `system` 集合，不包括内部 `admin`、`local` 和 `config` 数据库。
`Session()`	会话对象。
`SessionOptions()`	会话的选项对象。

原生

名称	说明
cat()	返回指定文件的内容。
cd()	将当前工作目录更改为指定路径。
`copyDbpath()`	复制本地`dbPath` 。供内部使用。
`getHostName()`	返回运行 `mongosh` 的系统的主机名。
`getMemInfo()`	返回一个文档，其中报告 shell 使用的内存量。
hostname()	返回运行 shell 的系统的主机名。
isInteractive()	返回一个布尔值，指示 `mongosh` 是否以交互或脚本模式运行。
`listFiles()`	返回给出目录中每个对象的名称和大小的文档数组。
load()	在 shell 中加载并运行 JavaScript 文件。
ls()	返回当前目录中的文件列表。
`md5sumFile()`	指定文件的md 5哈希值。
mkdir()	在指定路径创建目录。
pwd()	返回当前目录。
quit()	退出当前 Shell 会话。
`removeFile()`	从本地文件系统中删除指定文件。
`resetDbpath()`	删除本地`dbPath` 。供内部使用。
sleep()	将`mongosh`暂停指定时间段。
`setVerboseShell()`	配置`mongosh`以报告操作时间。
version()	返回 `mongosh` 实例的当前版本。
`_isWindows()`	如果shell在Windows系统上运行，则返回 `true`； `false`（如果是 Unix 或Linux系统）。
`_rand()`	返回`0`和`1`之间的随机数。

客户端字段级加密 (Client-Side Field Level Encryption)

注意

mongo客户端字段级加密方法需要启用客户端字段级加密的数据库连接。如果当前数据库连接不是在启用客户端字段级加密的情况下启动的，则：

使用 ShellMongo()mongo 中的构造函数与所需的客户端字段级加密选项建立连接。Mongo()方法支持以下用于客户主密钥 (CMK) 管理的密钥管理服务 (KMS) 提供商：
or
使用mongo Shell命令行选项，通过所需选项建立连接。命令行选项仅支持用于客户主密钥管理的Amazon Web Services KMS提供商。

名称	说明
`getKeyVault()`	返回当前 MongoDB 连接的密钥保管库对象。
`KeyVault.createKey()`	创建数据加密密钥，用于客户端字段级加密。
`KeyVault.deleteKey()`	从密钥保管库中删除指定的数据加密密钥。
`KeyVault.getKey()`	从密钥保管库中检索指定的数据加密密钥。
`KeyVault.getKeys()`	检索密钥保管库中的所有密钥。
`KeyVault.addKeyAlternateName()`	将密钥备用名称与指定的数据加密密钥关联。
`KeyVault.removeKeyAlternateName()`	从指定的数据加密密钥中删除密钥备用名称。
`KeyVault.getKeyByAltName()`	检索具有指定密钥替代名称的密钥。
`getClientEncryption()`	返回客户端加密对象，以支持字段的显式加密/解密。
`ClientEncryption.encrypt()`	使用指定的数据加密密钥和加密算法对字段进行加密。
`ClientEncryption.decrypt()`	使用关联的数据加密密钥和加密算法对字段进行解密。

后退

传输协议

来年

集合