You are viewing an offline version of MongoDB documentation. Some page features might be unavailable. To view the latest version of the page or use interactive features, visit the live page.

Database Manual

Reference

Database 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.

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

db.runCommand( { <command> } )

To run an administrative command against the admin database, use 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(). The document's key is the command to run, and the value is typically supplied as 1. The value does not affect the output of the command for example:

db.runCommand( { hello: 1 } )

User Commands

Aggregation Commands

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

Geospatial Commands

Name	Description	MongoDB Atlas Support
`geoSearch`	Removed in MongoDB 5.0. Performs a geospatial query that uses MongoDB's haystack index functionality.	No support for serverless instances.

Query and Write Operation Commands

Name	Description	MongoDB Atlas Support
`delete`	Deletes one or more documents.	Yes
`find`	Selects documents in a collection or a view.	Limited support for M0, M2, M5, and Flex clusters.
`findAndModify`	Returns and modifies a single document.	Yes
`getMore`	Returns batches of documents currently pointed to by the cursor.	Yes
`insert`	Inserts one or more documents.	Yes
`resetError`	Removed in MongoDB 5.0. Resets the last error status.	No
`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 for M0, M2, M5, and Flex clusters.
`planCacheClearFilters`	Clears index filter(s) for a collection.	No support for M0, M2, M5, and Flex clusters.
`planCacheListFilters`	Lists the index filters for a collection.	No support for M0, M2, M5, and Flex clusters.
`planCacheSetFilter`	Sets an index filter for a collection.	No support for M0, M2, M5, and Flex clusters.

Database Operations

Authentication Commands

Name	Description	MongoDB Atlas Support
`authenticate`	Starts an authenticated session using a username and password.	No support for M0, M2, M5, 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 for Flex clusters, M0, M2, M5, and M10 clusters.
`dropAllUsersFromDatabase`	Deletes all users associated with a database.	No support for M0, M2, M5, and Flex clusters.
`dropUser`	Removes a single user.	No support for M10 clusters.
`grantRolesToUser`	Grants a role and its privileges to a user.	No support for Flex clusters, M0, M2, M5, and M10 clusters.
`revokeRolesFromUser`	Removes a role from a user.	No support for Flex clusters, M0, M2, M5, and M10 clusters.
`updateUser`	Updates a user's data.	No support for Flex clusters, M0, M2, M5, and M10 clusters.
`usersInfo`	Returns information about the specified users.	Limited support for M0, M2, M5, and Flex clusters.

Role Management Commands

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

Replication Commands

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

Sharding Commands

Name	Description	MongoDB Atlas Support
`abortReshardCollection`	Aborts a resharding operation. New in version 5.0.	Yes
`addShard`	Adds a shard to a sharded cluster.	No support for serverless instances.
`addShardToZone`	Associates a shard with a zone. Supports configuring zones in sharded clusters.	No support for serverless instances.
`analyzeShardKey`	Calculates metrics for evaluating a shard key. New in version 7.0.	Yes
`balancerCollectionStatus`	Returns information on whether the chunks of a sharded collection are balanced.	No support for serverless instances.
`balancerStart`	Starts a balancer thread.	No support for serverless instances.
`balancerStatus`	Returns information on the balancer status.	No support for serverless instances.
`balancerStop`	Stops the balancer thread.	No support for serverless instances.
`checkMetadataConsistency`	Performs a series of consistency checks on sharding metadata. New in version 7.0.	Yes
`clearJumboFlag`	Clears the `jumbo` flag for a chunk.	No support for serverless instances.
`cleanupOrphaned`	Removes orphaned data with shard key values outside of the ranges of the chunks owned by a shard.	No support for M0, M2, and M5 clusters.
`cleanupReshardCollection`	Cleans up a failed resharding operation. New in version 5.0.	Yes
`commitReshardCollection`	Forces a resharding operation to block writes and complete. New in version 5.0.	Yes
`configureCollectionBalancing`	Configures balancer settings on a sharded collection. New in version 5.3.	Yes
`configureQueryAnalyzer`	Configures query sampling for a collection. New in version 7.0.	Yes
`enableSharding`	Creates a database.	No support for serverless instances.
`flushRouterConfig`	Forces a `mongod` / `mongos` instance to update its cached routing metadata.	No support for serverless instances.
`getShardMap`	Internal command that reports on the state of a sharded cluster.	No support for M0, M2, M5, and Flex clusters and serverless instances.
`isdbgrid`	Verifies that a process is a `mongos`.	Yes
`listShards`	Returns a list of configured shards.	No support for serverless instances.
`moveChunk`	Internal command that migrates chunks between shards.	No support for serverless instances.
`movePrimary`	Reassigns the primary shard when removing a shard from a sharded cluster.	No support for serverless instances.
`moveRange`	Moves ranges between shards.	Yes
`mergeAllChunksOnShard`	Merges all mergeable chunks that a shard owns for a given collection.	No support for serverless instances.
`mergeChunks`	Provides the ability to combine chunks on a single shard.	No support for serverless instances.
`refineCollectionShardKey`	Refines a collection's shard key by adding a suffix to the existing key.	No support for M10 clusters and serverless instances.
`removeShard`	Starts the process of removing a shard from a sharded cluster.	No support for M10 clusters and serverless instances.
`removeShardFromZone`	Removes the association between a shard and a zone. Supports configuring zones in sharded clusters.	No support for serverless instances.
`reshardCollection`	Initiates a resharding operation to change the shard key for a collection, changing the distribution of your data. New in version 5.0.	Yes
`setAllowMigrations`	Prevents new automatic migrations on a collection.	No support for serverless instances.
`shardCollection`	Enables the sharding functionality for a collection, allowing the collection to be sharded.	No support for serverless instances.
`shardingState`	Reports whether the `mongod` is a member of a sharded cluster.	Yes
`split`	Creates a new chunk.	No support for serverless instances.
`unsetSharding`	Removed in MongoDB 5.0. Internal command that affects connections between instances in a MongoDB deployment.	Yes
`updateZoneKeyRange`	Adds or removes the association between a range of sharded data and a zone. Supports configuring zones in sharded clusters.	No support for serverless instances.

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 for Flex clusters, M0, M2, M5, and M10 clusters.
`killAllSessionsByPattern`	Kill all sessions that match the specified pattern	No support for M0, M2, M5, and Flex clusters.
`killSessions`	Kill specified sessions.	No support for M0, M2, M5, 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 new capped collection.	No support for M0, M2, M5, and Flex clusters and serverless instances.
`collMod`	Add options to a collection or modify a view definition.	Yes
`compact`	Defragments a collection and rebuilds the indexes.	No support for M0, M2, M5, and Flex clusters.
`compactStructuredEncryptionData`	Compacts documents specified in the state collections and deletes redundant documents.	Yes
`convertToCapped`	Converts a non-capped collection to a capped collection.	No support for serverless instances.
`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`	Returns the md5 hash for files stored using GridFS.	Yes
`fsync`	Flushes pending writes to the storage layer and locks the database to allow backups.	No support for Flex clusters, M0, M2, M5, and M10 clusters.
`fsyncUnlock`	Unlocks one fsync lock.	No support for M0, M2, M5, and Flex clusters.
`getDefaultRWConcern`	Retrieves the global default read and write concern options for 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 for M0, M2, M5, and Flex clusters.
`killCursors`	Kills the specified cursors for a collection.	Yes
`killOp`	Terminates an operation as specified by the operation ID.	Limited support for M0, M2, M5, M10, and Flex 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 for Flex clusters, M0, M2, M5, and M10 clusters.
`reIndex`	Rebuilds all indexes on a collection.	No support for M0, M2, M5, 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 for Flex clusters, M0, M2, M5, and M10 clusters.
`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.	Yes
`setClusterParameter`	Modifies configuration options for all nodes in a replica set or sharded cluster. New in version 6.0.	Yes
`setParameter`	Modifies configuration options.	No support for Flex clusters, M0, M2, M5, and M10 clusters.
`setUserWriteBlockMode`	Blocks and unblocks writes to the entire cluster.	No
`setDefaultRWConcern`	Sets the global default read and write concern options for the deployment.	Yes
`shutdown`	Shuts down the `mongod` or `mongos` process.	No support for Flex clusters, M0, M2, M5, and M10 clusters.
`validateDBMetadata`	Checks that the stored metadata of a database or a collection is valid within a particular API version. New in version 5.0.	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 for M0, M2, M5, and Flex clusters.
`dbHash`	Returns hash value a database and its collections.	No support for M0, M2, M5, and Flex clusters and serverless instances.
`dbStats`	Reports storage utilization statistics for the specified database.	Limited support for M0, M2, M5, 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 for M0, M2, M5, and Flex clusters.
`listCommands`	Lists all database commands provided by the current `mongod` instance.	Yes
`lockInfo`	Internal command that returns information on locks that are currently being held or pending. Only available for `mongod` instances.	No support for M0, M2, M5, and Flex clusters.
`ping`	Internal command that tests intra-deployment connectivity.	Yes
`profile`	Interface for the database profiler.	Yes
`serverStatus`	Returns a collection metrics on instance-wide resource utilization and status.	Yes
`shardConnPoolStats`	Removed in MongoDB 5.0. Use `connPoolStats` instead.	No support for serverless instances.
`top`	Returns raw usage statistics for each database in the `mongod` instance.	No support for serverless instances.
`validate`	Internal command that scans for a collection's data and indexes for correctness.	No support for M0, M2, M5, and Flex clusters and serverless instances.
`whatsmyuri`	Internal command that returns information on the current client.	Yes

Auditing Commands

Name	Description	MongoDB Atlas Support
`getAuditConfig`	Retrieves audit configurations from `mongod` and `mongos` instances.	No
`logApplicationMessage`	Posts a custom message to the audit log.	Yes
`setAuditConfig`	Sets audit configurations for `mongod` and `mongos` instances at runtime.	No

Atlas Search Commands

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

Name	Description
`createSearchIndexes`	Creates one or more Atlas Search indexes on a specified collection.
`dropSearchIndex`	Deletes an existing Atlas Search index.
`updateSearchIndex`	Updates an existing Atlas Search index.

Back

Connection String Examples

Aggregation