Skip to content

Latest commit

 

History

History
138 lines (75 loc) · 4.69 KB

README.md

File metadata and controls

138 lines (75 loc) · 4.69 KB
Raw

Monger, a modern Clojure MongoDB Driver

Monger is an idiomatic Clojure MongoDB driver for a more civilized age.

It has batteries included, offers powerful expressive query DSL, strives to support every MongoDB 2.0+ feature and has sane defaults. Monger is built from the ground up for Clojure 1.3+ and sits on top of the official MongoDB Java driver.

Project Goals

There is one MongoDB client for Clojure that has been around since 2009. So, why create another one? Monger authors wanted a client that will

  • Support most of MongoDB 2.0+ features, focus on those that really matter.
  • Be well documented.
  • Be well tested.
  • Target Clojure 1.3.0 and later from the ground up.
  • Be as close to the Mongo shell query language as practical
  • Integrate with libraries like Joda Time, Cheshire, clojure.data.json, Ragtime.
  • Support URI connections to be friendly to Heroku and other PaaS providers.
  • Not carry technical debt from 2009 forever.
  • Integrate usage of JavaScript files and ClojureScript (as soon as the compiler gets artifact it is possible to depend on for easy embedding).

Community

Monger has a mailing list. Feel free to join it and ask any questions you may have.

To subscribe for announcements of releases, important changes and so on, please follow @ClojureWerkz on Twitter.

Project Maturity

Monger is not a young project: started in July 2011, it is over 1 year old with active production use from week 1.

Artifacts

Monger artifacts are released to Clojars. If you are using Maven, add the following repository definition to your pom.xml:

<repository>
  <id>clojars.org</id>
  <url>http://clojars.org/repo</url>
</repository>

The Most Recent Release

With Leiningen:

[com.novemberain/monger "1.5.0"]

With Maven:

<dependency>
  <groupId>com.novemberain</groupId>
  <artifactId>monger</artifactId>
  <version>1.5.0</version>
</dependency>

Getting Started

Please refer to our Getting Started guide. Don't hesitate to join our mailing list and ask questions, too!

Documentation & Examples

Please see our documentation guides site and API reference.

Our test suite also has many code examples.

Supported Clojure versions

Monger is built from the ground up for Clojure 1.3 and up. The most recent stable releaseis recommended.

Continuous Integration Status

Continuous Integration status

Monger Is a ClojureWerkz Project

Monger is part of the group of Clojure libraries known as ClojureWerkz, together with Neocons, Langohr, Elastisch, Welle, Quartzite and several others.

Write Performance

Monger insert operations are efficient and have very little overhead compared to the underlying Java driver. Here are some (very unscientific) numbers on a MacBook Pro from fall 2010 with Core i7 and an Intel SSD drive:

Testing monger.test.stress
Inserting  1000  documents...
"Elapsed time: 25.699 msecs"
Inserting  10000  documents...
"Elapsed time: 135.069 msecs"
Inserting  100000  documents...
"Elapsed time: 515.969 msecs"

With the SAFE write concern, it takes roughly 0.5 second to insert 100,000 documents with Clojure 1.3.0.

Development

Monger uses Leiningen 2. Make sure you have it installed and then run tests against supported Clojure versions using

lein2 all do clean, javac, test

Then create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request on Github.

License

Copyright (C) 2011-2013 Michael S. Klishin

Double licensed under the Eclipse Public License (the same as Clojure) or the Apache Public License 2.0.