数据库命令

在本页中

命令语法

用户命令
数据库操作
审计命令
Atlas搜索命令

以下所有命令文档概述了命令及其可用参数，并为每个命令提供了文档模板或原型。一些命令文档还包括相关的mongosh 辅助工具。

要针对当前数据库运行命令，使用db.runCommand():

db.runCommand( { <command> } )

要针对 admin 数据库运行管理命令，使用 db.adminCommand():

db.adminCommand( { <command> } )

注意

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

命令语法

当你运行数据库命令时，你将命令指定为文档到 db.runCommand()。文档的键是运行的命令，值通常是 1。该值不影响命令的输出，例如

db.runCommand( { hello: 1 } )

用户命令

聚合命令

名称	描述	MongoDB Atlas 支持
`aggregate`	使用聚合管道执行聚合任务，例如使用 `$group`。	对 M0、M2 和 M5 集群。支持有限。
`count`	计算集合或视图中的文档数量。	对 M0、M2 和 M5 集群。支持有限。
`distinct`	显示集合或视图中指定键中找到的唯一值。	对 M0、M2 和 M5 集群。支持有限。
`mapReduce`	对大型数据集执行 map-reduce 聚合。	对 M0、M2 和 M5 集群。不支持。

地理空间命令

名称	描述	MongoDB Atlas 支持
`geoSearch`	在 MongoDB 5.0 中已删除。执行使用 MongoDB 的 haystack 索引功能的地理空间查询。	不支持无服务器实例。

查询和写操作命令

名称	描述	MongoDB Atlas 支持
`bulkWrite`	在一次请求中执行多个集合的多个插入、更新和删除操作。新功能在版本8.0.	无
`delete`	删除一个或多个文档。	是
`find`	在集合或视图中选择文档。	对 M0、M2 和 M5 集群。支持有限。
`findAndModify`	返回并修改单个文档。	是
`getMore`	返回游标当前指向的文档批。	是
`insert`	插入一个或多个文档。	是
`resetError`	在 MongoDB 5.0 中删除。重置最后错误状态。	无
`update`	更新一个或多个文档。	是

查询计划缓存命令

名称	描述	MongoDB Atlas 支持
`planCacheClear`	移除集合的缓存查询计划。	对 M0、M2 和 M5 集群。不支持。
`planCacheClearFilters`	清除集合的索引过滤器。	对 M0、M2 和 M5 集群。不支持。
`planCacheListFilters`	列出集合的索引过滤器。	对 M0、M2 和 M5 集群。不支持。
`planCacheSetFilter`	为集合设置索引过滤器。	对 M0、M2 和 M5 集群。不支持。

数据库操作

认证命令

名称	描述	MongoDB Atlas 支持
`authenticate`	使用用户名和密码启动一个认证会话。	对 M0、M2 和 M5 集群。不支持。
`logout`	终止当前认证会话。	是

用户管理命令

名称	描述	MongoDB Atlas 支持
`createUser`	创建新用户。	不支持M0, M2, M5和M10集群。
`dropAllUsersFromDatabase`	删除与数据库关联的所有用户。	对 M0、M2 和 M5 集群。不支持。
`dropUser`	删除单个用户。	不支持M10集群。
`grantRolesToUser`	授予用户角色及其权限。	不支持M0, M2, M5和M10集群。
`revokeRolesFromUser`	从用户中删除角色。	不支持M0, M2, M5和M10集群。
`updateUser`	更新用户数据。	不支持M0, M2, M5和M10集群。
`usersInfo`	返回指定用户的信息。	对 M0、M2 和 M5 集群。支持有限。

角色管理命令

名称	描述	MongoDB Atlas 支持
`createRole`	创建角色并指定其权限。	不支持M0, M2, M5和M10集群。
`dropRole`	删除用户定义的角色。	不支持M0, M2, M5和M10集群。
`dropAllRolesFromDatabase`	从数据库中删除所有用户定义的角色。	对 M0、M2 和 M5 集群。不支持。
`grantPrivilegesToRole`	将权限分配给用户定义的角色。	对 M0、M2 和 M5 集群。不支持。
`grantRolesToRole`	指定用户定义角色继承权限的角色。	对 M0、M2 和 M5 集群。不支持。
`invalidateUserCache`	清除用户信息内存缓存，包括凭据和角色。	对 M0、M2 和 M5 集群。不支持。
`revokePrivilegesFromRole`	从用户定义的角色中移除指定的权限。	对 M0、M2 和 M5 集群。不支持。
`revokeRolesFromRole`	从用户定义的角色中移除指定的继承角色。	对 M0、M2 和 M5 集群。不支持。
`rolesInfo`	返回指定角色或角色的信息。	是
`updateRole`	更新用户定义的角色。	不支持M0, M2, M5和M10集群。

复制命令

名称	描述	MongoDB Atlas 支持
`appendOplogNote`	将非操作条目写入oplog。	对 M0、M2 和 M5 集群。不支持。
`applyOps`	内部命令，将oplog条目应用到当前数据集中。	不支持无服务器实例。
`hello`	显示关于此成员在副本集中的角色的信息，包括是否为主节点。	是
`replSetAbortPrimaryCatchUp`	强制选定的主节点终止同步（追赶）然后完成到主节点的转换。	是
`replSetFreeze`	防止当前成员在一段时间内寻求主节点选举。	不支持M0, M2, M5和M10集群。
`replSetGetConfig`	返回副本集的配置对象。	对 M0、M2 和 M5 集群。不支持。
`replSetGetStatus`	返回一个报告副本集状态的文档。	对 M0、M2 和 M5 集群。不支持。
`replSetInitiate`	初始化一个新的副本集。	不支持M0, M2, M5和M10集群。
`replSetMaintenance`	启用或禁用维护模式，该模式将一个辅助节点置于`RECOVERING`状态。	不支持M0, M2, M5和M10集群。
`replSetReconfig`	将新的配置应用到现有的副本集。	不支持M0, M2, M5和M10集群。
`replSetResizeOplog`	动态调整副本集成员的oplog大小。仅适用于WiredTiger存储引擎。	不支持M10集群。
`replSetStepDown`	强制当前主节点下线成为辅助节点，强制进行选举。	不支持M0, M2, M5和M10集群。
`replSetSyncFrom`	显式覆盖默认逻辑，以选择从哪个成员进行复制。	不支持M0, M2, M5和M10集群。

提示

另请参阅

复制以获取有关复制的更多信息。

分片命令

名称	描述	MongoDB Atlas 支持
`abortReshardCollection`	中止分片操作。新功能在版本5.0.	是
`abortMoveCollection`	停止正在进行的`moveCollection`操作。新功能在版本8.0.	不支持无服务器实例和Atlas 共享层。
`abortUnshardCollection`	停止正在进行的`unshardCollection`操作。新功能在版本8.0.	不支持无服务器实例和Atlas 共享层。
`addShard`	向分片集群添加分片。	不支持无服务器实例。
`addShardToZone`	将分片与区域关联。支持在分片集群中配置区域。	不支持无服务器实例。
`analyzeShardKey`	计算用于评估分片键的指标。新功能在版本7.0.	是
`balancerCollectionStatus`	返回有关分片集合块是否平衡的信息。	不支持无服务器实例。
`balancerStart`	启动平衡器线程。	不支持无服务器实例。
`balancerStatus`	返回有关平衡器状态的信息。	不支持无服务器实例。
`balancerStop`	停止平衡器线程。	不支持无服务器实例。
`checkMetadataConsistency`	对分片元数据执行一系列一致性检查。新功能在版本7.0.	是
`clearJumboFlag`	清除分块的`jumbo`标志。	不支持无服务器实例。
`cleanupReshardCollection`	清理失败的分片操作。新功能在版本5.0.	是
`commitReshardCollection`	强制分片操作阻塞写入并完成。新功能在版本5.0.	是
`configureCollectionBalancing`	在分片集合上配置平衡器设置。新功能在版本5.3.	是
`configureQueryAnalyzer`	配置集合的查询采样。新功能在版本7.0.	是
`enableSharding`	创建数据库。	不支持无服务器实例。
`flushRouterConfig`	强制`mongod` / `mongos`实例更新其缓存的路由元数据。	不支持无服务器实例。
`getShardMap`	内部命令，用于报告分片集群的状态。	不支持M0、M2和M5集群以及无服务器实例。
`isdbgrid`	验证进程是否是`mongos`。	是
`listShards`	返回配置的分片列表。	不支持无服务器实例。
`moveChunk`	内部命令，用于在不同分片之间迁移数据块。	不支持无服务器实例。
`movePrimary`	在从分片集群中删除分片时重新分配主分片。	不支持无服务器实例。
`moveRange`	在分片之间移动范围。	是
`mergeAllChunksOnShard`	合并分片拥有的给定集合的所有可合并数据块。	不支持无服务器实例。
`mergeChunks`	提供在单个分片上合并数据块的能力。	不支持无服务器实例。
`refineCollectionShardKey`	通过添加后缀来细化集合的分区键。	不支持M10集群以及无服务器实例。
`removeShard`	开始从分片集群中删除分片的过程。	不支持M10集群以及无服务器实例。
`removeShardFromZone`	删除分片与区域之间的关联。支持在分片集群中配置区域。	不支持无服务器实例。
`reshardCollection`	开始重新分片操作以更改集合的分区键，改变数据分布。新功能在版本5.0.	是
`setAllowMigrations`	防止对集合进行新的自动迁移。	不支持无服务器实例。
`shardCollection`	为集合启用分片功能，允许集合进行分片。	不支持无服务器实例。
`shardingState`	报告`mongod`是否是分片集群的成员。	是
`split`	创建一个新的数据块。	不支持无服务器实例。
`transitionFromDedicatedConfigServer`	将专用配置服务器配置为运行为配置分片。新功能在版本8.0.	不支持无服务器实例和Atlas 共享层。
`transitionToDedicatedConfigServer`	将配置分片配置为运行为专用配置服务器。新功能在版本8.0.	不支持无服务器实例和Atlas 共享层。
`unsetSharding`	已在MongoDB 5.0中删除。内部命令，影响MongoDB部署中实例之间的连接。	是
`unshardCollection`	取消对现有分片集合的分片，并将集合数据移动到单个分片。取消分片集合时，集合不能跨多个分片分区，并且删除分区键。新功能在版本8.0.	是
`updateZoneKeyRange`	添加或删除分片数据范围与区域之间的关联。支持在分片集群中配置区域。	不支持无服务器实例。

提示

另请参阅

关于MongoDB分片功能的更多信息。

会话命令

命令	描述	Atlas 支持
`abortTransaction`	中止事务。	是
`commitTransaction`	提交事务。	是
`endSessions`	在会话超时之前使会话过期。	是
`killAllSessions`	杀死所有会话。	不支持M0, M2, M5和M10集群。
`killAllSessionsByPattern`	杀死所有与指定模式匹配的会话。	对 M0、M2 和 M5 集群。不支持。
`killSessions`	杀死指定的会话。	对 M0、M2 和 M5 集群。不支持。
`refreshSessions`	刷新空闲会话。	是
`startSession`	启动一个新的会话。	是

管理命令

名称	描述	MongoDB Atlas 支持
`cloneCollectionAsCapped`	将非固定集合作为新的固定集合复制。	不支持M0、M2和M5集群以及无服务器实例。
`collMod`	向集合添加选项或修改视图定义。	是
`compact`	对集合进行碎片整理并重建索引。	对 M0、M2 和 M5 集群。不支持。
`compactStructuredEncryptionData`	压缩状态集合中指定的文档并删除冗余文档。	是
`convertToCapped`	将非固定集合转换为固定集合。	不支持无服务器实例。
`create`	创建集合或视图。	是
`createIndexes`	为集合构建一个或多个索引。	是
`currentOp`	返回包含数据库实例正在进行的操作信息的文档。	是
`drop`	从数据库中删除指定的集合。	是
`dropDatabase`	删除当前数据库。	是
`dropConnections`	删除到指定主机列表的出站连接。	是
`dropIndexes`	从集合中删除索引。	是
`filemd5`	返回使用GridFS存储的文件的md5散列。	是
`fsync`	刷新待写入的存储层并锁定数据库以允许备份。	不支持M0, M2, M5和M10集群。
`fsyncUnlock`	解锁一个fsync锁。	对 M0、M2 和 M5 集群。不支持。
`getDefaultRWConcern`	检索部署的全局默认读写关注选项。	是
`getClusterParameter`	从集群中的所有节点检索集群参数值。新功能在版本6.0.	是
`getParameter`	检索配置选项。	对 M0、M2 和 M5 集群。支持有限。
`killCursors`	删除集合中的指定游标。	是
`killOp`	根据操作ID终止一个操作。	对M0, M2, M5和M10集群提供有限支持。
`listCollections`	返回当前数据库中所有集合的列表。	是
`listDatabases`	返回一个文档，列出所有数据库并返回基本数据库统计信息。	是
`listIndexes`	列出集合的所有索引。	是
`logRotate`	旋转MongoDB日志，防止单个文件占用太多空间。	不支持M0, M2, M5和M10集群。
`reIndex`	重建集合上的所有索引。	对 M0、M2 和 M5 集群。不支持。
`renameCollection`	更改现有集合的名称。	是
`rotateCertificates`	执行在线TLS证书轮换。	是
`setFeatureCompatibilityVersion`	启用或禁用向后不兼容的数据持久化功能。	不支持M0, M2, M5和M10集群。
`setIndexCommitQuorum`	更改必须投票提交正在进行的索引构建的数据承载成员（即提交法定人数），包括主节点，以便主节点将这些索引标记为就绪。	是
`setClusterParameter`	修改副本集或分片集群中所有节点的配置选项。新功能在版本6.0.	是
`setParameter`	修改配置选项。	不支持M0, M2, M5和M10集群。
`setDefaultRWConcern`	设置部署的全局默认读取和写入关注点选项。	是
`setUserWriteBlockMode`	阻止和解除对整个集群的写入。	无
`shutdown`	关闭`mongod`或`mongos`进程。	不支持M0, M2, M5和M10集群。
`validateDBMetadata`	检查数据库或集合的存储元数据在特定API版本中是否有效。新功能在版本5.0.	是

诊断命令

名称	描述	MongoDB Atlas 支持
`buildInfo`	显示MongoDB构建的统计信息。	是
`collStats`	报告指定集合的存储利用率统计信息。	是
`connPoolStats`	报告此MongoDB实例与其他部署中的MongoDB实例的出站连接的统计信息。	是
`connectionStatus`	报告当前连接的认证状态。	是
`dataSize`	返回数据范围的尺寸。内部使用。	对 M0、M2 和 M5 集群。不支持。
`dbHash`	返回数据库及其集合的哈希值。	不支持M0、M2和M5集群以及无服务器实例。
`dbStats`	报告指定数据库的存储利用率统计信息。	对 M0、M2 和 M5 集群。支持有限。
`explain`	返回有关各种操作执行的信息。	是
`getCmdLineOpts`	返回MongoDB实例的运行时参数及其解析选项的文档。	是
`getLog`	返回最近的日志消息。	是
`hostInfo`	返回反映底层主机系统的数据。	对 M0、M2 和 M5 集群。不支持。
`listCommands`	列出当前`mongod`实例提供的所有数据库命令。	是
`lockInfo`	内部命令，返回当前正在持有或挂起的锁的信息。仅适用于`mongod`实例。	对 M0、M2 和 M5 集群。不支持。
`ping`	内部命令，用于测试部署内部的连接性。	是
`profile`	数据库分析器的接口。	是
`serverStatus`	返回有关实例级资源利用率和状态的指标集合。	是
`shardConnPoolStats`	自MongoDB 5.0已删除。请使用`connPoolStats`代替。	不支持无服务器实例。
`top`	返回`mongod`实例中每个数据库的原始使用统计信息。	不支持无服务器实例。
`validate`	内部命令，扫描集合的数据和索引以检查其正确性。	不支持M0、M2和M5集群以及无服务器实例。
`whatsmyuri`	内部命令，返回有关当前客户端的信息。	是

审计命令

名称	描述	MongoDB Atlas 支持
`getAuditConfig`	从`mongod`和`mongos`实例检索审计配置。自MongoDB 7.1已弃用	无
`logApplicationMessage`	将自定义消息发布到审计日志。	是
`setAuditConfig`	在运行时为`mongod`和`mongos`实例设置审计配置。自MongoDB 7.1已弃用	无

Atlas搜索命令

新功能在版本7.0: (自6.0.7版本起也可用)

名称	描述
`createSearchIndexes`	在指定的集合上创建一个或多个Atlas搜索索引。
`dropSearchIndex`	删除现有的Atlas搜索索引。
`updateSearchIndex`	更新现有的Atlas搜索索引。

连接字符串示例

下一步

聚合