About this guide

This guide covers:

  • Using MongoDB commands
  • Using auxilliary functions that help with database administration

This work is licensed under a Creative Commons Attribution 3.0 Unported License (including images & stylesheets). The source is available on Github.

What version of Monger does this guide cover?

This guide covers Monger 1.7 (including beta releases).

Overview

The MongoDB command interface provides access to all non CRUD database operations. Fetching server stats, initializing a replica set, and running a map-reduce job are all accomplished by running a command.

You specify a command first by constructing a standard BSON document whose first key is the name of the command. For example, specify the isMaster command using the following BSON document (demonstrated here as an ordered Clojure map):

(sorted-map "isMaster" 1)

Some MongoDB commands are version-specific. Some implement sophisticated features, for example, the Aggregation Framework support, and some are administrative in nature, like reindexing a collection.

With Monger, you use monger.core/command function to run commands. monger.result/ok? can be used to determine if a command succeeded or not, monger.conversion/from-db-object is used to convert a command results to a Clojure map. Here is an example that demonstrates all three:

(ns monger.docs.examples
  (:require [monger.core :refer [command]]
            [monger.result :refer [ok?]]
            [monger.conversion :refer [from-db-object]]))

(let [raw-result (command (sorted-map :isMaster 1))
      result     (from-db-object raw-result true)]
  ;= true
  (ok? raw-result)
  ;; {:serverUsed 127.0.0.1:27017, :ismaster true, :maxBsonObjectSize 16777216, :ok 1.0}
  (println result))

MongoDB command reference lists available DB commands. Command document structure with Monger is exactly the same as in the MongoDB shell and MongoDB manual guides. If your command happens to include operators ($gt, $lt, $regex, etc), you can use macros in the monger.operators namespace, just like with queries.

Monger command API was designed to for flexibility: it lets developers to use new commands as soon as MongoDB server supports them. However, many commands are used more often than others and their API does not change any more. Monger provides convenient functions for some of them in the monger.command namespace.

MongoDB Commands and Map Ordering

MongoDB command documents may depend on map ordering. So, when using monger.core/command to execute commands Monger does not provide helper functions for, make sure you use clojure.core/sorted-map instead of a map literal. Otherwise you may start seeing "unknown command" errors.

Common Commands

Get collection stats

monger.command/collection-stats takes a collection names and returns collection stats:

(ns monger.docs.examples
  (:require [monger.command :as cmd])
            [monger.core :refer [command]]
            [monger.result :refer [ok?]]
            [monger.conversion :refer [from-db-object]])

;; #<CommandResult { "count" : 107281 , "size" : 52210704 , "avgObjSize" : 486.67242102515826 , "storageSize" : 65224704 , "numExtents" : 9 , "nindexes" : 6 , "lastExtentSize" : 17399808 , "paddingFactor" : 1.0 , "flags" : 1 , "totalIndexSize" : 26187728, …, "ok" : 1.0}>
(cmd/collection-stats "documents")

;; {:paddingFactor 1.0, :ok 1.0, …, :totalIndexSize 26187728, :count 107281, :avgObjSize 486.67242102515826, :lastExtentSize 17399808, :size 52210704, :storageSize 65224704, :flags 1, :nindexes 6, :numExtents 9}
(from-db-object (cmd/collection-stats "documents") true)

Get database stats

monger.command/db-stats is similar to monger.command/collection-stats but returns database stats:

(ns monger.docs.examples
  (:require [monger.command :as cmd]
            [monger.conversion :refer [from-db-object]]))

;= #<CommandResult { "serverUsed" : "127.0.0.1:27017" , "db" : "…" , "collections" : 25 , "objects" : 312807 , "avgObjSize" : 297.94926584123755 , "dataSize" : 93200616 , "storageSize" : 116150272 , "numExtents" : 53 , "indexes" : 37 , "indexSize" : 33088272 , "fileSize" : 469762048 , "nsSizeMB" : 16 , "ok" : 1.0}>
(cmd/db-stats "documents")

;= {:objects 312807, :collections 25, :nsSizeMB 16, :ok 1.0, :avgObjSize 297.94926584123755, :indexes 37, :storageSize 116150272, :fileSize 469762048, :dataSize 93200616, :serverUsed "127.0.0.1:27017", :numExtents 53, :db "…", :indexSize 33088272}
(from-db-object (cmd/db-stats "documents") true)

Reindex a collection

(ns monger.docs.examples
  (:require [monger.command :as cmd]
            [monger.conversion :refer [from-db-object]]))

(cmd/reindex-collection "pages")

Get server status

monger.command/server-status returns stats for the MongoDB server Monger is connected to.

Run "top" command

monger.command/top provides programmatic access to the same information mongotop command line tool outputs.

Specifically, it returns raw usage of each database, and provides amount of time, in microseconds, used and a count of operations for the following event types:

  • total
  • readLock
  • writeLock
  • queries
  • getmore
  • insert
  • update
  • remove
  • commands

What to Read Next

Congratulations, this is the last guide. For the definitive list of commands MongoDB supports, see MongoDB command reference.

Take a look at other guides, they cover all kinds of topics.

Tell Us What You Think!

Please take a moment to tell us what you think about this guide on Twitter or the Monger mailing list

Let us know what was unclear or what has not been covered. Maybe you do not like the guide style or grammar or discover spelling mistakes. Reader feedback is key to making the documentation better.

comments powered by Disqus