added documention generator; db.eval ..

README.md

@@ -143,192 +143,7 @@ Check the status of the server.
 
 ## Commands
 
-### Creating and maintaining documents. 
-
-`(defclass document()`
-
-Document class. 
-A document consists of key/value pairs stored in a hash table.
-Each document has a unique id.   
-Accessors : 
-
-* elements  : returns the hash table.
-* _id       : returns the unique id.
-* _local_id : true id the document is locally generated.
-
-`(defun make-document ( &key (oid nil) )`
-
-Constructor.
-
-* :oid key : User supplied unique id. 
-
-`(defgeneric add-element ( key value document)`
-
-Add an element with key and value to the document.
-
-`(defgeneric get-element ( key document)`
-
-Get an element with key from the document.
-
-`(defgeneric rm-element (key document)`
-
-Remove anelement with key from the document.
-
-`(defun ht->document (ht)`
-
-Convert a hash-table to a document.
-
-`(defgeneric kv (a b &rest rest) )`
-
-This is intended to be a helper function for key-value pairs and sets of key-value pairs.  
-
-pair  -> (string value)  
-value -> atom | cons  
-kv    -> pair | list  
-list  -> (elem list) | nil  
-
-
-### Connection managment
-`(defclass mongo ()`
-
-Encapsulates the connection to the mongo database.
-Each connection is a added to a global list of connections.
-
-`(defgeneric db.use ( db &key )`
-
-Use a database on the mongo server. Opens a connection if one isn't already 
-established. (db.use -) can be used to go to a previosuly visited database, 
-similar to cd -.
-
-`(defun close-all-connections ()`
-
-Close all connections in the global connection list.
-
-`(defun cwd ( &key (mongo nil) )`
-
-Show the current database.
-
-`(defun nwd ()`
-
-Show the database set by the `(db.use -)` command
-
-### Helper Functions
-
-`(defgeneric pp (result &key)`
-
-Pretty-print the results returned from a query.
-
-`(defun nd (result &key (stream t) )`
-
-Pretty-print for non-document responses, like the response to a database command.
-
-`(defun iter ( result &key (mongo nil) (max-per-call 0) )`
-
-Exhaustively iterate through a query. The maximum number of responses 
-per query can be specified using the max-per-call keyword.
-
-`(defun rm (result &key (mongo nil) )`
-
-Delete all the documents returned by a query. This is not an efficient 
-way of deleting documents as it invloves multiple trips to the server.
-Mongo allows for execution of java-script on the server side, but support for
-this hasn't been added to cl-mongo *yet*.
-
-`(defun docs ( result )`  
-
-Stop iteration and return the list of documents returned by the query.
-
-`(defun now()`  
-Return the current date and time in bson format.  
-
-`(defmethod db.collections (&key (mongo nil) )`  
-
-Show all the collections in the current database.
-
-`(defgeneric db.count ( collection selector &key )`  
-
-Count the number of documents satifying the selector. 'all can be used to return a count of
-all the documents in the collection.
-
-### CRUD Operations
-
-`(defgeneric db.insert ( collection document &key )`
-
-Insert a document in the collection. The collection is specified by a string.  
-The document can be one of :
-
-* document class as generated by `(make-document)`
-* hash table
-* a single kv (key-value pair) or a kv list.
-
-
-`(defgeneric db.find (collection  kv &key)`
-
-Find documents in the collection using the selector specified by kv.  
-Keywords :
-
-* :limit : Max number of documents returned in this query. The default is 1.
-* :skip  : Number of documents to skip in this query.
-
-The default value of the limit is one, so db.find by default is the equivalant of *findOne* in the
-mongo documentation.
-
-`(defgeneric db.update ( collection selector new-document &key )`
-
-In a collection update the document(s) identified by the selector statement.  
-This method has the following keywords :
-
-* :upsert : If t insert the document if the document cannot be found in the collection.
-* :multi  : Update all documents identified by the selector.
-
-`(defgeneric db.save ( collection document &key)`
-
-Save a document to the collection. If the document has a unique "_id" value (i.e. if it's generated
-by `(make-document)` ) it will be *upserted*.  
-If it's a hash table or a kv set, it will be inserted.  
-In other words this a a helper-function build around *db.insert* and *db.update*.
-
-`(defgeneric db.delete ( collection object &key )`
-
-Delete a document from a collection. The *document* field is used to identify the document to
-be deleted.  
-You can enter a list of documents. In that the server will be contacted to delete each one of these.
-It may be more efficient to run a delete script on he server side.
-
-`(defun date-time (second minute hour day month year &optional (time-zone *bt-time-zone*) )`  
-
-Generate a time stamp the mongo/bson protocol understands.
-
-`(defun time-zone ()`  
-Set the time zone appropriate for the current environment.
-
-### Iteration Support
-
-`(defun db.iterator ( result )`  
-Returns the iterator from the result set.
-
-`(defgeneric db.next ( collection cursor-id &key )`  
-Executes the next call on the iterator identified by cursor-id.
-
-`(defgeneric db.stop ( cursor &key mongo )`  
-Stop iterating and clean up the iterator on the server by making a server call.
-
-### Index Support
-
-`(defgeneric db.ensure-index (collection keys &key)`  
-
-Create an index for a collection.
-
-`(defmethod db.indexes (&key (mongo nil) )`  
-
-Return all indexes in the database.
-
-### Database Commands
-
-`(defgeneric db.run-command ( cmd &key )`  
-
-Run a database command on the server. See the mongo documentation for a list of commands.  
-For most commands you can just uses the key-value shown in the mongo documentation.
+More documentation can be found [here](http://www.mohegan-skunkworks.com) and [here](
 
 ## What's missing
 
@@ -337,7 +152,7 @@ At least the following is missing :
 * Request id/ Response id are left 0 in the header.
 * Serialization of binary data.
 * Serialization of regular expressions.
-* Serialization of code with and without scope (i.e support for server-side code execution) .
+* Serialization of code scope.
 * Advanced queries like min/max queries, group by, snapshot support.
 * Aggregation except for distinct and group by.
 * Authentication

cl-mongo.asd

@@ -12,6 +12,7 @@
   :description "lisp system to interact with mongo, a non-sql db"
   :depends-on (:uuid
 	       :babel
+	       :documentation-template
 	       :usocket)
   :serial t
   :components 
@@ -22,13 +23,15 @@
 		 (:file "encode-float")
 		 (:file "bson-oid")
 		 (:file "bson-time")
+		 (:file "bson-code")
 		 (:file "pair")
 		 (:file "bson")
 		 (:file "bson-array")
 		 (:file "document")
 		 (:file "protocol")
 		 (:file "mongo")
 		 (:file "db")
+		 (:file "doc") 
 		 (:file "shell")))
    (:static-file "README.md")
    (:static-file "COPYING")))