Index of Public Functions and Variables in karras

This page has an alphabetical index of all the documented functions and variables in karras.
Shortcuts:
A B C D E F G H I J K L M
N O P Q R S T U V W X Y Z
Other

A

 add-reference                function      karras.entity      Add one more :_id's to a sequence of the given key.
 all                          function      karras.sugar       .
 array-type                   var           karras.sugar       .
 asc                          function      karras.sugar       Sugar for order by and index..

B

 binary-type                  var           karras.sugar       .
 boolean-type                 var           karras.sugar       .
 build-dbo                    function      karras.core        Build a DBObject where the key-values order is pre...

C

 collection                   function      karras.collection  Returns a DBCollection..
 collection-db                function      karras.collection  Get the DB that this collection is associated with...
 collection-db-name           function      karras.collection  Get the name of the DB that this collection is ass...
 collection-for               function      karras.entity      Returns the DBCollection for the supplied entity i...
 collection-name              function      karras.collection  Get the name of the collection..
 compound-index               function      karras.sugar       Sugar to create compound index.
 connect                      function      karras.core        Returns a single server connection. Defaults to ho...
 convert                      multimethod   karras.entity      Multimethod used to convert a entity. Takes in a f...
 count-docs                   function      karras.collection  Returns the count of documents, optionally, matchi...
 count-instances              function      karras.entity      Return the number of entities optionally matching ...
 create                       function      karras.entity      Makes a new instance of type and saves it..

D

 date                         function      karras.sugar       A convenience constructor for making a java.util.D...
 date-type                    var           karras.sugar       .
 defembedded                  macro         karras.entity      Defines a type that can be embedded into an entity...
 defentity                    macro         karras.entity      Defines an entity that corresponds to a collection...
 deffetch                     macro         karras.entity      Defines a fetch function for the given type.  The ...
 deffetch-one                 macro         karras.entity      Defines a fetch-one function for the given type.  ...
 delete                       function      karras.collection  Removes documents matching the supplied queries fr...
 delete                       function      karras.entity      Deletes one or more entities..
 delete-all                   function      karras.entity      Deletes all entitys given an optional where clause...
 desc                         function      karras.sugar       Sugar for order by and index..
 distinct-values              function      karras.collection  Fetch a seq of the distinct values of a given coll...
 distinct-values              function      karras.entity      Return the distinct values of a given type for a g...
 double-type                  var           karras.sugar       .
 drop-collection              function      karras.collection  .
 drop-db                      function      karras.core        .
 drop-index                   function      karras.collection  .
 drop-index-named             function      karras.collection  .

E

 element-match                function      karras.sugar       .
 ensure-index                 function      karras.collection  Ensure an index exist on a collection..
 ensure-indexes               function      karras.entity      Ensure the indexes are built, optionally for a giv...
 ensure-named-index           function      karras.collection  Ensure an index exist on a collection with the giv...
 ensure-type                  function      karras.entity      Force an entity to be of a given type if is not al...
 ensure-unique-index          function      karras.collection  Ensure a unique index exist on a collection..
 entity-spec                  function      karras.entity      Lookup the EntitySpec for a given type.
 entity-spec-assoc            function      karras.entity      Associate the suppled keys and values with the ent...
 entity-spec-get              function      karras.entity      Lookup the EntitySpec value for given key of the g...
 entity-spec-get-in           function      karras.entity      Lookup the EntitySpec value for given key of the g...
 entity-spec-of               function      karras.entity      Given a type and one or more keys, lookup of the e...
 entity-spec-of-item          function      karras.entity      Given a type and one or more keys, lookup of the e...
 eq                           function      karras.sugar       .
 eq-mod                       function      karras.sugar       .
 exist?                       function      karras.sugar       .

F

 fetch                        function      karras.collection  Fetch a seq of documents that match a given criter...
 fetch                        function      karras.entity      Fetch a seq of entities for the given type matchin...
 fetch-all                    function      karras.collection  Fetch all the documents of a collection. Same opti...
 fetch-all                    function      karras.entity      Fetch all of the entities for the given type..
 fetch-by-id                  function      karras.collection  Fetch a document by :_id.
 fetch-by-id                  function      karras.entity      Fetch an enity by :_id.
 fetch-map-reduce-values      function      karras.collection  Takes the result of map-reduce and fetches the val...
 fetch-map-reduce-values      function      karras.entity      Takes the result of map-reduce and fetches the val...
 fetch-one                    function      karras.collection  Fetch one document of a collection. Supports same ...
 fetch-one                    function      karras.entity      Fetch the first entity for the given type matching...
 fetch-refers-to              function      karras.entity      Given an entity, a type and a field, fetch all the...
 field-spec-of                function      karras.entity      Given a type and one or more keys, returns the  fi...
 find-and-modify              function      karras.collection  See http://www.mongodb.org/display/DOCS/findandmod...
 find-and-modify              function      karras.entity      See http://www.mongodb.org/display/DOCS/findandmod...
 find-and-remove              function      karras.collection  See http://www.mongodb.org/display/DOCS/findandmod...
 find-and-remove              function      karras.entity      See http://www.mongodb.org/display/DOCS/findandmod...

G

 get-reference                function      karras.entity      Fetch the entity or entities referrenced by the gi...
 grab                         function      karras.entity      Analogous to clojure.core/get except that it will ...
 grab-in                      function      karras.entity      Analogous to clojure.core/get-in except that it wi...
 group                        function      karras.collection  Fetch a seq of grouped items. Example: SQL: sele...
 group                        function      karras.entity      Fetch a seq of grouped items. Example: SQL: sele...
 gt                           function      karras.sugar       .
 gte                          function      karras.sugar       .

H


I

 in                           function      karras.sugar       .
 in-request                   macro         karras.core        Macro to wrap the body in a Mongo request. For mor...
 incr                         function      karras.sugar       .
 index                        function      karras.entity      Associate an index with a give type..
 insert                       function      karras.collection  Inserts one or more documents into a collection.  ...
 int32-type                   var           karras.sugar       .
 int64-type                   var           karras.sugar       .
 is-nil?                      function      karras.sugar       .
 is-type                      function      karras.sugar       .

J

 js-code-type                 var           karras.sugar       .
 js-query                     function      karras.sugar       .
 js-scoped-code-type          var           karras.sugar       .

K


L

 list-collections             function      karras.core        .
 list-indexes                 function      karras.collection  .
 list-indexes                 function      karras.entity      .
 lt                           function      karras.sugar       .
 lte                          function      karras.sugar       .

M

 *mongo-db*                   var           karras.core        Var to bind a com.mongo.DB. Use with with-mongo or...
 make                         function      karras.entity      Converts a hashmap to the supplied type..
 map-reduce                   function      karras.collection  See http://www.mongodb.org/display/DOCS/MapReduce.
 map-reduce                   function      karras.entity      See http://www.mongodb.org/display/DOCS/MapReduce.
 map-reduce-fetch-all         var           karras.collection  Composes map-reduce and fetch-map-reduce-values an...
 map-reduce-fetch-all         var           karras.entity      Composes map-reduce and fetch-map-reduce-values an...
 max-key-type                 var           karras.sugar       .
 min-key-type                 var           karras.sugar       .
 modify                       function      karras.sugar       Sugar to create update documents (modify (incr :...
 mongo-db                     function      karras.core        Returns a com.mongo.DB object. Defaults to host 12...
 MongoMappable                var           karras.core        (to-dbo [d]) (to-clj [d]) Implementations provided...

N

 ne                           function      karras.sugar       .
 negate                       function      karras.sugar       .
 not-exist?                   function      karras.sugar       .
 not-in                       function      karras.sugar       .
 null-type                    var           karras.sugar       .

O

 object-id-type               var           karras.sugar       .
 object-type                  var           karras.sugar       .

P

 pop-first                    function      karras.sugar       .
 pop-last                     function      karras.sugar       .
 pull                         function      karras.sugar       .
 pull-all                     function      karras.sugar       .
 push                         function      karras.sugar       .

Q


R

 regex-type                   var           karras.sugar       .
 relate                       function      karras.entity      Relates an entity to another entity as a reference...

S

 save                         function      karras.collection  Saves a document to a colection, does an upsert be...
 save                         function      karras.entity      Inserts or updates one or more entities..
 set-fields                   function      karras.sugar       .
 set-reference                function      karras.entity      Set an :_id to the key of the given entity.
 size                         function      karras.sugar       .
 slice                        function      karras.sugar       .
 string-type                  var           karras.sugar       .
 swap-entity-spec-in!         function      karras.entity      Combines swap! and assoc-in to modify the attribut...
 symbol-type                  var           karras.sugar       .

T

 timestamp-type               var           karras.sugar       .

U

 unset                        function      karras.sugar       .
 update                       function      karras.collection  Updates one or more documents in a collection that...
 update                       function      karras.entity      Updates one or more documents in a collection that...
 update-all                   function      karras.collection  Shortcut for (update collection criteria obj :mult...
 update-all                   function      karras.entity      Shortcut for (update type criteria obj :multi).
 upsert                       function      karras.collection  Shortcut for (update collection criteria obj :upse...

V


W

 where                        function      karras.sugar       Sugar to create a where document. Example: (wher...
 with-mongo                   macro         karras.core        Macro to bind *mongo-db*.
 with-mongo-request           macro         karras.core        Macro to bind *mongo-db* and wraps the body in a M...
 within                       function      karras.sugar       .
 within-dates                 function      karras.sugar       .
 write-concern-none           function      karras.core        From the mongo driver javadocs:  Don't check for o...
 write-concern-normal         function      karras.core        From the mongo driver javadocs: Use the default le...
 write-concern-strict         function      karras.core        From the mongo driver javadocs: Send a getLastErro...

X


Y


Z


Other

 ||                           function      karras.sugar       or.
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.