`mongosh` 方法

本页内容

Atlas 搜索索引方法

Atlas 流处理方法
集合
游标
数据库
查询计划缓存
批量写入操作
用户管理
角色管理
复制
分片
构造函数
连接
客户端字段级加密

注意

MongoDB 中的 JavaScript

尽管这些方法使用 JavaScript，但大多数与 MongoDB 的交互不使用 JavaScript，而是使用一个idiomatic driver 在交互应用程序的语言中。

注意

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

Atlas Search 索引方法

Atlas Search 索引允许您在 Atlas Search 中查询数据。Atlas Search 索引通过将搜索词映射到包含这些词的文档，实现高效文本搜索查询。

使用以下方法来管理 Atlas Search 索引。

名称	描述
`db.collection.createSearchIndex()`	在指定的集合上创建Atlas Search 索引。
`db.collection.dropSearchIndex()`	删除现有的Atlas Search 索引.
`db.collection.getSearchIndexes()`	返回现有Atlas Search 索引的信息。
`db.collection.updateSearchIndex()`	更新现有的Atlas Search 索引.

db.collection.updateSearchIndex()

Atlas Stream Processors 允许您使用与静态数据相同的模型和查询 API，对连续数据流执行聚合操作。

使用以下方法来管理 Stream Processors

重要

以下方法只能在 MongoDB Atlas. 上运行的部署上运行。

名称	描述
`sp.createStreamProcessor()`	创建一个流处理器。
`sp.listStreamProcessors()`	列出当前流处理实例上的所有现有流处理器。
`sp.process()`	创建一个临时流处理器。
`sp.processor.drop()`	删除现有的流处理器。
`sp.processor.sample()`	从当前运行的流处理器返回一个样本结果数组。
`sp.processor.start()`	启动现有的流处理器。
`sp.processor.stats()`	返回总结现有流处理器统计信息的函数。
`sp.processor.stop()`	停止当前运行的流处理器。

集合

名称	描述
`db.collection.analyzeShardKey()`	计算用于评估分片键的度量。
`db.collection.aggregate()`	提供访问聚合管道。
`db.collection.bulkWrite()`	提供批量写操作功能。
`db.collection.compactStructuredEncryptionData()`	封装`compactStructuredEncryptionData` 返回成功或失败对象。
`db.collection.configureQueryAnalyzer()`	配置集合的查询采样。
`db.collection.count()`	封装`count` 以返回集合或视图中文档数量的计数。
`db.collection.countDocuments()`	封装 `$group` 聚合阶段与 `$sum` 表达式以返回集合或视图中文档数量的计数。
`db.collection.createIndex()`	在集合上创建索引。
`db.collection.createIndexes()`	在集合上创建一个或多个索引。
`db.collection.dataSize()`	返回集合的大小。封装`size` 字段在`collStats` 的输出中。
`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()`	报告集合在字节中所使用的总大小。提供对 `storageSize` 字段的封装。
`db.collection.totalIndexSize()`	报告集合上索引使用的总大小。提供对 `totalIndexSize` 字段的封装。
`db.collection.totalSize()`	报告集合的总大小，包括所有文档和集合上所有索引的大小。
`db.collection.unhideIndex()`	从查询计划器中取消隐藏索引。
`db.collection.updateOne()`	修改集合中的单个文档。
`db.collection.updateMany()`	修改集合中的多个文档。
`db.collection.watch()`	在集合上建立 Change Stream。
`db.collection.validate()`	对集合执行诊断操作。

游标

名称	描述
`cursor.addOption()`	添加特殊的线协议标志，以修改查询的行为。
`cursor.allowDiskUse()`	允许MongoDB在处理阻塞排序操作时，使用磁盘上的临时文件来存储超过100MB系统内存限制的数据。
`cursor.allowPartialResults()`	允许对分片集合执行`db.collection.find()`操作时，如果查询的一个或多个分片不可用，则返回部分结果而不是错误。
`cursor.batchSize()`	控制MongoDB在一次网络消息中返回给客户端的文档数量。
`cursor.close()`	关闭游标并释放相关服务器资源。
`cursor.isClosed()`	如果游标已关闭，则返回`true`。
`cursor.collation()`	指定由`db.collection.find()`返回的游标的排序规则。
`cursor.comment()`	将注释附加到查询中，以便在日志和系统.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()`	返回一个包含游标返回的所有文档的数组。

数据库

名称	描述
`db.adminCommand()`	在`admin`数据库上运行命令。
`db.aggregate()`	运行不要求底层集合的admin/diagnostic管道。
`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操作构建器。
`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()`	设置此副本集成员将从其同步的成员，覆盖默认同步目标选择逻辑。

分片

名称	描述
`convertShardKeyToHashed()`	返回输入的哈希值。
`sh.abortReshardCollection()`	中止分片操作。新版本5.0.
`sh.abortUnshardCollection()`	停止正在进行的 `unshardCollection` 操作。新版本8.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.disableAutoMerger()`	禁用命名空间的自动数据块合并。新版本7.0.
`sh.disableAutoSplit()`	禁用分片集群的自动拆分。从 MongoDB 6.0.3 开始，不再执行自动数据块拆分。这是由于平衡策略的改进。自动拆分命令仍然存在，但不会执行任何操作。
`sh.enableAutoMerger()`	启用命名空间的自动数据块合并。新版本7.0.
`sh.enableAutoSplit()`	启用分片集群的自动拆分。从 MongoDB 6.0.3 开始，不再执行自动数据块拆分。这是由于平衡策略的改进。自动拆分命令仍然存在，但不会执行任何操作。
`sh.enableSharding()`	创建数据库。
`sh.getBalancerState()`	返回一个布尔值，报告平衡器是否当前已启用。
`sh.getShardedDataDistribution()`	返回分片集合的数据分布信息。 `sh.getShardedDataDistribution()` 是 `$shardedDataDistribution` 聚合管道阶段的 shell 辅助方法。
`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.startAutoMerger()`	启用自动合并器。新版本7.0.
`sh.startBalancer()`	启用平衡器并等待平衡开始。
`sh.status()`	报告分片集群的状态，如 `db.printShardingStatus()`。
`sh.stopAutoMerger()`	禁用自动合并器。新版本7.0.
`sh.stopBalancer()`	禁用平衡器并等待任何正在进行的平衡轮次完成。
`sh.unshardCollection()`	取消分片现有的分片集合并将集合数据移动到单个分片上。取消分片集合时，集合不能跨多个分片分割，并且分片键将被删除。新版本8.0.
`sh.updateZoneKeyRange()`	将一系列分片键关联到区域。支持配置分片集群中的区域。
`sh.waitForBalancer()`	内部。等待平衡器状态改变。
`sh.waitForBalancerOff()`	内部。等待平衡器停止运行。
`sh.waitForPingChange()`	内部。等待分片集群中 `mongos` 的 ping 状态改变。

构造函数

名称	描述
`Binary.createFromBase64()`	从base64值创建一个二进制对象。
`Binary.createFromHexString()`	从十六进制值创建一个二进制对象。
`BinData()`	返回一个二进制数据对象。
`BulkWriteResult()`	封装来自`Bulk.execute()`的结果集。
`Date()`	创建一个日期对象。默认创建一个包含当前日期的日期对象。
`HexData()`	返回一个二进制数据对象。
`ObjectId()`	返回一个ObjectId。
`ObjectId.createFromBase64()`	从base64值创建一个ObjectId。
`ObjectId.createFromHexString()`	从十六进制值创建一个ObjectId。
`ObjectId.getTimestamp()`	返回ObjectId的时间戳部分。
`ObjectId.toString()`	显示ObjectId的字符串表示形式。
UUID()	将32字节十六进制字符串转换为UUID BSON子类型。
`WriteResult()`	封装来自写入方法的结果集。

Connection

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

客户端字段级加密

注意

客户端字段级加密的mongosh方法需要启用客户端字段级加密的数据库连接。如果当前数据库连接未启用客户端字段级加密，则

使用Mongo()构造函数从mongosh建立具有所需客户端字段级加密选项的连接。Mongo()方法支持以下密钥管理服务（KMS）提供商用于客户主密钥（CMK）管理
或者
使用mongosh的命令行选项建立具有所需选项的连接。命令行选项仅支持Amazon Web Services KMS提供商进行CMK管理。

名称	描述
`getKeyVault()`	返回当前MongoDB连接的密钥库对象。
`KeyVault.createDataKey()`	是`KeyVault.createKey()`的别名。
`KeyVault.createKey()`	创建用于客户端字段级加密的数据加密密钥。
`KeyVault.deleteKey()`	从密钥库中删除指定的数据加密密钥。
`KeyVault.getKey()`	从密钥库中检索指定的数据加密密钥。
`KeyVault.getKeys()`	检索密钥库中的所有密钥。
`KeyVault.addKeyAlternateName()`	将密钥的别名与指定的数据加密密钥关联。
`KeyVault.addKeyAltName()`	是 `KeyVault.addKeyAlternateName()`. 的别名。
`KeyVault.removeKeyAlternateName()`	从指定的数据加密密钥中移除密钥的别名。
`KeyVault.removeKeyAltName()`	是 `KeyVault.removeKeyAlternateName()`. 的别名。
`KeyVault.getKeyByAltName()`	检索具有指定密钥别名的密钥。
`KeyVault.rewrapManyDataKey()`	解密多个数据密钥，并重新加密它们。
`getClientEncryption()`	返回客户端加密对象，以支持字段的显式加密/解密。
`ClientEncryption.createEncryptedCollection()`	创建具有加密字段的集合。
`ClientEncryption.encrypt()`	使用指定的数据加密密钥和加密算法加密字段。
`ClientEncryption.decrypt()`	使用相关联的数据加密密钥和加密算法解密字段。

旧版操作码

下一步

原生方法