lbt05 / congomongo

Clojure wrapper for the mongo-db java api

CongoMongo

What?

A toolkit for using MongoDB with Clojure.

News

Version 0.1.10 (SNAPSHOT)

• Fix with-connection / with-db interaction (#75)

Version 0.1.9 - April 20th, 2012:

• Bump data.json => 0.1.3
• Bump multi test to 1.4.0 & 1.5.0-SNAPSHOT for Clojure
• Add with-db macro (#53, #54)
• Support vector :only in fetch-and-modify (to match fetch) (#65)
• Add group aggregation (#66)
• Allow insert! to respect previous set-write-concern call (#72)
• Add :safe, :fsync-safe, :replica-safe write concerns (#72)
• In order to get throw on error behavior, you must call set-write-concern with :safe or stricter!
• Deprecate :strict - use :safe instead

Version 0.1.8:

• adds fetch-by-ids (#44)
• improves error handling when connection not set up (#42)
• updates clojure.data.json to 0.1.2 (for performance fixes)
• numerous documentation fixes (#38, #39, #40, #41, #45)
• update to 2.7.3 driver (#46, #48)
• remove version ranges - make 1.3.0 the default Clojure version (#47 etc)
• add multi-version testing
• add Travis CI test hook

Version 0.1.7 adds the ability to create MongoOptions and pass them into make-connection as the last argument, so that you can control autoConnectRetry and timeouts and so on. This release also fixes a number of small bugs around type hints introduced in 0.1.6; corrects the upsert(?) parameter in fetch-and-modify; upgrades the Java driver to 2.6.5. The :only parameter can now be a map of field names and true / false values to allow fields to be included or excluded. The original vector of field names is still supported to include only the named fields.

Version 0.1.6 removes (almost) all of the reflection warnings.

Version 0.1.5 adds compatibility with Clojure 1.3, in addition to 1.2.

Congomongo 0.1.4 introduces support for MongoDB 1.8's modified map-reduce functionality, wherein the 'out' parameter is required. With this and future Congomongo releases, it will no longer be possible to access the map-reduce features of older MongoDB instances.

As of congomongo 0.1.3, Clojure 1.2 and Clojure-contrib 1.2 are required. If you need compatibility with Clojure 1.1, please stick with congomongo 0.1.2.

There is now a Google Group Come help us make ponies for great good.

Clojars group is congomongo.

=======

CongoMongo is essentially a Clojure api for the mongo-java-driver, transparently handling coercions between Clojure and Java data types.

Basics

Setup

import

(ns my-mongo-app
  (:use somnium.congomongo))

make a connection

(def conn
  (make-connection "mydb"
                   :host "127.0.0.1"
                   :port 27017))
=> #'user/conn

conn => {:mongo #<Mongo Mongo: 127.0.0.1:20717>, :db #<DBApiLayer mydb>}

set the connection globally

(set-connection! conn)

or locally

(with-mongo conn
    (insert! :robots {:name "robby"}))

specify a write concern (if you want errors reported)

(set-write-concern conn :safe)
;; :none will not report any errors
;; :normal will report network errors
;; :safe will report key constraint and other errors
;; :fsync-safe waits until a write is sync'd to the filesystem
;; :replica-safe waits until a write is sync'd to at least one replica as well
;; :strict is a synonym for :safe but is deprecated (as of 0.1.9)

Simple Tasks

---

create

(insert! :robots
         {:name "robby"})

read

(def my-robot (fetch-one :robots)) => #'user/my-robot

my-robot => { :name "robby",
              :_id  #<ObjectId> "0c23396f7e53e34a4c8cf400">,
              :_ns  "robots"}

update

(update! :robots my-robot (merge my-robot { :name "asimo" }))

=>  { :name "asimo" ,
      :_id  #<ObjectId> "0c23396f7e53e34a4c8cf400"> ,
      :_ns : "robots" }

destroy

(destroy! :robots my-robot) => nil
(fetch :robots) => ()

More Sophisticated Tasks

---

mass inserts

(mass-insert!
  :points
  (for [x (range 100) y (range 100)]
    {:x x
     :y y
     :z (* x y)}))

 =>  nil

(fetch-count :points)
=> 10000

ad-hoc queries

(fetch-one
  :points
  :where {:x {:$gt 10
              :$lt 20}
          :y 42
          :z {:$gt 500}})

=> {:x 12, :y 42, :z 504,  :_ns "points", :_id ... }

authentication

(authenticate conn "myusername" "my password")

=> true

advanced initialization using mongo-options

((make-connection :mydb :host "127.0.0.1" (mongo-options :auto-connect-retry true)"

easy json

(fetch-one :points
           :as :json)

=> "{ \"_id\" : \"0c23396ffe79e34a508cf400\" ,
      \"x\" : 0 , \"y\" : 0 , \"z\" : 0 , \"_ns\" : \"points\"}"

custom type conversions

For example, use Joda types for dates:

(extend-protocol somnium.congomongo.coerce.ConvertibleFromMongo
  Date
  (mongo->clojure [^java.util.Date d keywordize] (new org.joda.time.DateTime d)))

(extend-protocol somnium.congomongo.coerce.ConvertibleToMongo
  org.joda.time.DateTime
  (clojure->mongo [^org.joda.time.DateTime dt] (.toDate dt)))

Install

Leiningen is the recommended way to use congomongo. Just add

[congomongo "0.1.9"]

to your project.clj and do

$lein deps

to get congomongo and all of its dependencies.

Feedback

CongoMongo is a work in progress. If you've used, improved, or abused it tell us about it at our Google Group.

License and copyright

Congomongo is made available under the terms of an MIT-style license. Please refer to the source code for the full text of this license and for copyright details.