com.timezynk.mongo — com.timezynk/mongo 0.5.4

aggregate clj

(aggregate coll pipeline)

MongoDB aggregation. coll - keyword/string: Collection name. pipeline - list(map): A list containing the request pipeline documents.

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 | map A standard MongoDB query. | | :limit | optional int Number of documents to fetch. | | :only | optional map A MongoDB map of fields to include or exclude. | | :skip | optional int Number of documents to skip before fetching. | | :sort | optional map A MongoDB map of sorting criteria. |

Fetch five documents from collection :user:

(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 coll)

(fetch-count coll query)

Count the number of documents returned. coll - keyword/string: The collection. query - map: A standard MongoDB query.

fetch-one clj

(fetch-one coll)

(fetch-one coll query)

Return only the first document retrieved. coll - keyword/string: The collection. query - map: A standard MongoDB query.

get-collections clj

(get-collections)

insert! clj

(insert! coll doc)

Add one document or a list thereof to a collection. coll - keyword/string: The collection. doc - map/list(map): A document or a list of documents.

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.

update! clj

(update! coll query update & options)

Update matching documents. coll - keyword/string: The collection. query - map: A standard MongoDB query. update - map: A valid update document. Must use $set or $push. options - Optional parameters: upsert? - boolean: If no document is found, create a new one. Default is don't create.

update-one! clj

(update-one! coll query update & options)

Update first matching document. coll - keyword/string: The collection. query - map: A standard MongoDB query. update - map: A valid update document. Must use $set or $push. options - Optional parameters: upsert? - boolean: If no document is found, create a new one. Default is don't create.

with-db clj macro

(with-db db & body)

Functionally set up or change database. Reverts to earlier settings when leaving scope. db - string: name of database to use. body - encapsulated program calling the database.

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))