A toolkit for using MongoDB with Clojure.
This library is using an outdated version of the MongoDB Java driver and it will likely take some time before we get around to upgrading it. If you are starting up a new project with MongoDB and Clojure, we would recommend looking at Monger which is well-maintained and extremely well-documented!
Latest stable release is 0.5.3.
Leiningen dependency information:
[congomongo "0.5.3"]
congomongo {:mvn/version "0.5.3"}
Maven dependency information:
<dependency>
<groupId>congomongo</groupId>
<artifactId>congomongo</artifactId>
<version>0.5.3</version>
</dependency>
Gradle dependency information:
compile 'congomongo:congomongo:0.5.3'
(ns my-mongo-app
(:require [somnium.congomongo :as m]))
(def conn
(m/make-connection "mydb"
:host "127.0.0.1"
:port 27017))
=> #'user/conn
conn => {:mongo #<MongoClient Mongo: /127.0.0.1:20717>, :db #<DBApiLayer mydb>}
(m/set-connection! conn)
(m/with-mongo conn
(m/insert! :robots {:name "robby"}))
(m/close-connection conn)
(m/set-write-concern conn :journaled)
These are the new, official write concerns as of release 0.4.0, using the 2.10 Java driver. The earlier write concerns are shown in parentheses and are deprecated as of the 0.4.0 release.
You can pass a simple read preference (without tags) to each function accepting read preferences. This may look like:
(m/fetch :fruit :read-preference :nearest)
to get the fruit from the nearest server. You may create more advances read preferences using the read-preference
function.
(let [p (m/read-preference :nearest {:location "Europe"})]
(fetch :fruit :read-preference p)
)
to be more specific to get the nearest fruit. You may also set a default ReadPreference
on a per collection or connection basis using set-read-preference
or set-collection-read-preference!
.
(m/set-read-preference conn :primary-preferred)
(m/set-collection-read-preference! :news :secondary)
(m/insert! :robots
{:name "robby"})
(def my-robot (m/fetch-one :robots)) => #'user/my-robot
my-robot => {:name "robby",
:_id #<ObjectId> "0c23396f7e53e34a4c8cf400">}
(m/update! :robots my-robot (merge my-robot {:name "asimo"}))
=> #<WriteResult { "serverUsed" : "/127.0.0.1:27017" ,
"updatedExisting" : true ,
"n" : 1 ,
"connectionId" : 169 ,
"err" : null ,
"ok" : 1.0}>
(m/destroy! :robots {:name "asimo"}) => #<WriteResult { "serverUsed" : "/127.0.0.1:27017" ,
"n" : 1 ,
"connectionId" : 170 ,
"err" : null ,
"ok" : 1.0}>
(m/fetch :robots) => ()
(dorun (m/mass-insert!
:points
(for [x (range 100) y (range 100)]
{:x x
:y y
:z (* x y)}))
=> nil ;; without dorun this would produce a WriteResult with 10,000 maps in it!
(m/fetch-count :points)
=> 10000
(m/fetch-one
:points
:where {:x {:$gt 10
:$lt 20}
:y 42
:z {:$gt 500}})
=> {:x 12, :y 42, :z 504, :_id ... }
(m/aggregate
:expenses
{:$match {:type "airfare"}}
{:$project {:department 1, :amount 1}}
{:$group {:_id "$department", :average {:$avg "$amount"}}})
=> {:serverUsed "...", :result [{:_id ... :average ...} {:_id ... :average ...} ...], :ok 1.0}
This pipeline of operations selects expenses with type = 'airfare', passes just the department and amount fields thru, and groups by department with an average for each.
Based on 10gen's Java Driver example of aggregation.
The aggregate function accepts any number of pipeline operations.
(m/authenticate conn "myusername" "my password")
=> true
(m/make-connection :mydb :host "127.0.0.1" (m/mongo-options :auto-connect-retry true))
The available options are hyphen-separated lowercase keyword versions of the camelCase options supported by the Java driver. Prior to CongoMongo 0.4.0, the options matched the fields in the MongoOptions class. As of CongoMongo 0.4.0, the options match the method names in the MongoClientOptions class instead (and an IllegalArgumentException will be thrown if you use an illegal option). The full list (with the 2.10.1 Java driver) is:
(:auto-connect-retry :connect-timeout :connections-per-host :cursor-finalizer-enabled
:db-decoder-factory :db-encoder-factory :description :legacy-defaults
:max-auto-connect-retry-time :max-wait-time :read-preference :socket-factory
:socket-keep-alive :socket-timeout :threads-allowed-to-block-for-connection-multiplier
:write-concern)
(m/make-connection "mongodb://user:pass@host:27071/databasename")
;; note that authentication is handled when given a user:pass@ section
A query string may also be specified containing the options supported by the MongoClientURI class (as of CongoMongo 0.4.0; previously the MongoURI class was used).
(m/fetch-one :points
:as :json)
=> "{ \"_id\" : \"0c23396ffe79e34a508cf400\" ,
\"x\" : 0 , \"y\" : 0 , \"z\" : 0 }"
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)))
Use :explain? on fetch to get performance information about a query. Returns a map of statistics about the query, not rows:
(m/fetch :users :where {:login "alice"} :explain? true)
{:nscannedObjects 2281,
:nYields 0,
:nscanned 2281,
:millis 2,
:isMultiKey false,
:cursor "BasicCursor",
:n 1,
:indexOnly false,
:allPlans [{:cursor "BasicCursor", :indexBounds {}}],
:nChunkSkips 0,
:indexBounds {},
:oldPlan {:cursor "BasicCursor", :indexBounds {}}}
Version 0.5.3 - Aug 30, 2018
:partial-filter-expression
to add-index!
in order to support partial indexes.Version 0.5.2 - May 2, 2018
Version 0.5.1 - Jan 19, 2018
_id
when creating GridFS filesVersion 0.5.0 - Jun 6, 2016
Version 0.4.8 - Feb 25, 2016
update
test to update-one
to avoid Clojure update
name conflictVersion 0.4.7 - Dec 27, 2015
Version 0.4.6 - Jul 29, 2015
Version 0.4.5 - Jul 18, 2015
Version 0.4.4 - April 29, 2014
Version 0.4.3 - April 8, 2014
:write-concern
on mass-insert!
Version 0.4.2 - February 25, 2014
Version 0.4.1 - March 14, 2013
Version 0.4.0 - January 4, 2013
BREAKING CHANGES IN THIS RELEASE!
10gen have updated all their drivers to be more consistent in naming. They have also changed the default write concern (from :none to :normal, effectively). The new classes introduced have different APIs to the classes they replace so there are some knock on changes to CongoMongo as well. The biggest changes are that opt! has been removed and the actual keyword arguments for MongoOptions have changed to match MongoClientOptions$Builder instead. An IllegalArgumentException is thrown for unknown arguments now.
Version 0.3.3 - November 2nd, 2012
Version 0.3.2 - October 30th, 2012
Version 0.3.1 - October 23rd, 2012
Version 0.3.0 - October 23rd, 2012
Version 0.2.3 - October 30th, 2012 - last release to support Clojure 1.2.x!
Version 0.2.2 - October 23rd, 2012
Version 0.2.1 - October 23rd, 2012
Version 0.2.0 - October 10th, 2012:
Version 0.1.10 - July 31st, 2012:
Version 0.1.9 - April 20th, 2012:
Version 0.1.8:
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 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.
Can you improve this documentation?Edit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close