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.
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. |
geoWalk |
An internal command to support geospatial queries. |
Query and Write Operation Commands
Name |
Description |
findAndModify |
Returns and modifies a single document. |
text |
Performs a text search. |
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 |
Runs a JavaScript function on the database server. |
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. |
Replication Commands
Name |
Description |
replSetFreeze |
Prevents the current member from seeking election as primary for a period of time. |
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. |
replSetReconfig |
Applies a new configuration to an existing replica set. |
replSetStepDown |
Forces the current primary to step down and become a secondary, forcing an election. |
replSetSyncFrom |
Explicitly override the default logic for selecting a member to replicate from. |
resync |
Forces a mongod to re-synchronize from the master. For master-slave replication only. |
applyOps |
Internal command that applies oplog entries to the current data set. |
isMaster |
Displays information about this member’s role in the replica set, including whether it is the master. |
getoptime |
Internal command to support replication, returns the optime. |
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. |
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. |
closeAllDatabases |
Internal command that invalidates all cursors and closes open database files. |
convertToCapped |
Converts a non-capped collection to a capped collection. |
filemd5 |
Returns the md5 hash for files stored using GridFS. |
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 |
Repairs any errors and inconsistencies with the data storage. |
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. |
Diagnostic Commands
Name |
Description |
listDatabases |
Returns a document that lists all databases and returns basic database statistics. |
dbHash |
Internal command to support sharding. |
driverOIDTest |
Internal command that converts an ObjectId to a string to support tests. |
listCommands |
Lists all database commands provided by the current mongod instance. |
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. |
shardConnPoolStats |
Reports statistics on a mongos ’s connection pool for client
operations against shards. |
dbStats |
Reports storage utilization statistics for the specified database. |
cursorInfo |
Reports statistics on active cursors. |
dataSize |
Returns the data size for a range of data. For internal use. |
diagLogging |
Provides a diagnostic logging. For internal use. |
getCmdLineOpts |
Returns a document with the run-time arguments to the MongoDB instance and their parsed options. |
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. |
validate |
Internal command that scans for a collection’s data and indexes for correctness. |
top |
Returns raw usage statistics for each database in the mongod instance. |
indexStats |
Experimental command that collects and aggregates statistics on all indexes. |
whatsmyuri |
Internal command that returns information on the current client. |
getLog |
Returns recent log messages. |
hostInfo |
Returns data that reflects the underlying host system. |
serverStatus |
Returns a collection metrics on instance-wide resource utilization and status. |
features |
Reports on features available in the current MongoDB instance. |
isSelf |
Internal command to support testing. |