mongo Shell方法_MonogDB 中文网

MongoDB 中文手册

参考 > 参考 > mongo Shell方法

在本页面

采集
光标
数据库
查询计划缓存
批量写入操作
用户管理
角色管理
复写
分片
免费监控
建设者
连接
本机
客户端字段级加密

MongoDB中的JavaScript

尽管这些方法使用JavaScript，但是与MongoDB的大多数交互都不使用JavaScript，而是使用交互应用程序语言中的惯用驱动程序。

注意

有关特定方法的详细信息，包括语法和示例，请单击特定方法以转到其参考页。

集合¶

名称	描述
`db.collection.aggregate()`	提供对聚合管道的访问。
`db.collection.bulkWrite()`	提供批量写入操作功能。
`db.collection.copyTo()`	不推荐使用。当针对MongoDB 4.0或更早版本运行时，在集合之间复制数据。针对MongoDB 4.2或更高版本运行时不受支持。
`db.collection.count()`	包装`count`的集合或视图中返回的文档数量的计数。
`db.collection.countDocuments()`	`$group`用`$sum` 表达式包装聚合阶段，以返回集合或视图中文档数量的计数。
`db.collection.estimatedDocumentCount()`	包装`count`以返回集合或视图中文档的大概数量。
`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.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.insert()`	在集合中创建一个新文档。
`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.save()`	提供的包装，`insert()`并`update()`插入新文档。
`db.collection.stats()`	报告收集状态。在的周围提供包装器`collStats`。
`db.collection.storageSize()`	报告集合使用的总大小（以字节为单位）。提供围绕输出`storageSize`字段的包装`collStats`。
`db.collection.totalIndexSize()`	报告集合上的索引使用的总大小。提供围绕输出`totalIndexSize`字段的包装`collStats`。
`db.collection.totalSize()`	报告集合的总大小，包括集合中所有文档和所有索引的大小。
`db.collection.update()`	修改集合中的文档。
`db.collection.updateOne()`	修改集合中的单个文档。
`db.collection.updateMany()`	修改集合中的多个文档。
`db.collection.watch()`	在集合上建立变更流。
`db.collection.validate()`	对集合执行诊断操作。

游标¶

名称	描述
`cursor.addOption()`	添加特殊的有线协议标志，以修改查询的行为。”
`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()`	返回一个数组，其中包含光标返回的所有文档。

数据库¶

名称	描述
`db.adminCommand()`	针对`admin`数据库运行命令。
`db.aggregate()`	运行不需要基础集合的管理/诊断管道。
`db.cloneCollection()`	直接在MongoDB实例之间复制数据。包装`cloneCollection`。
`db.cloneDatabase()`	不推荐使用。当针对MongoDB 4.0或更早版本运行时，将数据库从远程主机复制到当前主机。针对MongoDB 4.2或更高版本运行时不受支持。
`db.commandHelp()`	返回数据库命令的帮助信息。
`db.copyDatabase()`	不推荐使用。针对MongoDB 4.0或更早版本运行时，将数据库复制到当前主机上的另一个数据库。针对MongoDB 4.2或更高版本运行时不受支持。
`db.createCollection()`	创建一个新的集合或视图。通常用于创建上限集合。
`db.createView()`	创建一个视图。
`db.currentOp()`	报告当前正在进行的操作。
`db.dropDatabase()`	删除当前数据库。
`db.eval()`	不推荐使用。当针对MongoDB 4.0或更早版本运行时，传递JavaScript函数以进行服务器端JavaScript评估。针对MongoDB 4.2或更高版本运行时不受支持。
`db.fsyncLock()`	将写刷新到磁盘并锁定数据库，以防止写操作并协助备份操作。包装`fsync`。
`db.fsyncUnlock()`	允许在以锁定的数据库上继续写入`db.fsyncLock()`。
`db.getCollection()`	返回一个集合或视图对象。用于访问名称在`mongo`Shell中无效的集合。
`db.getCollectionInfos()`	返回当前数据库中所有集合和视图的集合信息。
`db.getCollectionNames()`	列出当前数据库中的所有集合和视图。
`db.getLastError()`	检查并返回上一个操作的状态。包装`getLastError`。
`db.getLastErrorObj()`	返回上一个操作的状态文档。包装`getLastError`。
`db.getLogComponents()`	返回日志消息的详细程度。
`db.getMongo()`	返回`Mongo()`当前连接的连接对象。
`db.getName()`	返回当前数据库的名称。
`db.getProfilingLevel()`	返回数据库操作的当前概要分析级别。
`db.getProfilingStatus()`	返回反映当前配置文件级别和配置文件阈值的文档。
`db.getReplicationInfo()`	返回包含复制统计信息的文档。
`db.getSiblingDB()`	提供对指定数据库的访问。
`db.help()`	显示常见`db`对象方法的描述。
`db.hostInfo()`	返回包含有关运行MongoDB的系统的信息的文档。包装纸`hostInfo`
`db.isMaster()`	返回报告副本集状态的文档。
`db.killOp()`	终止指定的操作。
`db.listCommands()`	显示常见数据库命令的列表。
`db.logout()`	结束已认证的会话。
`db.printCollectionStats()`	打印每个集合的统计信息。包装`db.collection.stats()`。
`db.printReplicationInfo()`	从主数据库的角度打印副本集状态的报告。
`db.printShardingStatus()`	打印分片配置和块范围的报告。
`db.printSlaveReplicationInfo()`	从第二副本的角度打印副本集状态的报告。
`db.resetError()`	不推荐使用。重置上一个错误状态。
`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.getPlansByQuery()`	显示指定查询形状的缓存查询计划。可通过特定集合（即）的计划缓存对象访问`db.collection.getPlanCache().getPlansByQuery()`。
`PlanCache.help()`	显示可用于集合的查询计划缓存的方法。可通过特定集合（即）的计划缓存对象访问`db.collection.getPlanCache().help()`。
`PlanCache.listQueryShapes()`	显示存在缓存的查询计划的查询形状。可通过特定集合（即）的计划缓存对象访问`db.collection.getPlanCache().listQueryShapes()`。

批量写操作¶

名称	描述
`db.collection.initializeOrderedBulkOp()`	初始化`Bulk()`操作构建器以获取操作的有序列表。
`db.collection.initializeUnorderedBulkOp()`	初始化`Bulk()`操作构建器以获取无序的操作列表。
`Bulk()`	批量操作生成器。
`Bulk.execute()`	批量执行操作列表。
`Bulk.find()`	指定更新或删除操作的查询条件。
`Bulk.find.arrayFilters()`	指定用于确定要为`update`或`updateOne`操作更新数组中哪些元素的过滤器。
`Bulk.find.collation()`	指定查询条件的排序规则。
`Bulk.find.hint()`	指定用于更新/替换操作的索引。
`Bulk.find.remove()`	将多文档删除操作添加到操作列表中。
`Bulk.find.removeOne()`	将单个文档删除操作添加到操作列表中。
`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()`	返回