com.timezynk.mongo — com.timezynk/mongo 0.5.8

aggregate clj

(aggregate collection pipeline)

MongoDB aggregation.

parameter	description
collection	keyword/string Collection name.
pipeline	list {keyword/string {}}

(aggregate :users
           [{:$match {:age {:$gte 20}}}
            {:$project {:_id 0
                        :name 1}}])

create-collection! clj

(create-collection! name)

create-index! clj

(create-index! coll keys & options)

Create an index for a collection. coll - keyword/string: Collection name. keys - map/list(keyword/string): A document or a list of keywords or strings. Optional parameters: background - boolean: Create the index in the background. name - string: A custom name for the index. partial-filter-expression - map: A filter expression for the index. sparse - boolean: Allow null values. unique - boolean: Index values must be unique.

delete! clj

(delete! coll query & options)

Delete matching documents. coll - keyword/string: The collection. query - map: A standard MongoDB query. Optional parameters: None yet.

delete-one! clj

(delete-one! coll query & options)

Delete first matching document. coll - keyword/string: The collection. query - map: A standard MongoDB query. Optional parameters: None yet.

drop-collection! clj

(drop-collection! coll)

drop-index! clj

(drop-index! coll index)

fetch clj

(fetch collection)

(fetch collection query & :limit n :only {} :skip n :sort {})

Fetch documents from collection.

parameter	description
collection	keyword/string The collection.
query	{keyword/string object} A standard MongoDB query.
:limit	optional int Number of documents to fetch.
:only	optional {keyword/string object} A MongoDB map of fields to include or exclude.
:skip	optional int Number of documents to skip before fetching.
:sort	optional {keyword/string object} A MongoDB map of sorting criteria.

; Fetch five documents from collection :users
(fetch :users {} :limit 5)

fetch-and-delete! clj

(fetch-and-delete! coll query)

fetch-and-replace! clj

(fetch-and-replace! coll query doc & options)

fetch-and-update! clj

(fetch-and-update! coll query update & options)

fetch-count clj

(fetch-count collection)

(fetch-count collection query)

Count the number of documents returned.

parameter	description
collection	keyword/string The collection.
query	{keyword/string object} A standard MongoDB query.

fetch-one clj

(fetch-one collection)

(fetch-one collection query)

Return only the first document retrieved.

parameter	description
collection	keyword/string The collection.
query	{keyword/string object} A standard MongoDB query.

get-collections clj

(get-collections)

insert! clj

(insert! collection document)

(insert! collection document-list)

Insert one document or a list thereof in a collection. Inserting a list is atomic.

parameter	description
collection	keyword/string The collection.
document/s	map/list(map) A document or a list of documents.

(insert! :users {:name "Alice"})

(insert! :users [{:name "Alice"}
                 {:name "Bob"}])

list-indexes clj

(list-indexes coll)

replace-one! clj

(replace-one! coll query doc & options)

Replace a single document. coll - keyword/string: The collection. query - map: A standard MongoDB query. doc - map: The new document. Optional parameters: upsert? - boolean: If no document is found, create a new one. Default is don't create.

set-connection! clj

(set-connection! uri)

Procedurally set up or change mongodb connection.

uri - string: database location.

set-database! clj

(set-database! db)

Procedurally set up or change database.

db - string: name of database to use.

transaction clj macro

(transaction & body)

Functionally perform a transaction. Encapsulated database requests are queued and then atomically executed when the function goes out of scope.

(transaction
 (insert! :users {:name "My Name"})
 (fetch! :users))

update! clj

(update! collection query update & :upsert? b)

Update matching documents.

Parameters

collection : keyword/string The collection.

query : {keyword/string object} A standard MongoDB query.

update : {keyword/string object} A valid update document. Must use $set or $push, throws exception otherwise.

:upsert? : optional boolean If no document is found, create a new one. Default is false.

Returns

{:matched-count <number of matching documents>
 :modified-count <number of modified documents>}

Examples

(update!)

update-one! clj

(update-one! collection query update & :upsert? b)

Update first matching document.

parameter	description
collection	keyword/string The collection.
query	{keyword/string object} A standard MongoDB query.
update	{keyword/string object} A valid update document. Must use $set or $push.
:upsert?	optional boolean If no document is found, create a new one. Default is false.

with-db clj macro

(with-db db & body)

Functionally set up or change database. Reverts to earlier settings when leaving scope.

parameter	description
db	string Name of database to use.
body	Encapsulated program calling the database.

(with-db "my-database-2"
  (insert! :users {:name "My Name"})
  (fetch! :users))

with-mongo clj macro

(with-mongo uri db & body)

Functionally set up or change mongodb connection. Reverts to earlier settings when leaving scope.

parameter	description
uri	string database location.
db	string database to use.
body	encapsulated program utilizing the connection.

(with-mongo "mongodb://localhost:27017" "my-database"
  (insert! :users {:name "My Name"})
  (fetch! :users))