Navigation
This version of the documentation is archived and no longer supported.
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
mongo
shell helpers.
To run a command, use the db.runCommand()
:
Note
For details on specific commands, including syntax and examples,
click on the specific command to go to its reference page.
User Commands
Aggregation Commands
Name |
Description |
aggregate |
Performs aggregation tasks such as group using the aggregation framework. |
count |
Counts the number of documents in a collection. |
distinct |
Displays the distinct values found for a specified key in a collection. |
group |
Groups documents in a collection by the specified key and performs simple aggregation. |
mapReduce |
Performs map-reduce aggregation for large data sets. |
Geospatial Commands
Name |
Description |
geoNear |
Performs a geospatial query that returns the documents closest to a given point. |
geoSearch |
Performs a geospatial query that uses MongoDB’s haystack index functionality. |
Query and Write Operation Commands
Name |
Description |
find |
Selects documents in a collection. |
insert |
Inserts one or more documents. |
update |
Updates one or more documents. |
delete |
Deletes one or more documents. |
findAndModify |
Returns and modifies a single document. |
getMore |
Returns batches of documents currently pointed to by the cursor. |
getLastError |
Returns the success status of the last operation. |
getPrevError |
Returns status document containing all errors since the last resetError command. |
resetError |
Resets the last error status. |
eval |
Deprecated. Runs a JavaScript function on the database server. |
parallelCollectionScan |
Lets applications use multiple parallel cursors when reading documents from a collection. |
Query Plan Cache Commands
Database Operations
Authentication Commands
Name |
Description |
logout |
Terminates the current authenticated session. |
authenticate |
Starts an authenticated session using a username and password. |
copydbgetnonce |
This is an internal command to generate a one-time password for use with the copydb command. |
getnonce |
This is an internal command to generate a one-time password for authentication. |
authSchemaUpgrade |
Supports the upgrade process for user data between version 2.4 and 2.6. |
Replication Commands
See also
Replication for more information regarding
replication.
Sharding Commands
See also
Sharding for more information about MongoDB’s
sharding functionality.
Instance Administration Commands
Name |
Description |
renameCollection |
Changes the name of an existing collection. |
copydb |
Copies a database from a remote host to the current host. |
dropDatabase |
Removes the current database. |
listCollections |
Returns a list of collections in the current database. |
drop |
Removes the specified collection from the database. |
create |
Creates a collection and sets collection parameters. |
clone |
Copies a database from a remote host to the current host. |
cloneCollection |
Copies a collection from a remote host to the current host. |
cloneCollectionAsCapped |
Copies a non-capped collection as a new capped collection. |
convertToCapped |
Converts a non-capped collection to a capped collection. |
filemd5 |
Returns the md5 hash for files stored using GridFS. |
createIndexes |
Builds one or more indexes for a collection. |
listIndexes |
Lists all indexes for a collection. |
dropIndexes |
Removes indexes from a collection. |
fsync |
Flushes pending writes to the storage layer and locks the database to allow backups. |
clean |
Internal namespace administration command. |
connPoolSync |
Internal command to flush connection pool. |
connectionStatus |
Reports the authentication state for the current connection. |
compact |
Defragments a collection and rebuilds the indexes. |
collMod |
Add flags to collection to modify the behavior of MongoDB. |
reIndex |
Rebuilds all indexes on a collection. |
setParameter |
Modifies configuration options. |
getParameter |
Retrieves configuration options. |
repairDatabase |
Rebuilds the database and indexes by discarding invalid or corrupt data. |
killCursors |
Kills the specified cursors for a collection. |
touch |
Loads documents and indexes from data storage to memory. |
shutdown |
Shuts down the mongod or mongos process. |
logRotate |
Rotates the MongoDB logs to prevent a single file from taking too much space. |
killOp |
Terminates an operation as specified by the operation ID. |
Diagnostic Commands
Name |
Description |
availableQueryOptions |
Internal command that reports on the capabilities of the current MongoDB instance. |
buildInfo |
Displays statistics about the MongoDB build. |
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. |
cursorInfo |
Removed in MongoDB 3.2. Replaced with metrics.cursor . |
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. |
diagLogging |
Provides a diagnostic logging. For internal use. |
driverOIDTest |
Internal command that converts an ObjectId to a string to support tests. |
explain |
Returns information on the execution of various operations. |
features |
Reports on features available in the current MongoDB instance. |
getCmdLineOpts |
Returns a document with the run-time arguments to the MongoDB instance and their parsed options. |
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. |
listDatabases |
Returns a document that lists all databases and returns basic database statistics. |
netstat |
Internal command that reports on intra-deployment connectivity. Only available for mongos instances. |
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 |
Reports statistics on a mongos ’s connection pool for client
operations against shards. |
top |
Returns raw usage statistics for each database in the mongod instance. |
validate |
Internal command that scans for a collection’s data and indexes for correctness. |
whatsmyuri |
Internal command that returns information on the current client. |