The current download link for clouchdb can be found at
@@ -135,10 +155,10 @@
Invoke specified view in identified view document.
+
+ Keyword parameters
+
+ -
+ key A value to match against the document property or
+ properties mapped in the view. Only documents matching this
+ value are returned.
+
+ -
+ start-key Return documents with mapped keys greater than or
+ equal to this value.
+
+ -
+ start-key-docid The document ID of the first document to return.
+
+ -
+ end-key Return documents with mapped keys less than this
+ value.
+
+ -
+ count The maximum number of rows to return. If zero, returns
+ only result meta-data.
+
+ -
+ update If nil, CouchDb does not refresh view data when
+ executing the query. This is a performance option that may
+ result is faster queries but potentially not return up-to-date
+ data.
+
+ -
+ descending If true, return results in reverse order.
+
+ -
+ skip Number of result rows to skip.
+
+
+
+
Example:
From peddy at common-lisp.net Sun Dec 9 16:03:21 2007
From: peddy at common-lisp.net (peddy)
Date: Sun, 9 Dec 2007 11:03:21 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071209160321.BE4D328067@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv2019/src
Modified Files:
changelog.txt clouchdb.lisp examples.lisp tests.lisp
Log Message:
- Fixed ad-hoc-view and invoke-view functions so that they now use
all CouchDb view options
- Added generic keyword parameter to URL parameter translation code
- Changed default CouchDb port to IANA assigned 5984
- Added more comments
--- /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/01 14:19:59 1.1.1.1
+++ /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/09 16:03:21 1.2
@@ -1,4 +1,12 @@
+0.0.4:
+
+ - Fixed ad-hoc-view and invoke-view functions so that they now use
+ all CouchDb view options
+ - Added generic keyword parameter to URL parameter translation code
+ - Changed default CouchDb port to IANA assigned 5984
+ - Added more comments
+
0.0.3:
- Changed 'scheme' parameter of set-connection to 'protocol'
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/08 15:16:21 1.2
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/09 16:03:21 1.3
@@ -25,7 +25,7 @@
(in-package :clouchdb)
(defvar *host* "localhost" "CouchDb server host name")
-(defvar *port* "8888" "CouchDb port")
+(defvar *port* "5984" "As of version 7.2, the IANA assigned CouchDb port (was 8888)")
(defvar *db-name* "default" "Default database name")
(defvar *protocol* "http" "http or https")
@@ -38,6 +38,47 @@
(defparameter *temp-db-counter* 0 "Used in the creation of temporary databases")
;;
+;; URL Parameter helpers
+;;
+
+(defun true-if-true (value)
+ "Return \"true\" if value is non-nil, otherwise nil"
+ (when value "true"))
+
+(defun false-if-false (value)
+ "Return \"false\" if value is nil, otherwise nil"
+ (unless value "false"))
+
+(defvar *view-options*
+ '((:key . ((:name . "key") (:fn . doublequote)))
+ (:start-key . ((:name . "startkey") (:fn . doublequote)))
+ (:start-key-docid . ((:name . "startkey_docid") (:fn . doublequote)))
+ (:end-key . ((:name . "endkey") (:fn . doublequote)))
+ (:count . ((:name . "count") (:fn . value-as-string)))
+ (:update . ((:name . "update") (:fn . false-if-false)))
+ (:descending . ((:name . "descending") (:fn . true-if-true)))
+ (:skip . ((:name . "skip") (:fn . value-as-integer))))
+ "Definitions for how invoke-view keyword parameters are translated
+ into CouchDb parameters")
+
+(defun transform-param (param value table)
+ "Use a keyword transformation table to traslate between function
+ keyword parameter names and values, and URL parameter names and
+ values."
+ (let ((transf (cdr (assoc param table))))
+ (when transf
+ (let ((value (funcall (cdr (assoc :fn transf)) value)))
+ (when value
+ (cons (cdr (assoc :name transf)) value))))))
+
+(defun transform-params (keyword-params options)
+ "Transform each keyword parameter using the specified set of
+options, use only those transformations that return a non-nil result."
+ (loop for param on keyword-params by #'cddr
+ when (transform-param (first param) (second param) options)
+ collect it))
+
+;;
;; Conditions
;;
@@ -92,6 +133,12 @@
((stringp value)
value)))
+(defun value-as-integer (value)
+ (cond ((numberp value)
+ value)
+ ((stringp value)
+ (parse-integer value))))
+
(defun string-join (list &optional (delim #\,))
"Join a bunch of strings into one with a delimiter. Implementation
by Russel McManus on c.l.l."
@@ -123,15 +170,6 @@
convert :db-name to *db-name*"
(intern (cat "*" (string-upcase (symbol-name key)) "*")))
-(defun make-lets (args)
- "Convert a list of keyword/value pairs to a form suitable for the
-innerds of a let. For example, convert '(:db-name (fn1 x x) :host
-'host') to ((*db-name* (fn1 x x) (*host* 'host'))"
- (if (null args)
- nil
- (cons (list (keyword-to-special (first args)) (second args))
- (make-lets (cddr args)))))
-
(defmacro ensure-db ((&key (db-name nil db-name-p)) &body body)
"Warp request in code to check for errors due to non-existant data
bases. Since in a document operation, CouchDb does not distinguish
@@ -192,10 +230,12 @@
(defun db-request (uri &rest keys &key &allow-other-keys)
"Used by all Couchdb APIs to make the actual REST request."
- ;;(format t "uri: ~S~% keys: ~S~%" (make-uri uri) keys)
+;; (format t "uri: ~S~% keys: ~S~%" (make-uri uri) keys)
(let ((*text-content-types* *text-types*))
(multiple-value-bind (body status headers uri stream must-close reason-phrase)
(apply #'drakma:http-request (make-uri uri) keys)
+;; (format t " -> uri: ~S~%" uri)
+;; (format t " -> headers: ~S~%" headers)
(if must-close
(json:decode-json-from-string body)
nil))))
@@ -206,7 +246,9 @@
(defun set-connection (&key (host nil host-p) (db-name nil db-name-p)
(protocol nil protocol-p) (port nil port-p))
- "Set top-level connection information."
+ "Set top-level connection information. The port may be specified as
+a string or number. As of CouchDb version 7.2 the default port is
+5984, prior to that it was 8888."
(when host-p (setf *host* host))
(when db-name-p (setf *db-name* db-name))
(when port-p (setf *port* (value-as-string port)))
@@ -216,9 +258,12 @@
(defmacro with-connection ((&rest args &key db-name port protocol host)
&body body)
"Execute body in the context of the optionally specified host,
-db-name, port or protocol."
+db-name, port or protocol. Port may be a string or a number, protocol
+is http or https. As of CouchDb version 7.2 the default port is 5984,
+prior to that it was 8888."
(declare (ignore db-name port protocol host))
- `(let (,@(make-lets args))
+ `(let (,@(loop for var on args
+ by #'cddr collect (list (keyword-to-special (car var)) (second var))))
, at body))
(defun document-properties (document)
@@ -362,8 +407,9 @@
;; If an ID was specified and that ID does not match the
;; :_id property of the current document, strip the document
;; of all special (CouchDb managed) properties, since these
- ;; are specific to the current document. This will create a
- ;; new document with the same contents as the old one.
+ ;; are specific to the current document. In this case, the
+ ;; presence of the ID parameter means 'create a new document
+ ;; with the same contents as the old one'.
((and id current-id (not (equal current-id id)))
(setf doc (document-properties doc))))
(let ((res (ensure-db ()
@@ -426,12 +472,14 @@
;; Views API
;;
-(defun ad-hoc-view (view)
+(defun ad-hoc-view (view &rest options &key key start-key start-key-docid
+ end-key count update descending skip)
"Execute query using an ad-hoc view."
(ensure-db ()
(db-request (cat *db-name* "/_temp_view")
:method :post
:content-type "text/javascript"
+ :parameters (transform-params options *view-options*)
:content view)))
(defun create-view (id &rest view-defs)
@@ -456,10 +504,18 @@
(ensure-db ()
(delete-document :id (cat "_design/" id) :revision revision)))
-(defun invoke-view (id view &key (key nil))
+(defun invoke-view (id view &rest options &key key start-key start-key-docid
+ end-key count update descending skip)
"Invoke a view by specifiying the document ID that contains the view
-and the name of the contained view."
+and the name of the contained view. The key parameter specifies an
+optional value to match against the view's mapped field. The start-key
+and end-key values specify the optional begin and end range of the
+mapped field(s) of each document to return. If descending is t,
+returns results in reverse order. If update is t, does not refresh
+view for query, use for higher performance but possible data
+inconsistency."
+ (declare (ignore key start-key start-key-docid end-key count update descending skip))
(ensure-db ()
(db-request (cat *db-name* "/_view/" id "/" view)
:method :get
- :parameters (if key `(("key" . ,(doublequote key)))))))
+ :parameters (transform-params options *view-options*))))
--- /project/clouchdb/cvsroot/clouchdb/src/examples.lisp 2007/12/01 14:19:59 1.1.1.1
+++ /project/clouchdb/cvsroot/clouchdb/src/examples.lisp 2007/12/09 16:03:21 1.2
@@ -33,7 +33,11 @@
;; represent the defaults.
;(defparameter *host* "localhost")
+
+;; Port for CouchDb versions prior to 7.2
;(defparameter *port* "8888")
+;; Port CouchDb 7.2 and later
+;(defparameter *port* "5984")
;(defparameter *scheme* "http")
;;
@@ -52,7 +56,7 @@
;; Create a document with ID of "haussmann"
(create-document '(;; Fields with scalar values:
(:name . "Georges-Eugene Haussmann")
- ;; Note: above should be "Georges-Eug??ne", but
+ ;; Note: above should be "Georges-Eug?ne" but
;; there's a character handling bug somewhere
(:aka . "Baron Haussmann")
(:born . "1809-03-27")
--- /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/01 14:19:59 1.1.1.1
+++ /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/09 16:03:21 1.2
@@ -111,7 +111,7 @@
(:dynamic-variables
(*db-name* nil)
(*host* "localhost")
- (*port* "8888")
+ (*port* "5984")
(*protocol* "http")))
;;
@@ -233,6 +233,11 @@
(ensure-condition 'id-missing (put-document '((:a "test")))))
(addtest (clouchdb-doc-api-tests)
+ (:documentation "Get a non-existant document (error)")
+ get-non-existant-document
+ (ensure-condition 'document-missing (get-document "does-not-exist")))
+
+(addtest (clouchdb-doc-api-tests)
(:documentation "Test revision info")
get-document-revision-info
(ensure-same 11 (progn
From peddy at common-lisp.net Fri Dec 14 23:22:58 2007
From: peddy at common-lisp.net (peddy)
Date: Fri, 14 Dec 2007 18:22:58 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/public_html
Message-ID: <20071214232258.8D58A4F00E@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/public_html
In directory clnet:/tmp/cvs-serv19826/public_html
Modified Files:
index.html
Log Message:
Fixed document ID encoding bug, documentation now valid XHMTL
--- /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/09 16:03:21 1.2
+++ /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/14 23:22:58 1.3
@@ -41,23 +41,22 @@
-
-
- - Dec 9, 2007 - Version 0.0.4: Updated
- (invoke-view) and
- (ad-hoc-view) to use all options
- supported by corresponding CouchDb API. Somehow I'd missed
- these before.
-
- - Nov 28, 2007 -
- CouchDb 7.2 now uses IANA assigned port 5984 instead of 8888.
- As of release 0.0.4, clouchdb's default has been changed to
- reflect this fact. If you're using pre-7.2 CouchDb versions with
- clouchdb 0.0.4, be sure to set your port to 8888. There should
- be no other compatibility issues.
-
-
-
+
+
+ - Dec 9, 2007 - Version 0.0.4: Updated
+ (invoke-view) and
+ (ad-hoc-view) to use all options
+ supported by corresponding CouchDb API. Somehow I'd missed
+ these before.
+
+ - Nov 28, 2007 -
+ CouchDb 7.2 now uses IANA assigned port 5984 instead of 8888.
+ As of release 0.0.4, clouchdb's default has been changed to
+ reflect this fact. If you're using pre-7.2 CouchDb versions with
+ clouchdb 0.0.4, be sure to set your port to 8888. There should
+ be no other compatibility issues.
+
+
@@ -68,15 +67,14 @@
Requirements:
-
-
-
+
ASDF Install
@@ -101,13 +99,14 @@
The clouchdb distribution comes with a unit test suite which uses
the LIFT testing framework. To run the tests, follow the following steps:
+
(asdf:oos 'asdf:load-op '#:clouchdb-tests)
(in-package :clouchdb-tests)
(run-all-tests)
-
+
Note that if the CouchDb server is not running on the same host you
will have to modify tests.lisp to point it to the appropriate host.
@@ -127,7 +126,18 @@
Be sure to look at examples.lisp to understand what each example is doing.
-
+
+
+CVS Access
+
+
+ Clouchdb project hosting is graciously provided by common-lisp.net,
+ the CVS repository may be checked out anonymously as follows:
+
+
+
+cvs -z3 -d :pserver:anonymous:anonymous at common-lisp.net:/project/clouchdb/cvsroot co clouchdb
+
@@ -135,15 +145,17 @@
The following email lists have been provided
by the common-lisp.net for
clouchdb development and information:
-
+
@@ -162,13 +174,13 @@
Example 1
-The following example session demonstrates:
+The following example session demonstrates:
- - Setting the CouchDb host and database name
-
- Finding CouchDb server version
-
- Creation of a database
-
- Creation of a document in that database
-
- Fetching a document and adding a new field
+
- Setting the CouchDb host and database name
+ - Finding CouchDb server version
+ - Creation of a database
+ - Creation of a document in that database
+ - Fetching a document and adding a new field
@@ -203,14 +215,14 @@
Example 2
-Demonstrating:
+Demonstrating:
- - Recreating a database
-
- Creating a document that uses a CouchDb generated ID
-
- Updating a document value
-
- Viewing document revision information
-
- Fetching an old document revision
-
- Creating a document with array and map field values
+
- Recreating a database
+ - Creating a document that uses a CouchDb generated ID
+ - Updating a document value
+ - Viewing document revision information
+ - Fetching an old document revision
+ - Creating a document with array and map field values
@@ -277,14 +289,14 @@
Example 3
-Demonstrating:
+Demonstrating:
- - Conditionally creating a database if it does not exist
+
- Conditionally creating a database if it does not exist
- The use
of Parenscript in
- defining a view
-
- Invoking persistent views to query database documents
+ defining a view
+ - Invoking persistent views to query database documents
@@ -311,7 +323,7 @@
;; Create a persistent view document to find cities in the
;; Netherlands and also to find cities by country key.
-;; Note: Expressions within the (ps) expressions are Parenscript,
+;; Note: Expressions within the (ps) expressions are Parenscript,
;; a lispy way to generate JavaScript.
CLOUCHDB-USER> (create-view "cities"
(cons "country"
@@ -347,26 +359,34 @@
-API Reference
Server Connection and Database Management API
-The functions described in this section are related to the
+
+ The API described in this has to do with managing CouchDb server
+ information and the creation and deletion of databases.
+
-[Function]
-create-db &key db-name if-exists
+[Function]
+create-db &key db-name if-exists
+
-Create a database. The db-name can be specified, otherwise attempts to
-create the database named in the current context (either through
-(set-connection) or
-(with-connection).
-
- The if-exists parameter defaults to :fail, which will raise an
-error if the database already exists. A value of :ignore will simply
-ignore the this error. A value of :recreate will delete the database
-if it exists, and then recreate it.
+
+ Create a database. The db-name can be specified, otherwise attempts
+ to create the database named in the current context (either through
+ (set-connection) or
+ (with-connection).
+
+
+ The if-exists parameter defaults to :fail, which will raise an error
+ if the database already exists. A value of :ignore will simply
+ ignore the this error. A value of :recreate will delete the database
+ if it exists, and then recreate it.
+
Example:
+
;; Create the database named in the current connection settings
(set-connection :db-name "tvland")
@@ -377,25 +397,29 @@
;; then ignore the request (don't generate error, don't
;; recreate database), return (:ignored . T) if database did
;; exist
-(create-db :db-name "tvland"
+(create-db :db-name "tvland")
=> ((:OK . T) (:IGNORED . T))
-
+
-[Function]
-delete-db &key db-name if-missing
+[Function]
+delete-db &key db-name if-missing
+
+
Delete a database. The db-name can be specified, otherwise attempts to
delete the database named in the current context (either through
(set-connection) or
-(with-connection).
-
-
If :ignore is specified for the if-missing parameter, errors
-resulting from the attempt to delete a non-existent database are ignored.
-
+(with-connection).
+
+
+If :ignore is specified for the if-missing parameter, errors resulting
+from the attempt to delete a non-existent database are ignored.
+
Example:
+
;; Create the database named in the current connection settings
(set-connection :db-name "tvland")
@@ -406,57 +430,66 @@
;; then ignore the request (don't generate error), return
;; ((:ERROR . "not_found") (:REASON . "missing")) if
;; database did not exist
-(delete-db :db-name "tvland"
+(delete-db :db-name "tvland")
=> ((:ERROR . "not_found") (:REASON . "missing"))
-
-
-
-[Function]
-get-db-info &key db-name
+[Function]
+get-db-info &key db-name
+
+
Returns database information for the connection and database in the
current context, or, if the db-name key parameter is specified, for
that database.
-
+
+
Example:
+
(get-db-info)
=> ((:DB_NAME . "test-db") (:DOC_COUNT . 3) (:UPDATE_SEQ . 4))
-
-[Function]
+[Function]
list-dbs
+
-Returns a list of database names available in the current connection.
+
+ Returns a list of database names available in the current connection.
+
-[Function]
-set-connection &key host
+[Function]
+set-connection &key host
db-name protocol port => no value
+
+
Sets the host name, database name, protocol ("http" or "https") and
port number for the top-level connection to the CouchDb
server. Default connection settings are host="localhost",
protocol="http", port="5984" and database="default".
-
-See (with-connection)
+
+ See (with-connection)
-[Macro]
-with-connection (&key host
-db-name protocol port) &body body => value returned by body
+[Macro]
+with-connection (&key host
+db-name protocol port) &body body => value returned by body
+
+
Executes the contained statements in the context of any of the
specified connection values. Sets the host name, database name,
protocol ("http" or "https") or port number of the CouchDb server to
use in the expressions in the body.
-
+
+
Example:
+
;; Get document from specified host and database
(with-connection (:host "cornichon.cucumber.net" :db-name "rfc")
@@ -469,11 +502,9 @@
(get-document "someid"))
:id "copy-of-someid")
-
-See (set-connection)
+See (set-connection)
-
Document API
@@ -488,6 +519,7 @@
Special Properties
+
When a document is created CouchDb assigns special properties to that
@@ -495,7 +527,7 @@
properties include the document's ID (:_id) and the document revision
number (:_rev). All special properties begin with an underscore (_)
symbol.
-
+
(create-document '((:name . "Maxwell Smart") (:agent . 86)) :id "max")
[416 lines skipped]
From peddy at common-lisp.net Fri Dec 14 23:22:58 2007
From: peddy at common-lisp.net (peddy)
Date: Fri, 14 Dec 2007 18:22:58 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071214232258.D727B5E006@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv19826/src
Modified Files:
clouchdb.lisp examples.lisp tests.lisp
Log Message:
Fixed document ID encoding bug, documentation now valid XHMTL
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/09 16:03:21 1.3
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/14 23:22:58 1.4
@@ -161,6 +161,19 @@
"Wrap specified value in double quotes."
(cat "\"" value "\""))
+(defun url-encode (string)
+ "URL-encode a string."
+ (with-output-to-string (s)
+ (loop for c across string
+ do (cond ((or (char<= #\0 c #\9)
+ (char<= #\a c #\z)
+ (char<= #\A c #\Z)
+ (find c "$-_.!*'()," :test #'char=))
+ (write-char c s))
+ ((char= c #\Space)
+ (write-char #\+ s))
+ (t (format s "%~2,'0x" (char-code c)))))))
+
(defun make-uri (&rest rest)
(concatenate 'string *protocol* "://" *host* ":" *port* "/"
(apply #'concatenate 'string rest)))
@@ -222,7 +235,7 @@
(t (cdr (assoc name doc)))))
(defun (setf document-property) (value name doc)
- "Allows setting of document properties in place"
+ "Allows setting of document properties in place."
(cond ((hash-table-p doc)
(setf (gethash name doc) value))
(t (rplacd (assoc name doc) value)))
@@ -290,7 +303,7 @@
error condition is generated. Specify :recreate to potentially delete
and create a new database."
(let* ((name (if db-name-p db-name *db-name*))
- (res (db-request (cat name "/") :method :put)))
+ (res (db-request (cat (url-encode name) "/") :method :put)))
(if (equal "database_already_exists" (document-property :error res))
(ecase if-exists
((:ignore) (list (cons :ok t) (cons :ignored t)))
@@ -311,7 +324,7 @@
error condition, but this can be avoided by specifying :ignore in the
if-missing parameter."
(let* ((name (if db-name-p db-name *db-name*))
- (res (db-request (cat name "/") :method :delete)))
+ (res (db-request (cat (url-encode name) "/") :method :delete)))
(if (and (document-property :error res) (not (eq :ignore if-missing)))
(restart-case
(error 'db-does-not-exist
@@ -324,7 +337,7 @@
"Get information for named database, or couchdb server if no
database specified."
(let ((dbn (if db-name-p db-name *db-name*)))
- (db-request (cat dbn "/") :method :get)))
+ (db-request (cat (url-encode dbn) "/") :method :get)))
(defun create-temp-db-name ()
"Return a database name that's probably unique."
@@ -362,7 +375,7 @@
ascending ID order by default, or descending order of descending
parameter is non-nil."
(ensure-db ()
- (db-request (cat *db-name* "/_all_docs")
+ (db-request (cat (url-encode *db-name*) "/_all_docs")
:method :get
:parameters (if descending
;; ?descending=false causes error ATM
@@ -386,7 +399,7 @@
(push (cons "revs" "true") parameters))
(when revision-info
(push (cons "revs_info" "true") parameters))
- (let ((res (ensure-db () (db-request (cat *db-name* "/" id)
+ (let ((res (ensure-db () (db-request (cat (url-encode *db-name*) "/" (url-encode id))
:method :get
:parameters parameters))))
(if (document-property :error res)
@@ -413,7 +426,9 @@
((and id current-id (not (equal current-id id)))
(setf doc (document-properties doc))))
(let ((res (ensure-db ()
- (db-request (cat *db-name* "/" (if id id current-id))
+ (db-request (cat (url-encode *db-name*) "/" (url-encode (if id id current-id)))
+ :external-format-out :utf-8
+ :content-type "text/json"
:method :put :content (document-to-json doc)))))
(when (document-property :error res)
(error (if (equal "conflict" (document-property :error res))
@@ -422,12 +437,11 @@
:reason (document-property :reason res)))
res)))
-
(defun post-document (doc)
"Create a document and let the server assign an ID. A successful
areturn value includes the new document ID, in the :ID property."
(ensure-db ()
- (db-request (cat *db-name* "/")
+ (db-request (cat (url-encode *db-name*) "/")
:method :post
:content (document-to-json doc))))
@@ -443,7 +457,7 @@
should be a list of documents. Each document in the list may be in the
form of a hash table or an associative list."
(ensure-db ()
- (db-request (cat *db-name* "/_bulk_docs")
+ (db-request (cat (url-encode *db-name*) "/_bulk_docs")
:method :post
:content-type "text/javascript"
:content
@@ -458,7 +472,7 @@
not the revision, the current document will be fetched and it's
revision number will be used for the delete."
(labels ((del (id rev)
- (db-request (cat *db-name* "/" id "?rev=" rev)
+ (db-request (cat (url-encode *db-name*) "/" (url-encode id) "?rev=" rev)
:method :delete)))
(cond ((not (null document))
(delete-document :id (document-property :_id document)
@@ -476,7 +490,7 @@
end-key count update descending skip)
"Execute query using an ad-hoc view."
(ensure-db ()
- (db-request (cat *db-name* "/_temp_view")
+ (db-request (cat (url-encode *db-name*) "/_temp_view")
:method :post
:content-type "text/javascript"
:parameters (transform-params options *view-options*)
@@ -493,7 +507,7 @@
(if (not (null (cdr views))) ", ")
(mk-view-js (cdr views))))))))
(ensure-db ()
- (db-request (cat *db-name* "/_design/" id)
+ (db-request (cat (url-encode *db-name*) "/_design/" (url-encode id))
:method :put
:content
(cat "{\"language\" : \"text/javascript\","
@@ -502,7 +516,7 @@
(defun delete-view (id &key revision)
"Delete identified view document"
(ensure-db ()
- (delete-document :id (cat "_design/" id) :revision revision)))
+ (delete-document :id (cat "_design/" (url-encode id)) :revision revision)))
(defun invoke-view (id view &rest options &key key start-key start-key-docid
end-key count update descending skip)
@@ -516,6 +530,6 @@
inconsistency."
(declare (ignore key start-key start-key-docid end-key count update descending skip))
(ensure-db ()
- (db-request (cat *db-name* "/_view/" id "/" view)
+ (db-request (cat (url-encode *db-name*) "/_view/" (url-encode id) "/" (url-encode view))
:method :get
:parameters (transform-params options *view-options*))))
--- /project/clouchdb/cvsroot/clouchdb/src/examples.lisp 2007/12/09 16:03:21 1.2
+++ /project/clouchdb/cvsroot/clouchdb/src/examples.lisp 2007/12/14 23:22:58 1.3
@@ -100,7 +100,6 @@
(create-document '(("name" . "Czech Republic")
("tags" . ("country" "european"))
("motto" . "Truth prevails")
-
("demographics" . ((:population . 10230000)
;; A nested map property:
(:religion . ((:agnostic . 0.59)
--- /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/09 16:03:21 1.2
+++ /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/14 23:22:58 1.3
@@ -330,6 +330,12 @@
(return-from test nil)))
t))))
+(addtest (clouchdb-doc-api-tests)
+ (:documentation "Test document ID encoding")
+ encode-document-id
+ (ensure (document-property :ok (create-document '((:a "test")) :id "http://google.com")))
+ (ensure-same (document-property :_id (get-document "http://google.com")) "http://google.com"))
+
;;
;; View API Tests
;;
From peddy at common-lisp.net Mon Dec 17 13:58:32 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 08:58:32 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/public_html
Message-ID: <20071217135832.749C5620C7@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/public_html
In directory clnet:/tmp/cvs-serv4983/public_html
Modified Files:
index.html
Log Message:
- Encode all URL parameters properly, this fixes issues reported by
Daniel Farina having to do with the inability to use leagal
characters in document IDs.
- Error handling for (post-document)
--- /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/14 23:22:58 1.3
+++ /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/17 13:58:32 1.4
@@ -518,15 +518,16 @@
-Special Properties
+ Special Properties
+
-When a document is created CouchDb assigns special properties to that
-document, these properties cannot be modified by clients. The special
-properties include the document's ID (:_id) and the document revision
-number (:_rev). All special properties begin with an underscore (_)
-symbol.
+ When a document is created CouchDb assigns special properties to that
+ document, these properties cannot be modified by clients. The special
+ properties include the document's ID (:_id) and the document revision
+ number (:_rev). All special properties begin with an underscore (_)
+ symbol.
From peddy at common-lisp.net Mon Dec 17 13:58:32 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 08:58:32 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071217135832.B6E186A004@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv4983/src
Modified Files:
changelog.txt clouchdb.asd clouchdb.lisp package.lisp
Log Message:
- Encode all URL parameters properly, this fixes issues reported by
Daniel Farina having to do with the inability to use leagal
characters in document IDs.
- Error handling for (post-document)
--- /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/09 16:03:21 1.2
+++ /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/17 13:58:32 1.3
@@ -1,4 +1,10 @@
+0.0.5:
+ - Encode all URL parameters properly, this fixes issues reported by
+ Daniel Farina having to do with the inability to use leagal
+ characters in document IDs.
+ - Error handling for (post-document)
+
0.0.4:
- Fixed ad-hoc-view and invoke-view functions so that they now use
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.asd 2007/12/01 14:19:59 1.1.1.1
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.asd 2007/12/17 13:58:32 1.2
@@ -38,7 +38,8 @@
:serial t
:version #.*clouchdb-version*
:depends-on (:drakma
- :cl-json)
+ :cl-json
+ :flexi-streams)
:components ((:file "package")
(:file "clouchdb")))
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/14 23:22:58 1.4
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/17 13:58:32 1.5
@@ -25,7 +25,8 @@
(in-package :clouchdb)
(defvar *host* "localhost" "CouchDb server host name")
-(defvar *port* "5984" "As of version 7.2, the IANA assigned CouchDb port (was 8888)")
+(defvar *port* "5984"
+ "As of version 7.2, the IANA assigned CouchDb port (was 8888)")
(defvar *db-name* "default" "Default database name")
(defvar *protocol* "http" "http or https")
@@ -37,6 +38,9 @@
(defparameter *temp-db-counter* 0 "Used in the creation of temporary databases")
+;(defconstant +utf-8+ (make-external-format :utf-8 :eol-style :lf)
+; "Default external format for document content.")
+
;;
;; URL Parameter helpers
;;
@@ -104,7 +108,11 @@
(define-condition doc-error (error)
((text :initarg :uri :reader text)
(reason :initarg :reason :reader reason)
- (id :initarg :id :reader id)))
+ (id :initarg :id :reader id))
+ (:report (lambda (condition stream)
+ (format stream "Reason \"~A\", Document ID: \"~A\""
+ (reason condition)
+ (id condition)))))
(define-condition id-or-revision-conflict (doc-error)
()
@@ -197,6 +205,14 @@
:uri (make-uri dbn)))))
,result)))
+;; (defmacro handle-doc-errors (&body body)
+;; (let ((result (gensym)))
+;; `(let ((,result (progn , at body)))
+;; (when (document-property :error (,result))
+;; (cond ((equal "conflict" (document-property :error result))
+;; (error 'id-or-revision-conflict
+
+
;;
;;
;;
@@ -235,7 +251,7 @@
(t (cdr (assoc name doc)))))
(defun (setf document-property) (value name doc)
- "Allows setting of document properties in place."
+ "Allows setting of document properties in place (destructively)."
(cond ((hash-table-p doc)
(setf (gethash name doc) value))
(t (rplacd (assoc name doc) value)))
@@ -303,7 +319,8 @@
error condition is generated. Specify :recreate to potentially delete
and create a new database."
(let* ((name (if db-name-p db-name *db-name*))
- (res (db-request (cat (url-encode name) "/") :method :put)))
+ (res (db-request (cat (url-encode name) "/")
+ :method :put)))
(if (equal "database_already_exists" (document-property :error res))
(ecase if-exists
((:ignore) (list (cons :ok t) (cons :ignored t)))
@@ -426,9 +443,10 @@
((and id current-id (not (equal current-id id)))
(setf doc (document-properties doc))))
(let ((res (ensure-db ()
- (db-request (cat (url-encode *db-name*) "/" (url-encode (if id id current-id)))
- :external-format-out :utf-8
+ (db-request (cat (url-encode *db-name*) "/"
+ (url-encode (if id id current-id)))
:content-type "text/json"
+;; :external-format-out +utf-8+
:method :put :content (document-to-json doc)))))
(when (document-property :error res)
(error (if (equal "conflict" (document-property :error res))
@@ -440,10 +458,23 @@
(defun post-document (doc)
"Create a document and let the server assign an ID. A successful
areturn value includes the new document ID, in the :ID property."
- (ensure-db ()
- (db-request (cat (url-encode *db-name*) "/")
- :method :post
- :content (document-to-json doc))))
+ (let ((res (ensure-db ()
+ (db-request (cat (url-encode *db-name*) "/")
+ :method :post
+ :content (document-to-json doc)))))
+ (when (document-property :error res)
+ (error 'doc-error) :id nil :reason (document-property :reason res))
+ res))
+
+;; (defun post-document (doc)
+;; "Create a document and let the server assign an ID. A successful
+;; areturn value includes the new document ID, in the :ID property."
+;; (ensure-db ()
+;; (db-request (cat (url-encode *db-name*) "/")
+;; :method :post
+;; :content-type "text/plain;charset=utf-8"
+;; :external-format-out +utf-8+
+;; :content #p"/Users/peter/encodings.txt")))
(defun create-document (doc &key id)
"Create a new document, optionally specifying the new document
--- /project/clouchdb/cvsroot/clouchdb/src/package.lisp 2007/12/01 14:19:59 1.1.1.1
+++ /project/clouchdb/cvsroot/clouchdb/src/package.lisp 2007/12/17 13:58:32 1.2
@@ -25,7 +25,7 @@
(cl:in-package :cl-user)
(defpackage :clouchdb
- (:use :cl :drakma :json)
+ (:use :cl :drakma :json :flexi-streams)
(:export :*scheme*
:*host*
:*port*
From peddy at common-lisp.net Mon Dec 17 23:18:08 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 18:18:08 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071217231808.1BFB27E007@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv3658/src
Modified Files:
tests.lisp
Log Message:
Fixed utf-8 encoding bug
--- /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/14 23:22:58 1.3
+++ /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/17 23:18:07 1.4
@@ -336,6 +336,45 @@
(ensure (document-property :ok (create-document '((:a "test")) :id "http://google.com")))
(ensure-same (document-property :_id (get-document "http://google.com")) "http://google.com"))
+(addtest (clouchdb-doc-api-tests)
+ (:documentation "Test document content encoding by creating a
+ document with a field for a variety of languages, then fetching that
+ document and comparing the fecthed data with the source data")
+ encode-document-contents-glass-eating
+ (ensure
+ (let ((glass-eaters '((:middle-english . "An preost wes on leoden, La??amon was ihoten")
+ (:classical-greek . "??????????? ????????????? ????????????????? ??????????? ????? ???? ???????????????.")
+ (:monotonic-greek . "?????????? ???? ?????? ???????????????? ???????????? ?????????? ???? ???????? ????????????.")
+ (:polytonic-greek . "??????????? ????? ?????? ???????????????? ????????????? ??????????? ????? ???????? ????????????.")
+ (:french . "Je peux manger du verre, ??a ne me fait pas de mal.")
+ (:proven??al . "P??di manjar de veire, me nafrari?? pas.")
+ (:walloon . "Dji pou magn?? do v??re, ??oula m' freut n??n m??.")
+ (:spanish . "Puedo comer vidrio, no me hace da??o.")
+ (:romanian . "Pot s?? m??n??nc sticl?? ??i ea nu m?? r??ne??te.")
+ (:esperanto . "Mi povas man??i vitron, ??i ne dama??as min.")
+ (:czech . "Mohu j??st sklo, neubl?????? mi.")
+ (:lithuanian . "A?? galiu valgyti stikl?? ir jis man??s ne??eid??ia")
+ (:polska . "Mog?? je???? szk??o i mi nie szkodzi.")
+ (:macedonian . "?????????? ???? ?????????? ????????????, ?? ???? ???? ??????????.")
+ (:russian . "?? ???????? ???????? ????????????, ?????? ?????? ???? ????????????.")
+ (:belarusian-cyrillic . "?? ???????? ???????? ????????, ?????? ?????? ???? ????????????????.")
+ (:belarusian-lacinka . "Ja mahu je??ci ??k??o, jano mne ne ??kodzi??.")
+ (:armenian . "?????????? ?????????? ?????????? ?? ???????? ?????????????????? ????????????")
+ (:hebrew . "?????? ???????? ?????????? ???????????? ?????? ???? ???????? ????")
+ (:yiddish . "?????? ?????? ?????? ?????????? ?????? ???? ?????? ?????? ???????? ????")
+ (:chinese . "????????????????????????????????????")
+ (:chinese-traditional . "????????????????????????????????????")
+ (:japanese . "???????????????????????????????????????????????????????????????????????????")
+ (:korean . "?????? ????????? ?????? ??? ?????????. ????????? ????????? ?????????")
+ (:euro-symbol . "???")
+ (:georgian . "??????????????? ???????????? ?????? ????????? ??????????????????."))))
+ (and (document-property :ok (create-document glass-eaters :id "glass-eaters"))
+ (let ((doc (get-document "glass-eaters")))
+ (reduce #'(lambda (a b) (and a b))
+ (mapcar #'(lambda (e)
+ (equal (cdr e)
+ (document-property (car e) doc)))
+ doc)))))))
;;
;; View API Tests
;;
From peddy at common-lisp.net Mon Dec 17 23:22:23 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 18:22:23 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071217232223.732F37E007@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv5674/src
Modified Files:
examples.lisp clouchdb.lisp changelog.txt
Log Message:
Fixed utf-8 encoding
--- /project/clouchdb/cvsroot/clouchdb/src/examples.lisp 2007/12/14 23:22:58 1.3
+++ /project/clouchdb/cvsroot/clouchdb/src/examples.lisp 2007/12/17 23:22:23 1.4
@@ -55,9 +55,7 @@
(create-db :if-exists :recreate)
;; Create a document with ID of "haussmann"
(create-document '(;; Fields with scalar values:
- (:name . "Georges-Eugene Haussmann")
- ;; Note: above should be "Georges-Eug?ne" but
- ;; there's a character handling bug somewhere
+ (:name . "Georges-Eug?ne Haussmann")
(:aka . "Baron Haussmann")
(:born . "1809-03-27")
(:died . "1891-01-11"))
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/17 13:58:32 1.5
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/17 23:22:23 1.6
@@ -38,8 +38,8 @@
(defparameter *temp-db-counter* 0 "Used in the creation of temporary databases")
-;(defconstant +utf-8+ (make-external-format :utf-8 :eol-style :lf)
-; "Default external format for document content.")
+(defconstant +utf-8+ (make-external-format :utf-8 :eol-style :lf)
+ "Default external format for document content.")
;;
;; URL Parameter helpers
@@ -212,6 +212,8 @@
;; (cond ((equal "conflict" (document-property :error result))
;; (error 'id-or-revision-conflict
+(defun test ()
+ (with-open-file
;;
;;
@@ -445,9 +447,11 @@
(let ((res (ensure-db ()
(db-request (cat (url-encode *db-name*) "/"
(url-encode (if id id current-id)))
- :content-type "text/json"
-;; :external-format-out +utf-8+
- :method :put :content (document-to-json doc)))))
+ :content-type "text/javascript"
+ :external-format-out +utf-8+
+ :content-length nil
+ :content (document-to-json doc)
+ :method :put))))
(when (document-property :error res)
(error (if (equal "conflict" (document-property :error res))
'id-or-revision-conflict 'doc-error)
@@ -460,22 +464,15 @@
areturn value includes the new document ID, in the :ID property."
(let ((res (ensure-db ()
(db-request (cat (url-encode *db-name*) "/")
- :method :post
- :content (document-to-json doc)))))
+ :content-type "text/javascript"
+ :external-format-out +utf-8+
+ :content-length nil
+ :content (document-to-json doc)
+ :method :post))))
(when (document-property :error res)
(error 'doc-error) :id nil :reason (document-property :reason res))
res))
-;; (defun post-document (doc)
-;; "Create a document and let the server assign an ID. A successful
-;; areturn value includes the new document ID, in the :ID property."
-;; (ensure-db ()
-;; (db-request (cat (url-encode *db-name*) "/")
-;; :method :post
-;; :content-type "text/plain;charset=utf-8"
-;; :external-format-out +utf-8+
-;; :content #p"/Users/peter/encodings.txt")))
-
(defun create-document (doc &key id)
"Create a new document, optionally specifying the new document
ID."
@@ -490,7 +487,9 @@
(ensure-db ()
(db-request (cat (url-encode *db-name*) "/_bulk_docs")
:method :post
- :content-type "text/javascript"
+ :content-type "application/xml"
+ :external-format-out +utf-8+
+ :content-length nil
:content
(cat "[ "
(string-join (mapcar #'document-to-json docs))
@@ -503,7 +502,8 @@
not the revision, the current document will be fetched and it's
revision number will be used for the delete."
(labels ((del (id rev)
- (db-request (cat (url-encode *db-name*) "/" (url-encode id) "?rev=" rev)
+ (db-request (cat (url-encode *db-name*) "/" (url-encode id) "?rev="
+ (url-encode (value-as-string rev)))
:method :delete)))
(cond ((not (null document))
(delete-document :id (document-property :_id document)
@@ -523,7 +523,9 @@
(ensure-db ()
(db-request (cat (url-encode *db-name*) "/_temp_view")
:method :post
+ :external-format-out +utf-8+
:content-type "text/javascript"
+ :content-length nil
:parameters (transform-params options *view-options*)
:content view)))
@@ -540,6 +542,9 @@
(ensure-db ()
(db-request (cat (url-encode *db-name*) "/_design/" (url-encode id))
:method :put
+ :external-format-out +utf-8+
+ :content-type "text/javascript"
+ :content-length nil
:content
(cat "{\"language\" : \"text/javascript\","
"\"views\" : {" (mk-view-js view-defs) "}}")))))
--- /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/17 13:58:32 1.3
+++ /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/17 23:22:23 1.4
@@ -1,4 +1,7 @@
+0.0.6:
+ - Finally fixed utf-8 encoding
+
0.0.5:
- Encode all URL parameters properly, this fixes issues reported by
Daniel Farina having to do with the inability to use leagal
From peddy at common-lisp.net Mon Dec 17 23:22:23 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 18:22:23 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/public_html
Message-ID: <20071217232223.AE1197E007@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/public_html
In directory clnet:/tmp/cvs-serv5674/public_html
Modified Files:
index.html
Log Message:
Fixed utf-8 encoding
--- /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/17 13:58:32 1.4
+++ /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/17 23:22:23 1.5
@@ -43,11 +43,16 @@
+ - Dec 17, 2007 Released version 0.0.5 with fixes for
+ encoding of URL parameters. This fix allows use of leagl CouchDb
+ characaters for database names and document IDs which must be
+ escaped in urls.
+
- Dec 9, 2007 - Version 0.0.4: Updated
(invoke-view) and
(ad-hoc-view) to use all options
- supported by corresponding CouchDb API. Somehow I'd missed
- these before.
+ supported by corresponding CouchDb API. Somehow I'd missed these
+ before.
- Nov 28, 2007 -
CouchDb 7.2 now uses IANA assigned port 5984 instead of 8888.
From peddy at common-lisp.net Tue Dec 18 02:16:02 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 21:16:02 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071218021602.97AD01092@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv31727/src
Modified Files:
clouchdb.lisp
Log Message:
Updated document API documentation
Removed junk code
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/17 23:22:23 1.6
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 02:16:02 1.7
@@ -212,13 +212,6 @@
;; (cond ((equal "conflict" (document-property :error result))
;; (error 'id-or-revision-conflict
-(defun test ()
- (with-open-file
-
-;;
-;;
-;;
-
(defun document-to-json (doc)
"Convert document data, the top-level of wich is either an
associative list or hashtable, to json data"
From peddy at common-lisp.net Tue Dec 18 02:16:02 2007
From: peddy at common-lisp.net (peddy)
Date: Mon, 17 Dec 2007 21:16:02 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/public_html
Message-ID: <20071218021602.CFE44405F@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/public_html
In directory clnet:/tmp/cvs-serv31727/public_html
Modified Files:
index.html
Log Message:
Updated document API documentation
Removed junk code
--- /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/17 23:22:23 1.5
+++ /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/18 02:16:02 1.6
@@ -37,6 +37,11 @@
+
@@ -366,7 +371,7 @@
-Server Connection and Database Management API
+
The API described in this has to do with managing CouchDb server
@@ -510,17 +515,71 @@
See (set-connection)
-Document API
+
+
+ The Document ID
+
+
+
+ Documents in clouchdb are identified by a document ID string which
+ must be unique within the database that will contain the
+ document. The ID string may either be specified when the document
+ is created or it can be provided by the CouchDb server.
+
+
- Documents in clouchdb are identified by a document ID, their content
- takes the form of an associative list. The native document
- representation in CouchDb is a JSON
- object. Using
- cl-json,
- clouchdb automatically translates documents between JSON and Lisp
- associative lists.
+ Document Content
+
+
+ Document content takes the form of an associative list. The car of
+ each element of the associative list may be either a string or a
+ symbol. For example, each of the following calls to
+ (create-document) creates a document with a field named "name":
+
+
+
+(create-document '((:name . "Max"))
+(create-document '((name . "Max"))
+(create-document '(("name" . "Max"))
+
+
+
+ Field names in CouchDb are case sensitive. To specify a field name
+ that uses upper case characters, you must use a string value as
+ symbols are always converted to lower case. In the following
+ example a single document is created with two fields, "name" and
+ "Name":
+
+
+
+(create-document '((:name . "Max")
+ ("Name" . "Max")))
+
+
+
+ The native document representation in the CouchDb protocol is
+ a JSON object. Using
+ cl-json,
+ clouchdb automatically translates documents between JSON and Lisp
+ associative lists.
+
+
+
+ The value of a document field may be a string, a number, a list,
+ or an associative list. Document field values may be nested to
+ create very complex document structures.
+
+
+
+(create-document '((:string . "String Value")
+ (:number . 3.1415926535)
+ (:list . (milk eggs "green beans"))
+ (:alist . ((
+
+
+
Special Properties
@@ -678,7 +737,7 @@
-Views API
+h4>Views API
Views are the mechanism with which documents are queried in
From peddy at common-lisp.net Tue Dec 18 17:26:56 2007
From: peddy at common-lisp.net (peddy)
Date: Tue, 18 Dec 2007 12:26:56 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071218172656.00D6143225@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv9477/src
Modified Files:
tests.lisp clouchdb.lisp
Log Message:
Support for utf-8 encoded document IDs
--- /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/17 23:18:07 1.4
+++ /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/18 17:26:56 1.5
@@ -337,6 +337,17 @@
(ensure-same (document-property :_id (get-document "http://google.com")) "http://google.com"))
(addtest (clouchdb-doc-api-tests)
+ (:documentation "Test encoding and decoding of utf-8 document IDs")
+ encode-document-utf-8-ids
+ (ensure
+ (let ((ids '("??ngstr??m Caf??" "????????????????" "?????????????????????????????????")))
+ (reduce #'(lambda (a b) (and a b))
+ (mapcar #'(lambda (id)
+ (and (document-property :ok (create-document nil :id id))
+ (equal id (document-property :_id (get-document id)))))
+ ids)))))
+
+(addtest (clouchdb-doc-api-tests)
(:documentation "Test document content encoding by creating a
document with a field for a variety of languages, then fetching that
document and comparing the fecthed data with the source data")
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 02:16:02 1.7
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 17:26:56 1.8
@@ -162,27 +162,34 @@
out))
(defmacro cat (&rest rest)
- "Silly shorthand for (concatenate 'string)"
+ "Shorthand for (concatenate 'string)"
`(concatenate 'string , at rest))
(defun doublequote (value)
"Wrap specified value in double quotes."
(cat "\"" value "\""))
+(defun convert-encoding (string encoding)
+ "Convert string to specified encoding. This may be totally wrong and
+probably way too inefficient, but it seems to work."
+ (octets-to-string (string-to-octets string :external-format encoding)))
+
(defun url-encode (string)
"URL-encode a string."
(with-output-to-string (s)
- (loop for c across string
+ (loop for c across (convert-encoding string +utf-8+)
do (cond ((or (char<= #\0 c #\9)
(char<= #\a c #\z)
(char<= #\A c #\Z)
(find c "$-_.!*'()," :test #'char=))
(write-char c s))
((char= c #\Space)
- (write-char #\+ s))
+ (write-string "%20" s))
(t (format s "%~2,'0x" (char-code c)))))))
(defun make-uri (&rest rest)
+ "Return a URI containing *protocol*://*host*:*port*/ and the
+concatenation of the remaining parameters."
(concatenate 'string *protocol* "://" *host* ":" *port* "/"
(apply #'concatenate 'string rest)))
@@ -205,13 +212,6 @@
:uri (make-uri dbn)))))
,result)))
-;; (defmacro handle-doc-errors (&body body)
-;; (let ((result (gensym)))
-;; `(let ((,result (progn , at body)))
-;; (when (document-property :error (,result))
-;; (cond ((equal "conflict" (document-property :error result))
-;; (error 'id-or-revision-conflict
-
(defun document-to-json (doc)
"Convert document data, the top-level of wich is either an
associative list or hashtable, to json data"
@@ -254,7 +254,7 @@
(defun db-request (uri &rest keys &key &allow-other-keys)
"Used by all Couchdb APIs to make the actual REST request."
-;; (format t "uri: ~S~% keys: ~S~%" (make-uri uri) keys)
+ ;;(format t "uri: ~S~% keys: ~S~%" (make-uri uri) keys)
(let ((*text-content-types* *text-types*))
(multiple-value-bind (body status headers uri stream must-close reason-phrase)
(apply #'drakma:http-request (make-uri uri) keys)
@@ -304,7 +304,7 @@
;;
(defun list-dbs ()
- "List all databases"
+ "Return a list of all databases for the current host and port."
(db-request "_all_dbs" :method :get))
(defun create-db (&key (db-name nil db-name-p) (if-exists :fail))
@@ -411,7 +411,8 @@
(push (cons "revs" "true") parameters))
(when revision-info
(push (cons "revs_info" "true") parameters))
- (let ((res (ensure-db () (db-request (cat (url-encode *db-name*) "/" (url-encode id))
+ (let ((res (ensure-db () (db-request (cat (url-encode *db-name*) "/"
+ (url-encode id))
:method :get
:parameters parameters))))
(if (document-property :error res)
@@ -513,6 +514,8 @@
(defun ad-hoc-view (view &rest options &key key start-key start-key-docid
end-key count update descending skip)
"Execute query using an ad-hoc view."
+ (declare (ignore key start-key start-key-docid end-key count
+ update descending skip))
(ensure-db ()
(db-request (cat (url-encode *db-name*) "/_temp_view")
:method :post
@@ -557,8 +560,10 @@
returns results in reverse order. If update is t, does not refresh
view for query, use for higher performance but possible data
inconsistency."
- (declare (ignore key start-key start-key-docid end-key count update descending skip))
+ (declare (ignore key start-key start-key-docid end-key count
+ update descending skip))
(ensure-db ()
- (db-request (cat (url-encode *db-name*) "/_view/" (url-encode id) "/" (url-encode view))
+ (db-request (cat (url-encode *db-name*) "/_view/"
+ (url-encode id) "/" (url-encode view))
:method :get
:parameters (transform-params options *view-options*))))
From peddy at common-lisp.net Tue Dec 18 18:03:46 2007
From: peddy at common-lisp.net (peddy)
Date: Tue, 18 Dec 2007 13:03:46 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071218180346.0FDBC650DB@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv15160/src
Modified Files:
clouchdb.lisp
Log Message:
Fixed (get-db-info) for SBCL when :db-name is specified as null (get server info)
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 17:26:56 1.8
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 18:03:45 1.9
@@ -38,7 +38,13 @@
(defparameter *temp-db-counter* 0 "Used in the creation of temporary databases")
-(defconstant +utf-8+ (make-external-format :utf-8 :eol-style :lf)
+(defmacro define-constant (name value &optional doc)
+ "A version of DEFCONSTANT for, cough, /strict/ CL implementations."
+ ;; See
+ `(defconstant ,name (if (boundp ',name) (symbol-value ',name) ,value)
+ ,@(when doc (list doc))))
+
+(define-constant +utf-8+ (make-external-format :utf-8 :eol-style :lf)
"Default external format for document content.")
;;
@@ -212,6 +218,23 @@
:uri (make-uri dbn)))))
,result)))
+<<<<<<< clouchdb.lisp
+;; (defmacro handle-doc-errors (&body body)
+;; (let ((result (gensym)))
+;; `(let ((,result (progn , at body)))
+;; (when (document-property :error (,result))
+;; (cond ((equal "conflict" (document-property :error result))
+;; (error 'id-or-revision-conflict
+
+<<<<<<< clouchdb.lisp
+;;
+;;
+;;
+
+=======
+>>>>>>> 1.7
+=======
+>>>>>>> 1.8
(defun document-to-json (doc)
"Convert document data, the top-level of wich is either an
associative list or hashtable, to json data"
@@ -349,7 +372,8 @@
"Get information for named database, or couchdb server if no
database specified."
(let ((dbn (if db-name-p db-name *db-name*)))
- (db-request (cat (url-encode dbn) "/") :method :get)))
+ (db-request (if dbn (cat (url-encode dbn) "/"))
+ :method :get)))
(defun create-temp-db-name ()
"Return a database name that's probably unique."
From peddy at common-lisp.net Tue Dec 18 18:09:53 2007
From: peddy at common-lisp.net (peddy)
Date: Tue, 18 Dec 2007 13:09:53 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071218180953.1C35965121@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv15531/src
Modified Files:
clouchdb.lisp
Log Message:
Removed vc conflict junk
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 18:03:45 1.9
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 18:09:53 1.10
@@ -218,23 +218,6 @@
:uri (make-uri dbn)))))
,result)))
-<<<<<<< clouchdb.lisp
-;; (defmacro handle-doc-errors (&body body)
-;; (let ((result (gensym)))
-;; `(let ((,result (progn , at body)))
-;; (when (document-property :error (,result))
-;; (cond ((equal "conflict" (document-property :error result))
-;; (error 'id-or-revision-conflict
-
-<<<<<<< clouchdb.lisp
-;;
-;;
-;;
-
-=======
->>>>>>> 1.7
-=======
->>>>>>> 1.8
(defun document-to-json (doc)
"Convert document data, the top-level of wich is either an
associative list or hashtable, to json data"
From peddy at common-lisp.net Tue Dec 18 18:20:09 2007
From: peddy at common-lisp.net (peddy)
Date: Tue, 18 Dec 2007 13:20:09 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071218182009.A5B4D1092@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv16625/src
Modified Files:
changelog.txt
Log Message:
Updated change log
--- /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/17 23:22:23 1.4
+++ /project/clouchdb/cvsroot/clouchdb/src/changelog.txt 2007/12/18 18:20:09 1.5
@@ -1,6 +1,9 @@
0.0.6:
- - Finally fixed utf-8 encoding
+ - Finally fixed utf-8 encoding bug for document contents
+ - Revised document ID encoding to 1) Support utf-8 characters
+ properly, and 2) Encode spaces using %20 instead of +
+ - Updated documentation relating to document API
0.0.5:
- Encode all URL parameters properly, this fixes issues reported by
From peddy at common-lisp.net Tue Dec 18 21:33:34 2007
From: peddy at common-lisp.net (peddy)
Date: Tue, 18 Dec 2007 16:33:34 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/src
Message-ID: <20071218213334.3008549050@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/src
In directory clnet:/tmp/cvs-serv15753/src
Modified Files:
tests.lisp clouchdb.lisp
Log Message:
Added support to document-property for using strings, keyword symbols
or regular symgbols for field name, added tests for this feature
--- /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/18 17:26:56 1.5
+++ /project/clouchdb/cvsroot/clouchdb/src/tests.lisp 2007/12/18 21:33:34 1.6
@@ -89,16 +89,6 @@
(push d results))))))
results))
-;; (defun create-view-test2 ()
-;; "Create a view that uses a key query param"
-;; (create-test-documents *people*)
-;; (create-view "key-view"
-;; (cons "friendof"
-;; (ps (lambda (doc)
-;; (with-slots (friends) doc
-;; (dolist (friend friends)
-;; (map friend doc))))))))
-
;;
;; Database API Tests
;;
@@ -115,6 +105,53 @@
(*protocol* "http")))
;;
+;; General tests that do not require a db connection
+;;
+
+(deftestsuite clouchdb-general-tests (clouchdb-tests) () ())
+
+(addtest (clouchdb-general-tests)
+ (:documentation "Test document-property")
+ general-tests-document-property
+ (ensure
+ (let ((doc '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "NaMe"))))
+ (reduce #'(lambda (a b) (and a b))
+ (mapcar #'(lambda (e)
+ (equal (cdr (assoc (car e) doc))
+ (document-property (car e) doc)))
+ doc)))))
+
+(addtest (clouchdb-general-tests)
+ (:documentation "Test document-property using property name strings")
+ general-tests-document-property-string
+ (ensure-same "name1"
+ (document-property "name" '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3"))))
+ (ensure-same "name2"
+ (document-property "Name" '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3"))))
+ (ensure-same "name3"
+ (document-property "NaMe" '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3")))))
+
+(addtest (clouchdb-general-tests)
+ (:documentation "Test document-property using keyword symbols")
+ general-tests-document-property-keyword
+ (ensure-same "name1"
+ (document-property :NAME '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3"))))
+ (ensure-same "name2"
+ (document-property :*NAME '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3"))))
+ (ensure-same "name3"
+ (document-property :*NA-ME'((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3")))))
+
+(addtest (clouchdb-general-tests)
+ (:documentation "Test document-property using non-keyword symbols")
+ general-tests-document-property-symbol
+ (ensure-same "name1"
+ (document-property 'name '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3"))))
+ (ensure-same "name2"
+ (document-property '*name '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3"))))
+ (ensure-same "name3"
+ (document-property '*na-me '((:NAME . "name1") (:*NAME . "name2") (:*NA-ME . "name3")))))
+
+;;
;; Db Administration Tests
;;
;; Test the APIs that create, delete, and get information about
@@ -501,7 +538,8 @@
;;
(defun run-all-tests ()
- (dolist (suite '(clouchdb-db-admin-tests
+ (dolist (suite '(clouchdb-general-tests
+ clouchdb-db-admin-tests
clouchdb-doc-api-tests
clouchdb-view-tests))
(format t "~S~%" (run-tests :suite suite))))
--- /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 18:09:53 1.10
+++ /project/clouchdb/cvsroot/clouchdb/src/clouchdb.lisp 2007/12/18 21:33:34 1.11
@@ -245,18 +245,52 @@
new-doc))
(t doc)))
+
+(defun camel-case-to-lisp (string)
+ "Converts a string in camelCase to the same lisp-friendly syntax used in parenscript.
+Stolen from the cl-json library since it's not exported. Examples:
+\"camelCase\" -> \"CAMEL-CASE\", \"CamelCase\" -> \"*CAMEL-CASE\",
+\"dojo.widget.TreeNode\" -> \"DOJO.WIDGET.*TREE-NODE\""
+ (with-output-to-string (out)
+ (loop for ch across string
+ with last-char do
+ (if (upper-case-p ch)
+ (progn
+ (if (and last-char (lower-case-p last-char))
+ (write-char #\- out)
+ (write-char #\* out))
+ (write-char ch out))
+ (write-char (char-upcase ch) out))
+ (setf last-char ch))))
+
+(defun as-keyword-symbol (value)
+ "Return value in a form that would be used to identify the car of a
+value in a document. For example, a value of \"FIELD-NAME\" would
+return :FIELD-NAME, 'FIELD-NAME would become :FIELD-NAME, and
+\"Field-Name\" would become \":*FIELD-NAME\"."
+ (cond ((keywordp value)
+ value)
+ ((stringp value)
+ (intern (camel-case-to-lisp value) "KEYWORD"))
+ ((symbolp value)
+ (as-keyword-symbol (intern (symbol-name value) "KEYWORD")))))
+
(defun document-property (name doc)
- "Get the value associated with the document property or nil"
- (cond ((hash-table-p doc)
- (gethash name doc))
- (t (cdr (assoc name doc)))))
+ "Get the value associated with the document property or nil if there
+is no associated value. Note that name may be either a keyword symbol,
+a regular symbol or a string."
+ (let ((name (as-keyword-symbol name)))
+ (cond ((hash-table-p doc)
+ (gethash name doc))
+ (t (cdr (assoc name doc))))))
(defun (setf document-property) (value name doc)
"Allows setting of document properties in place (destructively)."
- (cond ((hash-table-p doc)
- (setf (gethash name doc) value))
- (t (rplacd (assoc name doc) value)))
- value)
+ (let ((name (as-keyword-symbol name)))
+ (cond ((hash-table-p doc)
+ (setf (gethash name doc) value))
+ (t (rplacd (assoc name doc) value)))
+ value))
(defun db-request (uri &rest keys &key &allow-other-keys)
"Used by all Couchdb APIs to make the actual REST request."
From peddy at common-lisp.net Wed Dec 19 15:10:43 2007
From: peddy at common-lisp.net (peddy)
Date: Wed, 19 Dec 2007 10:10:43 -0500 (EST)
Subject: [clouchdb-cvs] CVS clouchdb/public_html
Message-ID: <20071219151043.F3E855557A@common-lisp.net>
Update of /project/clouchdb/cvsroot/clouchdb/public_html
In directory clnet:/tmp/cvs-serv18123/public_html
Modified Files:
index.html
Log Message:
Updated documentation for 0.0.6 release
--- /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/18 02:16:02 1.6
+++ /project/clouchdb/cvsroot/clouchdb/public_html/index.html 2007/12/19 15:10:43 1.7
@@ -43,11 +43,20 @@
+
+ - Dec 19, 2007 Released version 0.0.6 with full support for
+ utf-8 character encoding. This change includes support for
+ non-Latin characters in document IDs and in document
+ content. Additionally the encoding of spaces in document IDs has
+ been changed from "+" to "%20", this fixes a problem where the "+"
+ characters were not removed from document IDs when they were
+ decoded.
+
- Dec 17, 2007 Released version 0.0.5 with fixes for
encoding of URL parameters. This fix allows use of leagl CouchDb
characaters for database names and document IDs which must be
@@ -536,27 +545,45 @@
Document content takes the form of an associative list. The car of
each element of the associative list may be either a string or a
symbol. For example, each of the following calls to
- (create-document) creates a document with a field named "name":
+ (create-document) creates a document with a field wich will be
+ named "name" in the database, but which will be :NAME (a keyword
+ symbol) when the documents are retrieved:
-(create-document '((:name . "Max"))
-(create-document '((name . "Max"))
-(create-document '(("name" . "Max"))
+(create-document '((:name . "Max")) :id "keyword")
+(get-document "keyword")
+=> ((:_ID . "keyword") (:_REV . "3674093994") (:NAME . "Max"))
+
+(create-document '((name . "Max")) :id "symbol")
+(get-document "symbol")
+=> ((:_ID . "symbol") (:_REV . "3189074278") (:NAME . "Max"))
+
+(create-document '(("name" . "Max")) :id "string")
+(get-document "string")
+=> ((:_ID . "string") (:_REV . "3730286488") (:NAME . "Max"))
Field names in CouchDb are case sensitive. To specify a field name
- that uses upper case characters, you must use a string value as
- symbols are always converted to lower case. In the following
- example a single document is created with two fields, "name" and
- "Name":
+ that uses mixed case, you may either use a string value, or encode
+ the symbol approprately. In the following example a single
+ document is created with two fields named, "name" and "Name":
-(create-document '((:name . "Max")
- ("Name" . "Max")))
-
+(create-document '(("FieldName" . "Value")) :id "string-mixed")
+(get-document "string-mixed")
+=> ((:_ID . "string-mixed") (:_REV . "3753754378") (:*FIELD-NAME . "Value"))
+
+(create-document '((:*field-name . "Value")) :id "keyword-mixed")
+(get-document "keyword-mixed")
+=> ((:_ID . "keyword-mixed") (:_REV . "2016717365") (:*FIELD-NAME . "Value"))
+
+(create-document '((*field-name . "Value")) :id "symbol-mixed")
+(get-document "symbol-mixed")
+=> ((:_ID . "symbol-mixed") (:_REV . "4010145031") (:*FIELD-NAME . "Value"))
+
The native document representation in the CouchDb protocol is
@@ -574,11 +601,23 @@
(create-document '((:string . "String Value")
- (:number . 3.1415926535)
+ (:number . 42.0)
(:list . (milk eggs "green beans"))
- (:alist . ((
+ (:alist . ((:size . 3)
+ (:string . "Another String")
+ (:list . ("un" "deux" "trois"))
+ (:another-alist . ((a . "A") (b . "B")))))))
+
+ Note: There are issues related to the construction of
+ documents with non-trivial structure and their translation into
+ corresponding Json data, specifically with regard to confusion
+ between associative lists and
+ sequences. See Issues and Bugs for
+ more information.
+
+
Views are the mechanism with which documents are queried in
@@ -983,6 +1021,47 @@
+
+ CouchDb is a young database server, it is currently in development
+ and not yet feature complete nor are some aspects of its
+ functionality even fully designed or finalized yet. Clouchdb is a
+ new library supporting this database, and it too is still in
+ development. As a result, changes to and bugs in the Clouchdb API
+ should not be unexpected, though I do strive to minimise both.
+
+
+
+ With that in mind, any problems not outlined below should be brought
+ to the author's attention through
+ the clouchdb-devel email list.
+
+
+
@@ -995,6 +1074,5 @@
alt="Valid XHTML 1.0 Strict" height="31" width="88" />
-