MongoDB Reference Manual

This document contains all of the reference material from the MongoDB Manual, reflecting the 2.2.7 release. See the full manual, for complete documentation of MongoDB, it’s operation, and use.

Interfaces Reference

mongo Shell Reference

• Date()
• Mongo()
• Mongo.getDB()
• ObjectId.getTimestamp()
• ObjectId.toString()
• ObjectId.valueOf()
• cat()
• cd()
• connect()
• copyDbpath()
• cursor.addOption()
• cursor.batchSize()
• cursor.count()
• cursor.explain()
• cursor.forEach()
• cursor.hasNext()
• cursor.hint()
• cursor.limit()
• cursor.map()
• cursor.max()
• cursor.min()
• cursor.next()
• cursor.objsLeftInBatch()
• cursor.readPref()
• cursor.showDiskLoc()
• cursor.size()
• cursor.skip()
• cursor.snapshot()
• cursor.sort()
• cursor.toArray()
• db.addUser()
• db.auth()
• db.cloneCollection()
• db.cloneDatabase()
• db.collection.aggregate()
• db.collection.copyTo()
  • Definition
  • Example
• db.collection.count()
• db.collection.createIndex()
• db.collection.dataSize()
• db.collection.distinct()
• db.collection.drop()
• db.collection.dropIndex()
• db.collection.dropIndexes()
• db.collection.ensureIndex()
• db.collection.find()
• db.collection.findAndModify()
• db.collection.findOne()
• db.collection.getIndexes()
• db.collection.getShardDistribution()
• db.collection.getShardVersion()
• db.collection.group()
• db.collection.insert()
• db.collection.isCapped()
• db.collection.mapReduce()
  • Requirements for the map Function
  • Requirements for the reduce Function
  • out Options
    • Output to a Collection
    • Output to a Collection with an Action
    • Output Inline
  • Requirements for the finalize Function
  • Map-Reduce Examples
    • Return the Total Price Per Customer Id
    • Calculate the Number of Orders, Total Quantity, and Average Quantity Per Item
• db.collection.reIndex()
• db.collection.remove()
• db.collection.renameCollection()
• db.collection.save()
• db.collection.stats()
• db.collection.storageSize()
• db.collection.totalIndexSize()
• db.collection.totalSize()
• db.collection.update()
• db.collection.validate()
• db.commandHelp()
• db.copyDatabase()
• db.createCollection()
• db.currentOp()
• db.dropDatabase()
• db.eval()
• db.fsyncLock()
• db.fsyncUnlock()
• db.getCollection()
• db.getCollectionNames()
• db.getLastError()
• db.getLastErrorObj()
• db.getMongo()
• db.getName()
• db.getPrevError()
• db.getProfilingLevel()
• db.getProfilingStatus()
• db.getReplicationInfo()
• db.getSiblingDB()
• db.help()
• db.isMaster()
• db.killOp()
• db.listCommands()
• db.loadServerScripts()
• db.logout()
• db.printCollectionStats()
• db.printReplicationInfo()
• db.printShardingStatus()
• db.printSlaveReplicationInfo()
• db.removeUser()
• db.repairDatabase()
• db.resetError()
• db.runCommand()
• db.serverBuildInfo()
• db.serverStatus()
• db.setProfilingLevel()
• db.shutdownServer()
• db.stats()
• db.version()
• fuzzFile()
• getHostName()
• getMemInfo
• hostname()
• _isWindows()
• listFiles()
• load()
• ls()
• md5sumFile()
• mkdir()
• pwd()
• quit()
• rand()
• removeFile()
• resetDbpath()
• rs.add()
• rs.addArb()
• rs.conf()
• rs.freeze()
• rs.help()
• rs.initiate()
• rs.reconfig()
• rs.remove()
• rs.status()
• rs.stepDown()
• rs.syncFrom()
• sh.addShard()
• sh.addShardTag()
• sh.addTagRange()
• sh.disableBalancing()
• sh.enableBalancing()
• sh.enableSharding()
• sh.getBalancerHost()
• sh.getBalancerState()
• sh.help()
• sh.isBalancerRunning()
• sh.moveChunk()
• sh.removeShardTag()
• sh.setBalancerState()
• sh.shardCollection()
• sh.splitAt()
• sh.splitFind()
• sh.startBalancer()
• sh.status()
• sh.stopBalancer()
• sh.waitForBalancer()
• sh.waitForBalancerOff()
• sh.waitForPingChange()
• _srand()
• version()

Database Command Reference

• addShard
• aggregate
• applyOps (internal)
• authenticate
• availableQueryOptions (internal)
• buildInfo
• checkShardingIndex (internal)
• clean (internal)
• clone
• cloneCollection
• cloneCollectionAsCapped
• closeAllDatabases (internal)
• collMod
• collStats
• compact
• connPoolStats
• connPoolSync (internal)
• convertToCapped
• copydb
• copydbgetnonce (internal)
• count
• create
• cursorInfo
• dataSize
• dbHash (internal)
• dbStats
• diagLogging (internal)
• distinct
• driverOIDTest (internal)
• drop
• dropDatabase
• dropIndexes
• enableSharding
• eval
• features (internal)
• filemd5
• findAndModify
• flushRouterConfig
• fsync
• geoNear
• geoSearch
• geoWalk
• getCmdLineOpts
• getLastError
• getLog
• getParameter
• getPrevError
• getShardMap (internal)
• getShardVersion (internal)
• getnonce (internal)
• getoptime (internal)
• group
• isMaster
• isSelf (internal)
• isdbgrid
• listCommands
• listDatabases
• listShards
• logRotate
• logout
• mapReduce
  • Examples
    • Return the Total Price Per Customer Id
    • Calculate the Number of Orders, Total Quantity, and Average Quantity Per Item
• medianKey (internal)
• moveChunk
• movePrimary
• netstat (internal)
• ping
• profile
• reIndex
• removeShard
• renameCollection
• repairDatabase
• replSetFreeze
• replSetGetStatus
• replSetInitiate
• replSetMaintenance
• replSetReconfig
• replSetStepDown
• replSetSyncFrom
• resetError
• resync
• serverStatus
• setParameter
• setShardVersion
• shardCollection
• shardingState
• shutdown
• split
• splitChunk
• splitVector
• top
• touch
• unsetSharding (internal)
• validate
• whatsmyuri (internal)

Query, Update, Projection, and Meta-Query Operators

• Aggregation Operators
  • $add (aggregation)
  • $addToSet (aggregation)
  • $and (aggregation)
  • $avg (aggregation)
  • $cmp (aggregation)
  • $cond (aggregation)
  • $dayOfMonth (aggregation)
  • $dayOfWeek (aggregation)
  • $dayOfYear (aggregation)
  • $divide (aggregation)
  • $eq (aggregation)
  • $first (aggregation)
  • $group (aggregation)
  • $gt (aggregation)
  • $gte (aggregation)
  • $hour (aggregation)
  • $ifNull (aggregation)
  • $last (aggregation)
  • $limit (aggregation)
  • $lt (aggregation)
  • $lte (aggregation)
  • $match (aggregation)
  • $max (aggregation)
  • $min (aggregation)
  • $minute (aggregation)
  • $mod (aggregation)
  • $month (aggregation)
  • $multiply (aggregation)
  • $ne (aggregation)
  • $not (aggregation)
  • $or (aggregation)
  • $project (aggregation)
  • $push (aggregation)
  • $second (aggregation)
  • $skip (aggregation)
  • $sort (aggregation)
  • $strcasecmp (aggregation)
  • $substr (aggregation)
  • $subtract (aggregation)
  • $sum (aggregation)
  • $toLower (aggregation)
  • $toUpper (aggregation)
  • $unwind (aggregation)
  • $week (aggregation)
  • $year (aggregation)
• Query, Update, Projection Operators
  • $all
  • $and
  • $box
  • $center
  • $centerSphere
  • $elemMatch (query)
  • $exists
  • $gt
  • $gte
  • $in
  • $lt
  • $lte
  • $maxDistance
  • $mod
  • $ne
  • $near
  • $nearSphere
  • $nin
  • $nor
  • $not
  • $or
  • $polygon
  • $regex
    • Behavior
  • $size
  • $type
  • $uniqueDocs
  • $where
  • $within
  • $addToSet
  • $bit
  • $each
  • $inc
  • $isolated
  • $pop
  • $ (update)
  • $pull
  • $pullAll
  • $push
  • $pushAll
  • $rename
  • $set
  • $unset
  • $elemMatch (projection)
  • $ (projection)
  • $slice (projection)
  • $comment
  • $explain
  • $hint
  • $max
  • $maxScan
  • $min
  • $natural
  • $orderby
  • $query
  • $returnKey
  • $showDiskLoc
  • $snapshot

Aggregation Framework Operators

• Aggregation Framework Reference
  • Pipeline
  • Expressions
    • $group Operators
    • Boolean Operators
    • Comparison Operators
    • Arithmetic Operators
    • String Operators
    • Date Operators
    • Conditional Expressions

MongoDB and SQL Interface Comparisons

• SQL to MongoDB Mapping Chart
• SQL to Aggregation Mapping Chart

Status, Monitoring, and Reporting Output

• Server Status Reference
  • Instance Information
  • locks
  • globalLock
    • globalLock.currentQueue
    • globalLock.activeClients
  • mem
  • connections
  • extra_info
  • indexCounters
  • backgroundFlushing
  • cursors
  • network
  • repl
  • opcountersRepl
  • replNetworkQueue
  • opcounters
  • asserts
  • writeBacksQueued
  • dur
    • Journaling
  • recordStats
• Database Statistics Reference
  • Synopsis
  • Fields
• Collection Statistics Reference
  • Synopsis
  • Example Document
  • Fields
• Connection Pool Statistics Reference
  • Synopsis
  • Output
• Replica Set Status Reference
  • Fields
  • Member Statuses
• Exit Codes and Statuses
• Current Operation Reporting
  • Example Output
  • Operations
  • Output Reference

Program and Tool Reference Pages

• MongoDB Package Components
  • Core Processes
    • mongod
    • mongos
    • mongo
  • Windows Services
    • mongod.exe
    • mongos.exe
  • Binary Import and Export Tools
    • mongodump
    • mongorestore
    • bsondump
    • mongooplog
  • Data Import and Export Tools
    • mongoimport
    • mongoexport
  • Diagnostic Tools
    • mongostat
    • mongotop
    • mongosniff
    • mongoperf
  • GridFS
    • mongofiles

Internal Metadata

• Config Database Contents
• The local Database
• System Collections

General System Reference

• MongoDB Limits and Thresholds
• Glossary

Release Notes

Always install the latest, stable version of MongoDB. See Version Numbers for more information.

See the following release notes for an account of the changes in major versions. Release notes also include instructions for upgrade.

Current Stable Release

(2.2-series)

• Release Notes for MongoDB 2.2

See Changes in MongoDB 2.2 for an overview of all changes in 2.2.

Previous Stable Releases

• Release Notes for MongoDB 2.0
• Release Notes for MongoDB 1.8
• Release Notes for MongoDB 1.6
• Release Notes for MongoDB 1.4
• Release Notes for MongoDB 1.2.x

Other MongoDB Release Notes

• Default Write Concern Change
  • Changes
  • Releases

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.