Database Commands数据库命令

On this page

~~Command Syntax~~命令语法
~~User Commands~~用户命令
~~Database Operations~~数据库操作
~~Auditing Commands~~审核命令

~~All command documentation outlined below describes a command and its available parameters and provides a document template or prototype for each command.~~ 下面列出的所有命令文档都描述了命令及其可用参数，并为每个命令提供了文档模板或原型。~~Some command documentation also includes the relevant mongosh helpers.~~一些命令文档还包括相关的mongosh助手。

~~To run a command against the current database, use db.runCommand():~~要对当前数据库运行命令，请使用db.runCommand()：

db.runCommand( { <command> } )

~~To run an administrative command against the admin database, use db.adminCommand():~~要对admin数据库运行管理命令，请使用db.adminCommand()：

db.adminCommand( { <command> } )

Note

~~For details on specific commands, including syntax and examples, click on the specific command to go to its reference page.~~有关特定命令的详细信息，包括语法和示例，请单击特定命令转到其参考页。

Command Syntax命令语法

~~When you run a database command, you specify the command as a document to db.runCommand().~~ 运行数据库命令时，将该命令指定为db.runCommand()的文档。~~The document's key is the command to run, and the value is typically supplied as 1.~~ 文档的键是要运行的命令，该值通常以1的形式提供。~~The value does not affect the output of the command for example:~~该值不会影响命令的输出，例如：

db.runCommand( { hello: 1 } )

User Commands用户命令

Aggregation Commands聚合命令

~~Name~~名称	~~Description~~描述
`aggregate`	~~Performs aggregation tasks such as `$group` using an aggregation pipeline.~~使用聚合管道执行聚合任务，如`$group`。
`count`	~~Counts the number of documents in a collection or a view.~~统计集合或视图中的文档数。
`distinct`	~~Displays the distinct values found for a specified key in a collection or a view.~~显示在集合或视图中为指定键找到的不同值。
`mapReduce`	~~Performs map-reduce aggregation for large data sets.~~对大型数据集执行映射缩减聚合。

Geospatial Commands地理空间命令

~~Name~~名称	~~Description~~描述
`geoSearch`	~~Removed in MongoDB 5.0.~~在MongoDB 5.0中删除。 ~~Performs a geospatial query that uses MongoDB's haystack index functionality.~~使用MongoDB的干草堆索引功能执行地理空间查询。

Query and Write Operation Commands查询和写入操作命令

~~Name~~名称	~~Description~~描述
`delete`	~~Deletes one or more documents.~~删除一个或多个文档。
`find`	~~Selects documents in a collection or a view.~~选择集合或视图中的文档。
`findAndModify`	~~Returns and modifies a single document.~~返回和修改单个文档。
`getMore`	~~Returns batches of documents currently pointed to by the cursor.~~返回游标当前指向的一批文档。
`insert`	~~Inserts one or more documents.~~插入一个或多个文档。
`resetError`	~~Removed in MongoDB 5.0.~~在MongoDB 5.0中删除。 ~~Resets the last error status.~~重置上次错误状态。
`update`	~~Updates one or more documents.~~更新一个或多个文档。

Query Plan Cache Commands查询计划缓存命令

~~Name~~名称	~~Description~~描述
`planCacheClear`	~~Removes cached query plan(s) for a collection.~~删除集合的缓存查询计划。
`planCacheClearFilters`	~~Clears index filter(s) for a collection.~~清除集合的索引筛选器。
`planCacheListFilters`	~~Lists the index filters for a collection.~~列出集合的索引筛选器。
`planCacheSetFilter`	~~Sets an index filter for a collection.~~设置集合的索引筛选器。

Database Operations数据库操作

Authentication Commands身份验证命令

~~Name~~名称	~~Description~~描述
`authenticate`	~~Starts an authenticated session using a username and password.~~使用用户名和密码启动经过身份验证的会话。
`logout`	~~Terminates the current authenticated session.~~终止当前经过身份验证的会话。

User Management Commands用户管理命令

~~Name~~名称	~~Description~~描述
`createUser`	~~Creates a new user.~~创建新用户。
`dropAllUsersFromDatabase`	~~Deletes all users associated with a database.~~删除与数据库关联的所有用户。
`dropUser`	~~Removes a single user.~~删除单个用户。
`grantRolesToUser`	~~Grants a role and its privileges to a user.~~将角色及其权限授予用户。
`revokeRolesFromUser`	~~Removes a role from a user.~~从用户中删除角色。
`updateUser`	~~Updates a user's data.~~更新用户的数据。
`usersInfo`	~~Returns information about the specified users.~~返回有关指定用户的信息。

Role Management Commands角色管理命令

~~Name~~名称	~~Description~~描述
`createRole`	~~Creates a role and specifies its privileges.~~创建角色并指定其权限。
`dropRole`	~~Deletes the user-defined role.~~删除用户定义的角色。
`dropAllRolesFromDatabase`	~~Deletes all user-defined roles from a database.~~从数据库中删除所有用户定义的角色。
`grantPrivilegesToRole`	~~Assigns privileges to a user-defined role.~~为用户定义的角色分配权限。
`grantRolesToRole`	~~Specifies roles from which a user-defined role inherits privileges.~~指定用户定义的角色从中继承权限的角色。
`invalidateUserCache`	~~Flushes the in-memory cache of user information, including credentials and roles.~~刷新内存中的用户信息缓存，包括凭据和角色。
`revokePrivilegesFromRole`	~~Removes the specified privileges from a user-defined role.~~从用户定义的角色中删除指定的权限。
`revokeRolesFromRole`	~~Removes specified inherited roles from a user-defined role.~~从用户定义的角色中删除指定的继承角色。
`rolesInfo`	~~Returns information for the specified role or roles.~~返回指定角色的信息。
`updateRole`	~~Updates a user-defined role.~~更新用户定义的角色。

Replication Commands复制命令

~~Name~~名称	~~Description~~描述
`applyOps`	~~Internal command that applies oplog entries to the current data set.~~将oplog项应用于当前数据集的内部命令。
`hello`	~~Displays information about this member's role in the replica set, including whether it is the primary.~~显示有关此成员在副本集中的角色的信息，包括它是否为主成员。
`replSetAbortPrimaryCatchUp`	~~Forces the elected primary to abort sync (catch up) then complete the transition to primary.~~强制选定的primary进程中止同步（追赶），然后完成到主进程的转换。
`replSetFreeze`	~~Prevents the current member from seeking election as primary for a period of time.~~阻止当前成员在一段时间内以primary身份寻求选举。
`replSetGetConfig`	~~Returns the replica set's configuration object.~~返回复制副本集的配置对象。
`replSetGetStatus`	~~Returns a document that reports on the status of the replica set.~~返回一个报告副本集状态的文档。
`replSetInitiate`	~~Initializes a new replica set.~~初始化新的复制副本集。
`replSetMaintenance`	~~Enables or disables a maintenance mode, which puts a secondary node in a `RECOVERING` state.~~启用或禁用维护模式，使secondary节点处于`RECOVERING`状态。
`replSetReconfig`	~~Applies a new configuration to an existing replica set.~~将新配置应用于现有复制副本集。
`replSetResizeOplog`	~~Dynamically resizes the oplog for a replica set member.~~ 动态调整副本集成员的操作日志的大小。~~Available for WiredTiger storage engine only.~~仅适用于WiredTiger存储引擎。
`replSetStepDown`	~~Forces the current primary to step down and become a secondary, forcing an election.~~迫使目前的primary下台，成为secondary，从而迫使选举。
`replSetSyncFrom`	~~Explicitly override the default logic for selecting a member to replicate from.~~显式重写用于选择要从中复制的成员的默认逻辑。

Tip

Sharding Commands分片命令

~~Name~~名称	~~Description~~描述
`abortReshardCollection`	~~Aborts a resharding operation.~~ 中止重新分片操作。 New in version 5.0.
`addShard`	~~Adds a shard to a sharded cluster.~~将分片添加到分片群集中。
`addShardToZone`	~~Associates a shard with a zone.~~ 将分片与区域关联。~~Supports configuring zones in sharded clusters.~~支持在分片集群中配置区域。
`balancerCollectionStatus`	~~Returns information on whether the chunks of a sharded collection are balanced.~~返回有关分片集合的块是否平衡的信息。 New in version 4.4.
`balancerStart`	~~Starts a balancer thread.~~启动平衡器线程。
`balancerStatus`	~~Returns information on the balancer status.~~返回有关平衡器状态的信息。
`balancerStop`	~~Stops the balancer thread.~~停止平衡器线程。
`checkShardingIndex`	~~Internal command that validates index on shard key.~~用于验证分片键上的索引的内部命令。
`clearJumboFlag`	~~Clears the `jumbo` flag for a chunk.~~清除区块的`jumbo`标志。
`cleanupOrphaned`	~~Removes orphaned data with shard key values outside of the ranges of the chunks owned by a shard.~~删除分片键值在分片所拥有的区块范围之外的孤立数据。
`cleanupReshardCollection`	~~Cleans up a failed resharding operation.~~ 清理失败的重新分片操作。 New in version 5.0.
`commitReshardCollection`	~~Forces a resharding operation to block writes and complete.~~ 强制重新分片操作以阻止写入并完成。 New in version 5.0.
`configureCollectionBalancing`	~~Configures balancer settings on a sharded collection.~~ 配置分片集合上的平衡器设置。 New in version 5.3.
`enableSharding`	~~Creates a database.~~创建数据库。
`flushRouterConfig`	~~Forces a `mongod` / `mongos` instance to update its cached routing metadata.~~强制`mongod`/`mongos`实例更新其缓存的路由元数据。
`getShardMap`	~~Internal command that reports on the state of a sharded cluster.~~报告分片集群状态的内部命令。
`getShardVersion`	~~Internal command that returns the config server version.~~返回配置服务器版本的内部命令。
`isdbgrid`	~~Verifies that a process is a `mongos`.~~验证进程是否为`mongos`。
`listShards`	~~Returns a list of configured shards.~~返回已配置分片的列表。
`medianKey`	~~Deprecated internal command.~~ 不推荐使用内部命令。~~See `splitVector`.~~请参见`splitVector`。
`moveChunk`	~~Internal command that migrates chunks between shards.~~在分片之间迁移块的内部命令。
`movePrimary`	~~Reassigns the primary shard when removing a shard from a sharded cluster.~~从分片群集中移除分片时，重新分配主分片。
`moveRange`	~~Moves ranges between shards.~~在分片之间移动范围。
`mergeChunks`	~~Provides the ability to combine chunks on a single shard.~~提供在单个分片上组合块的功能。
`refineCollectionShardKey`	~~Refines a collection's shard key by adding a suffix to the existing key.~~ 通过向现有关键帧添加后缀来优化集合的分片关键帧。 New in version 4.4.
`removeShard`	~~Starts the process of removing a shard from a sharded cluster.~~开始从分片集群中移除分片的过程。
`removeShardFromZone`	~~Removes the association between a shard and a zone.~~ 删除分片和区域之间的关联。~~Supports configuring zones in sharded clusters.~~支持在分片集群中配置区域。
`reshardCollection`	~~Initiates a resharding operation to change the shard key for a collection, changing the distribution of your data.~~ 启动重新分片操作以更改集合的分片键，从而更改数据的分布。 New in version 5.0.
`setShardVersion`	~~Internal command to sets the config server version.~~用于设置配置服务器版本的内部命令。
`shardCollection`	~~Enables the sharding functionality for a collection, allowing the collection to be sharded.~~启用集合的分片功能，允许对集合进行分片。
`shardingState`	~~Reports whether the `mongod` is a member of a sharded cluster.~~报告`mongod`是否是分片集群的成员。
`split`	~~Creates a new chunk.~~创建新区块。
`splitVector`	~~Internal command that determines split points.~~确定拆分点的内部命令。
`unsetSharding`	~~Removed in MongoDB 5.0.~~在MongoDB 5.0中删除。 ~~Internal command that affects connections between instances in a MongoDB deployment.~~影响MongoDB部署中实例之间连接的内部命令。
`updateZoneKeyRange`	~~Adds or removes the association between a range of sharded data and a zone.~~ 添加或删除一系列分片数据和区域之间的关联。~~Supports configuring zones in sharded clusters.~~支持在分片集群中配置区域。

Tip

Session Commands会话命令

~~Command~~命令	~~Description~~描述
`abortTransaction`	~~Abort transaction.~~ 中止事务。 New in version 4.0.
`commitTransaction`	~~Commit transaction.~~ 提交事务。 New in version 4.0.
`endSessions`	~~Expire sessions before the sessions' timeout period.~~在会话的超时期之前使会话过期。
`killAllSessions`	~~Kill all sessions.~~终止所有会话。
`killAllSessionsByPattern`	~~Kill all sessions that match the specified pattern~~终止所有与指定模式匹配的会话
`killSessions`	~~Kill specified sessions.~~终止指定的会话。
`refreshSessions`	~~Refresh idle sessions.~~刷新空闲会话。
`startSession`	~~Starts a new session.~~启动新会话。

Administration Commands管理命令

~~Name~~名称	~~Description~~描述
`cloneCollectionAsCapped`	~~Copies a non-capped collection as a new capped collection.~~将未封顶的集合复制为新的封顶集合。
`collMod`	~~Add options to a collection or modify a view definition.~~向集合添加选项或修改视图定义。
`compact`	~~Defragments a collection and rebuilds the indexes.~~对集合进行分片整理并重新构建索引。
`compactStructuredEncryptionData`	~~Compacts documents specified in the state collections and deletes redundant documents.~~压缩状态集合中指定的文档并删除多余的文档。
`convertToCapped`	~~Converts a non-capped collection to a capped collection.~~将无上限集合转换为有上限集合。
`create`	~~Creates a collection or a view.~~创建集合或视图。
`createIndexes`	~~Builds one or more indexes for a collection.~~为集合生成一个或多个索引。
`currentOp`	~~Returns a document that contains information on in-progress operations for the database instance.~~返回一个文档，该文档包含有关数据库实例正在进行的操作的信息。
`drop`	~~Removes the specified collection from the database.~~从数据库中删除指定的集合。
`dropDatabase`	~~Removes the current database.~~删除当前数据库。
`dropConnections`	~~Drops outgoing connections to the specified list of hosts.~~删除到指定主机列表的传出连接。
`dropIndexes`	~~Removes indexes from a collection.~~从集合中删除索引。
`filemd5`	~~Returns the md5 hash for files stored using GridFS.~~返回使用GridFS存储的文件的md5哈希。
`fsync`	~~Flushes pending writes to the storage layer and locks the database to allow backups.~~刷新对存储层的挂起写入并锁定数据库以允许备份。
`fsyncUnlock`	~~Unlocks one fsync lock.~~解锁一个fsync锁。
`getDefaultRWConcern`	~~Retrieves the global default read and write concern options for the deployment.~~ 检索部署的全局默认读写问题选项。 New in version 4.4.
`getClusterParameter`	~~Retrieves cluster parameter values from all nodes in a cluster.~~ 从群集中的所有节点检索群集参数值。 New in version 6.0.
`getParameter`	~~Retrieves configuration options.~~检索配置选项。
`killCursors`	~~Kills the specified cursors for a collection.~~杀死集合的指定游标。
`killOp`	~~Terminates an operation as specified by the operation ID.~~根据操作ID指定终止操作。
`listCollections`	~~Returns a list of collections in the current database.~~返回当前数据库中集合的列表。
`listDatabases`	~~Returns a document that lists all databases and returns basic database statistics.~~返回列出所有数据库并返回基本数据库统计信息的文档。
`listIndexes`	~~Lists all indexes for a collection.~~列出集合的所有索引。
`logRotate`	~~Rotates the MongoDB logs to prevent a single file from taking too much space.~~旋转MongoDB日志以防止单个文件占用太多空间。
`reIndex`	~~Rebuilds all indexes on a collection.~~重新生成集合上的所有索引。
`renameCollection`	~~Changes the name of an existing collection.~~更改现有集合的名称。
`rotateCertificates`	~~Performs online TLS certificate rotation.~~执行联机TLS证书轮换。
`setFeatureCompatibilityVersion`	~~Enables or disables features that persist data that are backwards-incompatible.~~启用或禁用保持向后不兼容的数据的功能。
`setIndexCommitQuorum`	~~Changes the minimum number of data-bearing members (i.e commit quorum), including the primary, that must vote to commit an in-progress index build before the primary marks those indexes as ready.~~更改数据承载成员（即提交法定人数）的最小数量，包括主要成员，在主要成员将这些索引标记为就绪之前，这些成员必须投票提交正在进行的索引生成。
`setClusterParameter`	~~Modifies configuration options for all nodes in a replica set or sharded cluster.~~ 修改副本集中或分片集群中所有节点的配置选项。 New in version 6.0.
`setParameter`	~~Modifies configuration options.~~修改配置选项。
`setDefaultRWConcern`	~~Sets the global default read and write concern options for the deployment.~~ 设置部署的全局默认读写问题选项。 New in version 4.4.
`shutdown`	~~Shuts down the `mongod` or `mongos` process.~~关闭`mongod`或`mongos`进程。

Diagnostic Commands诊断命令

~~Name~~名称	~~Description~~描述
`buildInfo`	~~Displays statistics about the MongoDB build.~~显示有关MongoDB构建的统计信息。
`collStats`	~~Reports storage utilization statics for a specified collection.~~报告指定集合的存储利用率静态信息。
`connPoolStats`	~~Reports statistics on the outgoing connections from this MongoDB instance to other MongoDB instances in the deployment.~~报告从该MongoDB实例到部署中其他MongoDB实例的传出连接的统计信息。
`connectionStatus`	~~Reports the authentication state for the current connection.~~报告当前连接的身份验证状态。
`dataSize`	~~Returns the data size for a range of data. For internal use.~~返回一系列数据的数据大小。供内部使用。
`dbHash`	~~Returns hash value a database and its collections.~~返回数据库及其集合的哈希值。
`dbStats`	~~Reports storage utilization statistics for the specified database.~~报告指定数据库的存储利用率统计信息。
`driverOIDTest`	~~Internal command that converts an ObjectId to a string to support tests.~~将ObjectId转换为字符串以支持测试的内部命令。
`explain`	~~Returns information on the execution of various operations.~~返回有关各种操作执行情况的信息。
`features`	~~Reports on features available in the current MongoDB instance.~~报告当前MongoDB实例中可用的功能。
`getCmdLineOpts`	~~Returns a document with the run-time arguments to the MongoDB instance and their parsed options.~~将带有运行时参数的文档返回到MongoDB实例及其解析的选项。
`getLog`	~~Returns recent log messages.~~返回最近的日志消息。
`hostInfo`	~~Returns data that reflects the underlying host system.~~返回反映基础主机系统的数据。
`_isSelf`	~~Internal command to support testing.~~支持测试的内部命令。
`listCommands`	~~Lists all database commands provided by the current `mongod` instance.~~列出当前`mongod`实例提供的所有数据库命令。
`lockInfo`	~~Internal command that returns information on locks that are currently being held or pending. Only available for `mongod` instances.~~一个内部命令，用于返回有关当前被挂起或挂起的锁的信息。仅适用于`mongod`实例。
`netstat`	~~Internal command that reports on intra-deployment connectivity.~~ 报告部署内连接的内部命令。~~Only available for `mongos` instances.~~仅适用于`mongos`实例。
`ping`	~~Internal command that tests intra-deployment connectivity.~~测试部署内连接的内部命令。
`profile`	~~Interface for the database profiler.~~数据库探查器的接口。
`serverStatus`	~~Returns a collection metrics on instance-wide resource utilization and status.~~返回实例范围内资源利用率和状态的集合度量。
`shardConnPoolStats`	~~Removed in MongoDB 5.0.~~在MongoDB 5.0中删除。 ~~Use `connPoolStats` instead.~~请改用`connPoolStats`。
`top`	~~Returns raw usage statistics for each database in the `mongod` instance.~~返回`mongod`实例中每个数据库的原始使用情况统计信息。
`validate`	~~Internal command that scans for a collection's data and indexes for correctness.~~用于扫描集合的数据和索引以确保正确性的内部命令。
`whatsmyuri`	~~Internal command that returns information on the current client.~~返回当前客户端信息的内部命令。

Free Monitoring Commands自由监视命令

~~Name~~名称	~~Description~~描述
`setFreeMonitoring`	~~Enables/disables free monitoring during runtime.~~启用/禁用运行时的免费监控。

Auditing Commands审核命令

~~Name~~名称	~~Description~~描述
`logApplicationMessage`	~~Posts a custom message to the audit log.~~将自定义消息发布到审核日志。

← Connection String URI FormatAggregation Commands →