[clouchdb-cvs] CVS clouchdb/public_html
peddy
peddy at common-lisp.net
Fri Dec 14 23:22:58 UTC 2007
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 @@
</ul>
<h2><a name="news">News</a></h2>
-<p>
- <ul>
- <li><b>Dec 9, 2007</b> - Version 0.0.4: Updated
- (<a href="#sym-invoke-view">invoke-view</a>) and
- (<a href="#sym-ad-hoc-view">ad-hoc-view</a>) to use all options
- supported by corresponding CouchDb API. Somehow I'd missed
- these before.
- </li>
- <li><b>Nov 28, 2007</b> -
- 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.
- </li>
- </ul>
-</p>
+
+<ul>
+ <li><b>Dec 9, 2007</b> - Version 0.0.4: Updated
+ (<a href="#sym-invoke-view">invoke-view</a>) and
+ (<a href="#sym-ad-hoc-view">ad-hoc-view</a>) to use all options
+ supported by corresponding CouchDb API. Somehow I'd missed
+ these before.
+ </li>
+ <li><b>Nov 28, 2007</b> -
+ 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.
+ </li>
+</ul>
<h2><a name="download">Download and Installation</a></h2>
<p>
@@ -68,15 +67,14 @@
<h3>Requirements:</h3>
-<p>
- <ul>
- <li><a href="http://www.weitz.de/drakma/">Drakma</a></li>
- <li><a href="http://www.cliki.net/cl-json/">cl-json</a></li>
- <li><a href="http://www.cliki.net/Parenscript/">Parenscript</a></li>
- <li><a href="http://www.cliki.net/LIFT/">LIFT</a> testing framework</li>
- <li>An available <a href="http://couchdb.org">CouchDb</a> server, current supported version is 0.7</li>
- </ul>
-</p>
+<ul>
+ <li><a href="http://www.weitz.de/drakma/">Drakma</a></li>
+ <li><a href="http://www.cliki.net/cl-json/">cl-json</a></li>
+ <li><a href="http://www.cliki.net/Parenscript/">Parenscript</a></li>
+ <li><a href="http://www.cliki.net/LIFT/">LIFT</a> testing framework</li>
+ <li>An available <a href="http://couchdb.org">CouchDb</a> server,
+ current minimum supported version is 0.7, now tested on 7.2</li>
+</ul>
<h3>ASDF Install</h3>
@@ -101,13 +99,14 @@
<p>
The clouchdb distribution comes with a unit test suite which uses
the LIFT testing framework. To run the tests, follow the following steps:
+</p>
<pre class="code">
(asdf:oos 'asdf:load-op '#:clouchdb-tests)
(in-package :clouchdb-tests)
(run-all-tests)
</pre>
-</p>
+
<p>
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 @@
</pre>
<p>
Be sure to look at examples.lisp to understand what each example is doing.
-</b>
+</p>
+
+<h3>CVS Access</h3>
+
+<p>
+ Clouchdb project hosting is graciously provided by common-lisp.net,
+ the CVS repository may be checked out anonymously as follows:
+</p>
+
+<pre class="code">
+cvs -z3 -d :pserver:anonymous:anonymous at common-lisp.net:/project/clouchdb/cvsroot co clouchdb
+</pre>
<h2><a name="support">Support and mailing lists</a></h2>
@@ -135,15 +145,17 @@
The following email lists have been provided
by the <a href="http://common-lisp.net">common-lisp.net</a> for
clouchdb development and information:
- <ul>
- <li> <a href="http://common-lisp.net/cgi-bin/mailman/listinfo/clouchdb-announce">
- clouchdb-announce
- </a>
- <li> <a href="http://common-lisp.net/cgi-bin/mailman/listinfo/clouchdb-devel">
- clouchdb-devel
- </a>
- </ul>
</p>
+<ul>
+ <li> <a href="http://common-lisp.net/cgi-bin/mailman/listinfo/clouchdb-announce">
+ clouchdb-announce
+ </a>
+ </li>
+ <li> <a href="http://common-lisp.net/cgi-bin/mailman/listinfo/clouchdb-devel">
+ clouchdb-devel
+ </a>
+ </li>
+</ul>
<h2><a name="examples">Examples</a></h2>
@@ -162,13 +174,13 @@
</p>
<h4>Example 1</h4>
-The following example session demonstrates:
+<p>The following example session demonstrates:</p>
<ul>
- <li> Setting the CouchDb host and database name
- <li> Finding CouchDb server version
- <li> Creation of a database
- <li> Creation of a document in that database
- <li> Fetching a document and adding a new field
+ <li> Setting the CouchDb host and database name</li>
+ <li> Finding CouchDb server version</li>
+ <li> Creation of a database</li>
+ <li> Creation of a document in that database</li>
+ <li> Fetching a document and adding a new field</li>
</ul>
<pre class="code">
@@ -203,14 +215,14 @@
</pre>
<h4>Example 2</h4>
-Demonstrating:
+<p>Demonstrating:</p>
<ul>
- <li> Recreating a database
- <li> Creating a document that uses a CouchDb generated ID
- <li> Updating a document value
- <li> Viewing document revision information
- <li> Fetching an old document revision
- <li> Creating a document with array and map field values
+ <li> Recreating a database</li>
+ <li> Creating a document that uses a CouchDb generated ID</li>
+ <li> Updating a document value</li>
+ <li> Viewing document revision information</li>
+ <li> Fetching an old document revision</li>
+ <li> Creating a document with array and map field values</li>
</ul>
<pre class="code">
@@ -277,14 +289,14 @@
</pre>
<h4>Example 3</h4>
-Demonstrating:
+<p>Demonstrating:</p>
<ul>
- <li> Conditionally creating a database if it does not exist
+ <li> Conditionally creating a database if it does not exist</li>
<li> The use
of <a href="http://www.cliki.net/Parenscript/">Parenscript</a> in
- defining a view
- <li> Invoking persistent views to query database documents
+ defining a view</li>
+ <li> Invoking persistent views to query database documents</li>
</ul>
<pre class="code">
@@ -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 <a href="http://www.cliki.net/Parenscript/">Parenscript</a></li>,
+;; Note: Expressions within the (ps) expressions are <a href="http://www.cliki.net/Parenscript/">Parenscript</a>,
;; a lispy way to generate JavaScript.
CLOUCHDB-USER> <b>(create-view "cities"
(cons "country"
@@ -347,26 +359,34 @@
</pre>
-<h2><a name="reference">API Reference</a></h2
+<h2><a name="reference">API Reference</a></h2>
<h3>Server Connection and Database Management API</h3>
-The functions described in this section are related to the
+<p>
+ The API described in this has to do with managing CouchDb server
+ information and the creation and deletion of databases.
+</p>
-<p/>[Function]<br />
-<a name="sym-create-db"><b>create-db</b></a> &key db-name if-exists
+<p>[Function]<br />
+<a name="sym-create-db"><b>create-db</b></a> &key db-name if-exists
+</p>
<blockquote>
-Create a database. The db-name can be specified, otherwise attempts to
-create the database named in the current context (either through
-(<a href="#sym-set-connection">set-connection</a>) or
-(<a href="#sym-with-connection">with-connection</a>).
-
-<p/> 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.
+<p>
+ Create a database. The db-name can be specified, otherwise attempts
+ to create the database named in the current context (either through
+ (<a href="#sym-set-connection">set-connection</a>) or
+ (<a href="#sym-with-connection">with-connection</a>).
+</p>
+<p>
+ 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.
+</p>
<p>
Example:
+</p>
<pre class="code">
;; 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")
<b>=></b> ((:OK . T) (:IGNORED . T))
</pre>
-<p />
+
</blockquote>
-<p/>[Function]<br />
-<a name="sym-delete-db"><b>delete-db</b></a> &key db-name if-missing
+<p>[Function]<br />
+<a name="sym-delete-db"><b>delete-db</b></a> &key db-name if-missing
+</p>
<blockquote>
+<p>
Delete a database. The db-name can be specified, otherwise attempts to
delete the database named in the current context (either through
(<a href="#sym-set-connection">set-connection</a>) or
-(<a href="#sym-with-connection">with-connection</a>).
-
-<p/> If :ignore is specified for the if-missing parameter, errors
-resulting from the attempt to delete a non-existent database are ignored.
-
+(<a href="#sym-with-connection">with-connection</a>).
+</p>
+<p>
+If :ignore is specified for the if-missing parameter, errors resulting
+from the attempt to delete a non-existent database are ignored.
+</p>
<p>
Example:
+</p>
<pre class="code">
;; 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")
<b>=></b> ((:ERROR . "not_found") (:REASON . "missing"))
</pre>
-<p />
-
-
</blockquote>
-<p/>[Function]<br />
-<a name="sym-get-db-info"><b>get-db-info</b></a> &key db-name
+<p>[Function]<br />
+<a name="sym-get-db-info"><b>get-db-info</b></a> &key db-name
+</p>
<blockquote>
+<p>
Returns database information for the connection and database in the
current context, or, if the db-name key parameter is specified, for
that database.
-<p/>
+</p>
+<p>
Example:
+</p>
<pre class="code">
(get-db-info)
<b>=></b> ((:DB_NAME . "test-db") (:DOC_COUNT . 3) (:UPDATE_SEQ . 4))
</pre>
-<p />
</blockquote>
-<p/>[Function]<br />
+<p>[Function]<br />
<a name="sym-list-dbs"><b>list-dbs</b></a>
+</p>
<blockquote>
-Returns a list of database names available in the current connection.
+ <p>
+ Returns a list of database names available in the current connection.
+ </p>
</blockquote>
-<p/>[Function]<br />
-<a name="sym-set-connection"><b>set-connection</b></a> &key host
+<p>[Function]<br />
+<a name="sym-set-connection"><b>set-connection</b></a> &key host
db-name protocol port => no value
+</p>
<blockquote>
+<p>
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".
-<p />
-See (<a href="#sym-with-connection">with-connection</a>)
+</p>
+<p> See (<a href="#sym-with-connection">with-connection</a>)</p>
</blockquote>
-<p/>[Macro]<br />
-<a name="sym-with-connection"><b>with-connection</b></a> (&key host
-db-name protocol port) &body body => value returned by body
+<p>[Macro]<br />
+<a name="sym-with-connection"><b>with-connection</b></a> (&key host
+db-name protocol port) &body body => value returned by body
+</p>
<blockquote>
+<p>
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.
-<p/>
+</p>
+<p>
Example:
+</p>
<pre class="code">
;; 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")
</pre>
-<p />
-See (<a href="#sym-set-connection">set-connection</a>)
+<p>See (<a href="#sym-set-connection">set-connection</a>)</p>
</blockquote>
-
<h3>Document API</h3>
<p>
@@ -488,6 +519,7 @@
<p>
Special Properties
+</p>
<blockquote>
<p>
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.
-<p />
+</p>
<pre class="code">
(create-document '((:name . "Maxwell Smart") (:agent . 86)) :id "max")
[416 lines skipped]
More information about the clouchdb-cvs
mailing list