Database Commands

All command documentation outlined below describes a command andits available parameters and provides a document template or prototypefor each command. Some command documentation also includes the relevantmongosh helpers.

To run a command against the current database, usedb.runCommand():

db.runCommand( { <command> } )

To run an administrative command against theadmin database, usedb.adminCommand():

db.adminCommand( { <command> } )

Note

For details on a specific command, including syntax and examples,click on the link to the command's reference page.

Command Syntax

When you run a database command, you specify the command as a documenttodb.runCommand(). The document's key is the command to run,and the value is typically supplied as1. The value does not affectthe output of the command for example:

db.runCommand( {hello:1 } )

User Commands

Aggregation Commands

Name	Description	MongoDB Atlas Support
`aggregate`	Performsaggregation tasks such as`$group` using an aggregation pipeline.	Limited support forFree and Flex clusters.
`count`	Counts the number of documents in a collection or a view.	Limited support forFree and Flex clusters.
`distinct`	Displays the distinct values found for a specified key in a collection or a view.	Limited support forFree and Flex clusters.
`mapReduce`	Performsmap-reduce aggregation for large data sets.	No support forFree and Flex clusters.

Query and Write Operation Commands

Name	Description	MongoDB Atlas Support
`bulkWrite`	Performs many insert, update, and delete operations on multiplecollections in one request. New in version 8.0.	Yes
`delete`	Deletes one or more documents.	Yes
`find`	Selects documents in a collection or a view.	Limited support forFree and Flex clusters.
`findAndModify`	Returns and modifies a single document.	Yes
`insert`	Inserts one or more documents.	Yes
`update`	Updates one or more documents.	Yes

Query Plan Cache Commands

Name	Description	MongoDB Atlas Support
`planCacheClear`	Removes cached query plan(s) for a collection.	No support forFree and Flex clusters.
`planCacheClearFilters`	Clears index filter(s) for a collection.	No support forFree and Flex clusters.
`planCacheListFilters`	Lists the index filters for a collection.	No support forFree and Flex clusters.
`planCacheSetFilter`	Sets an index filter for a collection.	No support forFree and Flex clusters.

Database Operations

Authentication Commands

Name	Description	MongoDB Atlas Support
`authenticate`	Starts an authenticated session using a username and password.	No support forFree and Flex clusters.
`logout`	Terminates the current authenticated session.	Yes

User Management Commands

Name	Description	MongoDB Atlas Support
`createUser`	Creates a new user.	No support forFlex clusters, Free,andM10 clusters.
`dropAllUsersFromDatabase`	Deletes all users associated with a database.	No support forFree and Flex clusters.
`dropUser`	Removes a single user.	No support forM10 clusters.
`grantRolesToUser`	Grants a role and its privileges to a user.	No support forFlex clusters, Free,andM10 clusters.
`revokeRolesFromUser`	Removes a role from a user.	No support forFlex clusters, Free,andM10 clusters.
`updateUser`	Updates a user's data.	No support forFlex clusters, Free,andM10 clusters.
`usersInfo`	Returns information about the specified users.	Limited support forFree and Flex clusters.

Role Management Commands

Name	Description	MongoDB Atlas Support
`createRole`	Creates a role and specifies its privileges.	No support forFlex clusters, Free,andM10 clusters.
`dropRole`	Deletes the user-defined role.	No support forFlex clusters, Free,andM10 clusters.
`dropAllRolesFromDatabase`	Deletes all user-defined roles from a database.	No support forFree and Flex clusters.
`grantPrivilegesToRole`	Assigns privileges to a user-defined role.	No support forFree and Flex clusters.
`grantRolesToRole`	Specifies roles from which a user-defined role inherits privileges.	No support forFree and Flex clusters.
`invalidateUserCache`	Flushes the in-memory cache of user information, including credentials and roles.	No support forFree and Flex clusters.
`revokePrivilegesFromRole`	Removes the specified privileges from a user-defined role.	No support forFree and Flex clusters.
`revokeRolesFromRole`	Removes specified inherited roles from a user-defined role.	No support forFree and Flex clusters.
`rolesInfo`	Returns information for the specified role or roles.	Yes
`updateRole`	Updates a user-defined role.	No support forFlex clusters, Free,andM10 clusters.

Replication Commands

Name	Description	MongoDB Atlas Support
`appendOplogNote`	Writes a non-operational entry to theoplog.	No support forFree and Flex clusters.
`applyOps`	Internal command that appliesoplog entries to the current data set.	Yes
`hello`	Displays information about this member's role in the replica set, including whether it is the primary.	Yes
`replSetAbortPrimaryCatchUp`	Forces the electedprimary to abort sync (catch up) then complete the transition to primary.	Yes
`replSetFreeze`	Prevents the current member from seeking election asprimary for a period of time.	No support forFlex clusters, Free,andM10 clusters.
`replSetGetConfig`	Returns the replica set's configuration object.	No support forFree and Flex clusters.
`replSetGetStatus`	Returns a document that reports on the status of the replica set.	No support forFree and Flex clusters.
`replSetInitiate`	Initializes a new replica set.	No support forFlex clusters, Free,andM10 clusters.
`replSetMaintenance`	Enables or disables a maintenance mode, which puts asecondary node in a`RECOVERING` state.	No support forFlex clusters, Free,andM10 clusters.
`replSetReconfig`	Applies a new configuration to an existing replica set.	No support forFlex clusters, Free,andM10 clusters.
`replSetResizeOplog`	Dynamically resizes the oplog for a replica set member. Available for WiredTiger storage engine only.	No support forM10 clusters.
`replSetStepDown`	Forces the currentprimary tostep down and become asecondary, forcing an election.	No support forFlex clusters, Free,andM10 clusters.
`replSetSyncFrom`	Explicitly override the default logic for selecting a member to replicate from.	No support forFlex clusters, Free,andM10 clusters.

Tip

Replication for more information regardingreplication.

Sharding Commands

Name	Description	MongoDB Atlas Support
`abortReshardCollection`	Aborts aresharding operation.	Yes
`abortMoveCollection`	Stops an in-progress`moveCollection` operation. New in version 8.0.	No support for AtlasFree and Flex tier.
`abortUnshardCollection`	Stops an in-progress`unshardCollection` operation. New in version 8.0.	No support for AtlasFree and Flex tier.
`addShard`	Adds ashard to asharded cluster.	Yes
`addShardToZone`	Associates a shard with azone. Supports configuringzones in sharded clusters.	Yes
`analyzeShardKey`	Calculates metrics for evaluating a shard key. New in version 7.0.	Yes
`balancerCollectionStatus`	Returns information on whether the chunks of a shardedcollection are balanced.	Yes
`balancerStart`	Starts a balancer thread.	Yes
`balancerStatus`	Returns information on the balancer status.	Yes
`balancerStop`	Stops the balancer thread.	Yes
`checkMetadataConsistency`	Performs a series of consistency checks on sharding metadata. New in version 7.0.	Yes
`clearJumboFlag`	Clears the`jumbo` flag for a chunk.	Yes
`cleanupReshardCollection`	Cleans up a failedresharding operation.	Yes
`commitReshardCollection`	Forces aresharding operation toblock writes and complete.	Yes
`configureCollectionBalancing`	Configures balancer settings on a sharded collection.	Yes
`configureQueryAnalyzer`	Configures query sampling for a collection. New in version 7.0.	Yes
`enableSharding`	Creates a database.	Yes
`flushRouterConfig`	Forces a`mongod` /`mongos` instance to update its cached routing metadata.	Yes
`getShardMap`	Internal command that reports on the state of a sharded cluster.	No support forFree and Flex clusters.
`isdbgrid`	Verifies that a process is a`mongos`.	Yes
`listShards`	Returns a list of configured shards.	Yes
`moveChunk`	Internal command that migrates chunks between shards.	Yes
`moveCollection`	Moves a single unsharded collection to a different shard.	Yes
`movePrimary`	Reassigns theprimary shard when removing a shard from a sharded cluster.	Yes
`moveRange`	Moves ranges between shards.	Yes
`mergeAllChunksOnShard`	Merges allmergeable chunks that a shardowns for a given collection.	Yes
`mergeChunks`	Provides the ability to combine chunks on a single shard.	Yes
`refineCollectionShardKey`	Refines a collection's shard key by adding a suffix to theexisting key.	No support forM10 clusters.
`removeShard`	Starts the process of removing a shard from a sharded cluster.	No support forM10 clusters.
`removeShardFromZone`	Removes the association between a shard and azone. Supports configuringzones in sharded clusters.	Yes
`reshardCollection`	Initiates aresharding operation to change theshard key for a collection, changing the distribution of your data.	Yes
`setAllowMigrations`	Prevents newautomatic migrations on a collection.	Yes
`shardCollection`	Enables the sharding functionality for a collection, allowing the collection to be sharded.	Yes
`shardingState`	Reports whether the`mongod` is a member of a sharded cluster.	Yes
`split`	Creates a newchunk.	Yes
`transitionFromDedicatedConfigServer`	Configures a dedicated config server to run as a config shard. New in version 8.0.	No support for AtlasFree and Flex tier.
`transitionToDedicatedConfigServer`	Configures a config shard to run as a dedicated config server. New in version 8.0.	No support for AtlasFree and Flex tier.
`unsetSharding`	Removed in MongoDB 5.0. Internal command that affectsconnections between instances in a MongoDB deployment.	Yes
`unshardCollection`	Unshards an existing sharded collection and moves the collectiondata onto a single shard. When you unshard a collection,the collection cannot be partitioned across multipleshards and theshard key is removed. New in version 8.0.	Yes
`updateZoneKeyRange`	Adds or removes the association between a range of sharded data and azone. Supports configuringzones in sharded clusters.	Yes

Tip

Sharding for more information about MongoDB'ssharding functionality.

Session Commands

Command	Description	Atlas Support
`abortTransaction`	Abort transaction.	Yes
`commitTransaction`	Commit transaction.	Yes
`endSessions`	Expire sessions before the sessions' timeout period.	Yes
`killAllSessions`	Kill all sessions.	No support forFlex clusters, Free,andM10 clusters.
`killAllSessionsByPattern`	Kill all sessions that match the specified pattern	No support forFree and Flex clusters.
`killSessions`	Kill specified sessions.	No support forFree and Flex clusters.
`refreshSessions`	Refresh idle sessions.	Yes
`startSession`	Starts a new session.	Yes

Administration Commands

Name	Description	MongoDB Atlas Support
`cloneCollectionAsCapped`	Copies a non-capped collection as a newcapped collection.	No support forFree and Flex clusters.
`collMod`	Add options to a collection or modify a view definition.	Yes
`compact`	Defragments a collection and rebuilds the indexes.	No support forFree and Flex clusters.
`compactStructuredEncryptionData`	Compacts documents specified in the state collections anddeletes redundant documents.	Yes
`convertToCapped`	Converts a non-capped collection to a capped collection.	Yes
`create`	Creates a collection or a view.	Yes
`createIndexes`	Builds one or more indexes for a collection.	Yes
`currentOp`	Returns a document that contains information on in-progress operations for the database instance.	Yes
`drop`	Removes the specified collection from the database.	Yes
`dropDatabase`	Removes the current database.	Yes
`dropConnections`	Drops outgoing connections to the specified list of hosts.	Yes
`dropIndexes`	Removes indexes from a collection.	Yes
`filemd5`	Deprecated. Returns themd5 hash for files stored usingGridFS.	Yes
`fsync`	Flushes pending writes to the storage layer and locks the database to allow backups.	No support forFlex clusters, Free,andM10 clusters.
`fsyncUnlock`	Unlocks one fsync lock.	No support forFree and Flex clusters.
`getDefaultRWConcern`	Retrieves the global default read and write concern optionsfor the deployment.	Yes
`getClusterParameter`	Retrieves cluster parameter values from all nodes in a cluster. New in version 6.0.	Yes
`getParameter`	Retrieves configuration options.	Limited support forFree and Flex clusters.
`killCursors`	Kills the specified cursors for a collection.	Yes
`killOp`	Terminates an operation as specified by the operation ID.	Limited support forFree,M10, andFlex clusters.
`listCollections`	Returns a list of collections in the current database.	Yes
`listDatabases`	Returns a document that lists all databases and returns basic database statistics.	Yes
`listIndexes`	Lists all indexes for a collection.	Yes
`logRotate`	Rotates the MongoDB logs to prevent a single file from taking too much space.	No support forFlex clusters, Free,andM10 clusters.
`reIndex`	Rebuilds all indexes on a collection.	No support forFree and Flex clusters.
`renameCollection`	Changes the name of an existing collection.	Yes
`rotateCertificates`	Performs online TLS certificate rotation.	Yes
`setFeatureCompatibilityVersion`	Enables or disables features that persist data that are backwards-incompatible.	No support forFlex clusters, Free,andM10 clusters.
`setIndexCommitQuorum`	Changes the minimum number of data-bearing members (i.e commitquorum), including the primary, that must vote to commit anin-progressindex build before the primary marksthose indexes as ready.	Yes
`setClusterParameter`	Modifies configuration options for all nodes in a replica set orsharded cluster. New in version 6.0.	Yes
`setParameter`	Modifies configuration options.	No support forFlex clusters, Free,andM10 clusters.
`setDefaultRWConcern`	Sets the global default read and write concern options for thedeployment.	Yes
`setUserWriteBlockMode`	Blocks and unblocks writes to the entire cluster.	No
`shutdown`	Shuts down the`mongod` or`mongos` process.	No support forFlex clusters, Free,andM10 clusters.
`validateDBMetadata`	Checks that the stored metadata of a database or a collectionis valid within a particular API version.	Yes

Diagnostic Commands

Name	Description	MongoDB Atlas Support
`buildInfo`	Displays statistics about the MongoDB build.	Yes
`collStats`	Reports storage utilization statics for a specified collection.	Yes
`connPoolStats`	Reports statistics on the outgoing connections from this MongoDB instance to other MongoDB instances in the deployment.	Yes
`connectionStatus`	Reports the authentication state for the current connection.	Yes
`dataSize`	Returns the data size for a range of data. For internal use.	No support forFree and Flex clusters.
`dbHash`	Returns hash value a database and its collections.	No support forFree and Flex clusters.
`dbStats`	Reports storage utilization statistics for the specified database.	Limited support forFree and Flex clusters.
`explain`	Returns information on the execution of various operations.	Yes
`getCmdLineOpts`	Returns a document with the run-time arguments to the MongoDB instance and their parsed options.	Yes
`getLog`	Returns recent log messages.	Yes
`hostInfo`	Returns data that reflects the underlying host system.	No support forFree and Flex clusters.
`listCommands`	Lists all database commands provided by the current`mongod` instance.	Yes
`lockInfo`	Internal command that returns information on locks that arecurrently being held or pending. Only available for`mongod` instances.	No support forFree and Flex clusters.
`ping`	Internal command that tests intra-deployment connectivity.	Yes
`profile`	Interface for thedatabase profiler.	Yes
`serverStatus`	Returns a collection metrics on instance-wide resource utilization and status.	Yes
`shardConnPoolStats`	Removed in MongoDB 5.0. Use`connPoolStats` instead.	Yes
`top`	Returns raw usage statistics for each database in the`mongod` instance.	Yes
`validate`	Internal command that scans for a collection's data and indexes for correctness.	No support forFree and Flex clusters.
`whatsmyuri`	Internal command that returns information on the current client.	Yes

Auditing Commands

Name	Description	MongoDB Atlas Support
`getAuditConfig`	Deprecated in version 7.1: Use the`auditConfig` clusterparameter instead. Retrieves audit configurations from`mongod` and`mongos` instances.	No
`logApplicationMessage`	Posts a custom message to the audit log.	Yes
`setAuditConfig`	Deprecated in version 7.1: Use the`auditConfig` clusterparameter instead. Sets audit configurations for`mongod` and`mongos` instances at runtime.	No

MongoDB Search Commands

New in version 7.0: (Also available starting in 6.0.7)

Name	Description
`createSearchIndexes`	Creates one or moreMongoDB Search indexes on a specified collection or view.
`dropSearchIndex`	Deletes an existingMongoDB Search index.
`updateSearchIndex`	Updates an existingMongoDB Search index.

Back

Examples

Query Plan Cache

Movatterモバイル変換