The clouchdb Reference Manual

This is the clouchdb Reference Manual, version 0.0.12, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:49:59 2024 GMT+0.

Table of Contents


1 Systems

The main system appears first, followed by any subsystem dependency.


1.1 clouchdb

Version

0.0.12

Dependencies
  • closer-mop (system).
  • drakma (system).
  • parenscript (system).
  • s-base64 (system).
  • flexi-streams (system).
Source

clouchdb.asd.

Child Components

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


2.1 Lisp


2.1.1 clouchdb/clouchdb.asd

Source

clouchdb.asd.

Parent Component

clouchdb (system).

ASDF Systems

clouchdb.

Packages

clouchdb-asd.

Public Interface

*clouchdb-version* (special variable).


2.1.2 clouchdb/package.lisp

Source

clouchdb.asd.

Parent Component

clouchdb (system).

Packages

clouchdb.


2.1.3 clouchdb/clouchdb.lisp

Dependency

package.lisp (file).

Source

clouchdb.asd.

Parent Component

clouchdb (system).

Public Interface
Internals

2.1.4 clouchdb/decoder.lisp

Dependency

clouchdb.lisp (file).

Source

clouchdb.asd.

Parent Component

clouchdb (system).

Public Interface

json-to-document (function).

Internals

2.1.5 clouchdb/encoder.lisp

Dependency

decoder.lisp (file).

Source

clouchdb.asd.

Parent Component

clouchdb (system).

Public Interface

document-to-json (function).

Internals

3 Packages

Packages are listed by definition order.


3.1 clouchdb

Source

package.lisp.

Use List
  • common-lisp.
  • parenscript.
Public Interface
Internals

3.2 clouchdb-asd

Source

clouchdb.asd.

Use List
  • asdf/interface.
  • common-lisp.
Public Interface

*clouchdb-version* (special variable).


4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


4.1 Public Interface


4.1.1 Special variables

Special Variable: *clouchdb-version*

The current version of clouchdb

Package

clouchdb-asd.

Source

clouchdb.asd.

Special Variable: *couchdb*

A db struct object

Package

clouchdb.

Source

clouchdb.lisp.


4.1.2 Macros

Macro: ps-view ((&optional view-name) &body body)

Create a view using parenscript

Package

clouchdb.

Source

clouchdb.lisp.

Macro: with-attachment ((stream doc-or-id attachment) &body body)

Passed doc-or-id and attachment parameters to get-attachment-stream to open the input stream and ensures that the stream is automatically closed after execution of the statements in the body.

Package

clouchdb.

Source

clouchdb.lisp.

Macro: with-connection ((&rest args &key db name port protocol host user password document-update-fn document-fetch-fn) &body body)

Execute body in the context of the specified database connection information..

Package

clouchdb.

Source

clouchdb.lisp.

Macro: with-temp-db (&body body)

Execute body in context of newly created, temporary database. Delete database before return.

Package

clouchdb.

Source

clouchdb.lisp.


4.1.3 Ordinary functions

Function: ad-hoc-view (view &rest options &key key start-key start-key-docid end-key end-key-docid limit stale descending skip group group-level reduce include-docs language)

Execute query using an ad-hoc view.

Package

clouchdb.

Source

clouchdb.lisp.

Function: add-attachment (doc-or-id content &key name revision content-type)

Attach content to a document identified by either the id or doc parameter. If the document does not already exist it will be created.

Package

clouchdb.

Source

clouchdb.lisp.

Function: all-docs-by-seq (&rest options &key key keys start-key start-key-docid end-key end-key-docid limit stale descending skip group group-level reduce include-docs)

Fetch a list of all documents that were updated and deleted, in the order these actions are done.

Package

clouchdb.

Source

clouchdb.lisp.

Function: as-deleted-document (doc)

Return specified document in a format used by bulk-document-update to indicate that the document should be deleted in the bulk operation.

Package

clouchdb.

Source

clouchdb.lisp.

Function: as-field-name-string (value)

Convert a case-encoded symbol to a potentially mixed case string.

Package

clouchdb.

Source

clouchdb.lisp.

Function: 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

Package

clouchdb.

Source

clouchdb.lisp.

Function: attachment-list (doc-or-id &key fetch)

List attachments associated with document. If the document id is specified in the first parameter then this function will fetch the corresponding document from the server in order to get the attachment list, otherwise it will simply return the list of attachments in the specified document unless keyword parameter fetch is true.

Package

clouchdb.

Source

clouchdb.lisp.

Function: attachment-name (attachment)

Return the name of an attachment, possibly converting from the keyword symbol of the clouchdb document to a string e.g. :|text.txt| to ’text.txt’, or the car of a single document attachment list element e.g, ’(:|text.txt| (:|stub| . T) (..)) to ’text.txt’.

Package

clouchdb.

Source

clouchdb.lisp.

Function: bulk-document-update (docs &key all-or-nothing)

Update multiple documents in a single request. The <b>docs</b> parameter is a list of documents. Any document in the list that does not contain an :|_id| value is created with a CouchDb assigned ID. Documents that contain a ’(:|_deleted| . t) top-level property will be deleted. Documents that contain an :|_id| property will be updated. If all-or-nothing is true then all operations must succeed for any to succeed, default is false.

Package

clouchdb.

Source

clouchdb.lisp.

Function: changes (&rest options &key db feed since style heartbeat timeout filter notify-fn include-docs)

Get document change activity from current database or database specified in db parameter. The :feed keyword parameter value indicates how to poll for changes. Valid values for this parameter
include :longpoll to block waiting for a single change
response, :continuous to poll for changes indefinately, or :normal to not poll (the default) and instead return a document containing changes. If specified, the :style keyword parameter may be either :main-only (the default) or :all-docs for more revision information.

If specified, the notify-fn will be called as each change notification is recieved from the server. The notify-fn should return nil to signal that it no longer wishes to receive change notificaitons. At that point the stream will be closed and the changes function will return.

If :longpoll or :continuous is specified as the feed parameter but no notify-fn is provided, this function will return the feed stream. It is the caller’s responsibility to close the stream.

Package

clouchdb.

Source

clouchdb.lisp.

Function: compact-db (&key db)

Start compaction on current database, or specified database if supplied. The db parameter, if supplied, is either a local database name string or a db struct.

Package

clouchdb.

Source

clouchdb.lisp.

Function: copy-document (source destination &key revision)

Copy source document to destination. The source parameter may be either a document ID or a document from which the ID will be obtained. The destination parameter may also be a document ID or document. If the destination document does not already exist it will be created.

If the destination document does exist and the intention is to overwrite that document, then the destination document revision must be specified. If the destination parameter is a document then the revision information will be taken from that document unless
the :revision parameter is specified. The revision parameter must be the current revision of the destination document. Alternatively the revision parameter may be the keyword
:current which will cause this function to fetch the current revision number from the database.

Package

clouchdb.

Source

clouchdb.lisp.

Function: couchdb-document-properties (document)

Return only CouchDb specific document properties (opposite of document-properties).

Package

clouchdb.

Source

clouchdb.lisp.

Function: create-db (&key db if-exists)

Create database. The db parameter may be either a string which is the name of the database to create or an instance of a db structure. If db is unspecified, uses *couchdb*. If database already exists an error condition is raised. This condition can be avoided by specifying :ingore for if-exists. In this case no error condition is generated. Specify :recreate to potentially delete and create a new database.

Package

clouchdb.

Source

clouchdb.lisp.

Function: create-document (doc &key id attachments)

Create a new document, optionally specifying the new document ID.

Package

clouchdb.

Source

clouchdb.lisp.

Function: create-ps-view (id &rest view-defs)

Create one or more views in the specified view document ID.

Package

clouchdb.

Source

clouchdb.lisp.

Function: create-temp-db (&key db-name-creator)

Create a temporary database.

Package

clouchdb.

Source

clouchdb.lisp.

Function: create-temp-db-name ()

Return a database name that’s probably unique.

Package

clouchdb.

Source

clouchdb.lisp.

Function: create-view (id view &key language)

Create one or more views in the specified view document ID.

Package

clouchdb.

Source

clouchdb.lisp.

Reader: db-document-fetch-fn (instance)
Writer: (setf db-document-fetch-fn) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

document-fetch-fn.

Reader: db-document-update-fn (instance)
Writer: (setf db-document-update-fn) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

document-update-fn.

Reader: db-host (instance)
Writer: (setf db-host) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

host.

Reader: db-name (instance)
Writer: (setf db-name) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

name.

Reader: db-password (instance)
Writer: (setf db-password) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

password.

Reader: db-port (instance)
Writer: (setf db-port) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

port.

Reader: db-protocol (instance)
Writer: (setf db-protocol) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

protocol.

Reader: db-user (instance)
Writer: (setf db-user) (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Target Slot

user.

Function: delete-attachment (doc-or-id attachment &key revision)

Delete (detach) an attachment. The attachment parameter is either the name of the file to remove from the document, which can be either a string or a keyword symbol (as obtained from the :|_attachments| value of a document) or it’s one element of the list of attachments in a document.

Package

clouchdb.

Source

clouchdb.lisp.

Function: delete-db (&key db if-missing)

Delete database. If db and db-name are unspecified, deletes
database named in *couchdb*. Normally deletion of non-existent databases generates an error condition, but this can be avoided by
specifying :ignore in the if-missing parameter.

Package

clouchdb.

Source

clouchdb.lisp.

Function: delete-document (doc-or-id &key revision if-missing)

Delete a document. The doc-or-id parameter may be either the document ID or the document itself. If the doc-or-id value is the document ID and no revision parameter is specified, then the document is fetched from the server to get the current revision, since the revision is necessary to complete the operation. If the doc-or-id value is a document then the revision value in the document is used unless a different revision is specified. At most one revision of the document will be deleted.

Package

clouchdb.

Source

clouchdb.lisp.

Function: delete-view (id &key revision if-missing)

Delete identified view document

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-as-hash (doc)

Convert a document to a hashtable if it isn’t one already. Document should be in the form of an associative list.

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-id (doc)

Shortcut for getting the ID from the specified document. First checks for :|_id| property, then :|id|

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-properties (document)

Return the document properties, filtering out any couchdb reserved properties (properties that start with an underscore).

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-property (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. The <b>name</b> parameter may be either a single keyword identifier (document property identifier) or it may be a list of identifiers.

Package

clouchdb.

Source

clouchdb.lisp.

Function: (setf document-property) (name doc)

Allows setting of existing document properties in
place (destructively). The name paramter may be either a single keyword identifier (document property identifier) or it may be a list of identifiers. If the specified document property does not already exist it is created.

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-revision (doc-or-id)

Return the revision number for the document, identified by either the document ID, the actual document, or the result of an add or update that returns the revision as :|rev|

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-to-json (doc)

Encode document to string with special support for detecting and handling associative lists.

Package

clouchdb.

Source

encoder.lisp.

Function: get-active-tasks (&optional db)

Get active tasks for database or nil.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-all-documents (&rest options &key key keys start-key start-key-docid end-key end-key-docid limit stale descending skip group group-level reduce include-docs)

Get a listing of all documents in a database. This method implements the same keyword parameters as the view API.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-attachment-stream (doc-or-id attachment &key force-binary)

Get specified attachment as a stream. The caller is responsible for closing the stream. Return stream and HTTP status

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-config (&key db section option)

Get database configuration.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-couchdb-info (&key db)

Get information from the couchdb server.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-db-info (&key db)

Get information for named database, return ((:|error|
. "not_found") (:|reason| . "no_db_file")) if database does not exist. The db parameter, if supplied, is either a local database name string or a db struct.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-document (id &key revision revisions conflicts revision-info if-missing)

Get a document by ID. Returns nil if the document does not exist. The revision property specifies an optional revision number, if unspecified, the most recent revision is returned. The revisions and revision-info parameters, if non-nil, request revision information about the document instead of the actual document contents. The revision-info option contains more revision information than revisions. All revision* options are mutually exclusive, specify only one.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-uuids (&key count db)

Returns one or more new UUID from the current database.

Package

clouchdb.

Source

clouchdb.lisp.

Function: invoke-view (id view &rest options &key key start-key start-key-docid end-key end-key-docid limit stale descending skip group group-level reduce include-docs)

Invoke a view by specifiying the document ID that contains the 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.

Package

clouchdb.

Source

clouchdb.lisp.

Function: json-to-document (json-string)
Package

clouchdb.

Source

decoder.lisp.

Function: list-dbs (&optional db)

Return a list of all databases managed by the current CouchDb host.

Package

clouchdb.

Source

clouchdb.lisp.

Function: make-db (&key host port name protocol user password document-fetch-fn document-update-fn db)

Create, populate and return a database structure from the current special variables and any supplied keyword parameters, the latter take precedence over the special variables.

Package

clouchdb.

Source

clouchdb.lisp.

Function: post-document (doc)

Post the document to the server, creating a new document. An existing _id in the document will be ignored, the server will create a new document and assign a new ID. Therefore this is an easy method for copying documents. The return value includes the document ID in the :ID property.

Package

clouchdb.

Source

clouchdb.lisp.

Function: put-document (doc &key id attachments)

Create a new document or update and existing one. If the document is new an ID must be specified (but see post-document). If the document has been fetched from the server (and still has its :_id property) then no ID need be specified. If an ID is specified and it differs from the existing :_id value, then a new document is created with the new ID and the non-special properties of the specified document, since the latter would generate a CouchDb error.

Package

clouchdb.

Source

clouchdb.lisp.

Function: query-document (query doc)

Return a list of all values in the document matching the query. For example, given the document:

((:values (((:a . 1) (:b . 2)) ((:a . 3) (:b . 4)))))

the query string ’(:values :a) will return (3 1), i.e. the value of both :a associations.

One special query input value is :* which is a ’wildcard’. With the document described above the query ’(:values :*) will return (4 3 2 1), or the values of all associations directly below :values. The query ’(:* :*) on this document will also return (4 3 2 1).

Another special query input value is :**, which recursively matches the next query input. For example, with the following document:

((:level1 . ((:level2 . (((:level3 . 1)))))))

The query ’(:** :level3) will return (1), the value
of :level3. Finally, functions can specified in the query. Functions are called with the portion of the document matched to the previous query element and can either return the document, return a different document or null.

Package

clouchdb.

Source

clouchdb.lisp.

Function: replicate (target &key source create-target)

Replicate current database to target, or source to target if source is specified. Source and target database values must either be strings or database structures. Use strings to specify simple local database names, use database structures to specify either local or remote databases. If true, create-target will cause the replication target to be created automatically, as of CouchDb version 0.11.

Package

clouchdb.

Source

clouchdb.lisp.

Function: save-attachment (doc-or-id attachment path &key if-does-not-exist if-exists)

Save specified attachement from specified document to path on file system. The doc-or-id parameter must either be a document ID string or the actual document. The attachment parameter is either the string value of the attachment name, e.g. "file.jpg", a keyword symbol as returned in the car of the list of attachments, .e.g. :|file.jsp|, or one of the elements of a document’s attachment list,
e.g: (:|file.jsp| (:|stub| . T) (:|content_type|
. "image/jpeg") (:|length| . 3543434)).

If the path identifies a directory then the target file will be created in that directory with the same name as the attachment in the document. If the path ends with a file name the attachment will be created with that name.

Package

clouchdb.

Source

clouchdb.lisp.

Function: set-connection (&rest args &key host port name protocol user password document-fetch-fn document-update-fn db)

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.

Package

clouchdb.

Source

clouchdb.lisp.

Function: set-document-property (doc &rest args)

Set a property of a document. If the named property does not exist, add it to the document, otherwise change the existing value. Does not destructively modify input document, so be sure to use return value.

Package

clouchdb.

Source

clouchdb.lisp.


4.1.4 Conditions

Condition: attachment-missing

Error raised when specified attachment is not found

Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Direct methods
Direct slots
Slot: attachment-name
Initargs

:attachment-name

Readers

att-name.

Writers

This slot is read-only.

Slot: attachments
Initargs

:attachments

Readers

attachments.

Writers

This slot is read-only.

Condition: db-already-exists
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

db-existential-error.

Condition: db-does-not-exist
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

db-existential-error.

Condition: db-existential-error
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

clouchdb-error.

Direct subclasses
Direct methods
Direct slots
Slot: text
Initargs

:uri

Readers

uri.

Writers

This slot is read-only.

Slot: db
Initargs

:db

Readers

db.

Writers

This slot is read-only.

Slot: result
Initargs

:result

Readers

result.

Writers

This slot is read-only.

Condition: doc-error
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

clouchdb-error.

Direct subclasses
Direct methods
Direct slots
Slot: text
Initargs

:uri

Readers

text.

Writers

This slot is read-only.

Slot: reason
Initargs

:reason

Readers

reason.

Writers

This slot is read-only.

Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Condition: document-missing

Error raised when no document matching ID is found

Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Condition: id-missing
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Condition: id-or-revision-conflict
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Condition: illegal-database-name
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

db-existential-error.


4.2 Internals


4.2.1 Constants

Constant: +utf-8+

Default external format for document content.

Package

clouchdb.

Source

clouchdb.lisp.


4.2.2 Special variables

Special Variable: *changes-options*

Parameters for the changes function.

Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *debug-requests*
Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *default-content-type*
Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *default-db-name*

Default database name

Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *default-host*

CouchDb server host name

Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *default-port*

The IANA assigned CouchDb port

Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *default-protocol*

http or https

Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *digits*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-lisp-escaped-chars*
Package

clouchdb.

Source

encoder.lisp.

Special Variable: *json-make-big-number*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-number-valid-chars*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-object-factory*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-object-factory-add-key-value*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-object-factory-return*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-rules*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *json-symbols-package*

The package where json-symbols are interned. Default keyword, nil = current package

Package

clouchdb.

Source

decoder.lisp.

Special Variable: *temp-db-counter*
Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *text-types*

Defined to instruct Drakma to treat json responses as text

Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *use-strict-json-rules*
Package

clouchdb.

Source

decoder.lisp.

Special Variable: *view-function-names*
Package

clouchdb.

Source

clouchdb.lisp.

Special Variable: *view-options*

Definitions for how invoke-view keyword parameters are translated into CouchDb parameters

Package

clouchdb.

Source

clouchdb.lisp.


4.2.3 Macros

Macro: cat (&rest rest)

Shorthand for (concatenate ’string)

Package

clouchdb.

Source

clouchdb.lisp.

Macro: db-or-db-name (db)
Package

clouchdb.

Source

clouchdb.lisp.

Macro: define-constant (name value &optional doc)

A version of DEFCONSTANT for /strict/ CL implementations.

Package

clouchdb.

Source

clouchdb.lisp.

Macro: defpsfun (&body body)

Define a parenscript function in the object format used by CouchDb. Specifically, a property name associated with a lambda. E.g.: {’foo’ : function () {...}}

Package

clouchdb.

Source

clouchdb.lisp.

Macro: ensure-db (&body body)

Wrap request in code to check for errors due to non-existant data bases. This is necessary because in a document operation, CouchDb does not distinguish between an error due to a missing document and a missing database.

Package

clouchdb.

Source

clouchdb.lisp.

Macro: ps-function (&body body)

Create a view using parenscript

Package

clouchdb.

Source

clouchdb.lisp.

Macro: url-encode (string)

URL-encode a string. Use drakma’s url-encode since it’s exported now

Package

clouchdb.

Source

clouchdb.lisp.


4.2.4 Ordinary functions

Function: add-admin (name password &key db)

Add an admin user.

Package

clouchdb.

Source

clouchdb.lisp.

Function: add-functions (design-doc-id type &rest list-defs)

Add lists in list-defs to design document identified by design-doc-id. If the document does not exist, create it. If any list function definitions already exist in the document, update them.

Package

clouchdb.

Source

clouchdb.lisp.

Function: add-json-dispatch-rule (character fn)
Package

clouchdb.

Source

decoder.lisp.

Function: add-lists-fns (id &rest defs)

Add CouchDb lists in list-defs to document identified by id. If the document does not exist, create it. If any list function definitions already exist in the document, update them.

Package

clouchdb.

Source

clouchdb.lisp.

Function: add-shows-fns (id &rest defs)

Add CouchDb lists in list-defs to document identified by id. If the document does not exist, create it. If any list function definitions already exist in the document, update them.

Package

clouchdb.

Source

clouchdb.lisp.

Function: assoclp (e)

Return true if expression is, or really looks like, an associative list. Dead giveaways include cons elements in the list that begin with a keyword. Returns the element that produced a positive result, or nil.

Package

clouchdb.

Source

encoder.lisp.

Function: compact-view (view-name)

Compact named view

Package

clouchdb.

Source

clouchdb.lisp.

Function: convert-encoding (string encoding)

Convert string to specified encoding. This may be totally wrong and probably way too inefficient, but it seems to work.

Package

clouchdb.

Source

clouchdb.lisp.

Function: copy-db (instance)
Package

clouchdb.

Source

clouchdb.lisp.

Function: couchdb-database-url (db)
Package

clouchdb.

Source

clouchdb.lisp.

Function: couchdb-host-url (db)
Package

clouchdb.

Source

clouchdb.lisp.

Function: db-p (object)
Package

clouchdb.

Source

clouchdb.lisp.

Function: db-request (uri &rest args &key &allow-other-keys)

Used by most Clouchdb APIs to make the actual REST request.

Package

clouchdb.

Source

clouchdb.lisp.

Function: decode-json (&optional stream)

Reads a json element from stream

Package

clouchdb.

Source

decoder.lisp.

Function: decode-json-strict (&optional stream)

Only objects or arrays on top level, no junk afterwards.

Package

clouchdb.

Source

decoder.lisp.

Function: doc-as-alist (doc)

Convert a document in the form of a hash table into an associative list

Package

clouchdb.

Source

clouchdb.lisp.

Function: document-to-json-stream (doc stream)

Encode document to stream with special support for detecting and handling associative lists.

Package

clouchdb.

Source

encoder.lisp.

Function: document-update-notify (fn doc)

Optionally invoke specified function with supplied document, used to invoke user-specified hook functions.

Package

clouchdb.

Source

clouchdb.lisp.

Function: doublequote (value)

Wrap specified value in double quotes.

Package

clouchdb.

Source

clouchdb.lisp.

Function: encode (d stream)
Package

clouchdb.

Source

encoder.lisp.

Function: encode-attachments (attachments)

Encode the list of attachements, return them in an _attachments document fragment.

Package

clouchdb.

Source

clouchdb.lisp.

Function: encode-file (file)

Encode a file in the format suitable for CouchDb attachments

Package

clouchdb.

Source

clouchdb.lisp.

Function: ensure-design-doc (id)

Return specified design document, creating it if it does not already exist.

Package

clouchdb.

Source

clouchdb.lisp.

Function: false-if-false (value)

Return "false" if value is nil, otherwise nil

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-session (&optional db)

Get cookie based login user information.

Package

clouchdb.

Source

clouchdb.lisp.

Function: get-stats (&optional db)

Get database statistics overview.

Package

clouchdb.

Source

clouchdb.lisp.

Function: invoke-list (doc-id list-id)
Package

clouchdb.

Source

clouchdb.lisp.

Function: json-escaped-char-to-lisp (json-escaped-char)
Package

clouchdb.

Source

decoder.lisp.

Function: json-intern (string)
Package

clouchdb.

Source

decoder.lisp.

Function: json-stream-or-string-to-document (stream-or-string)

Read a json document from eiter a stream or a string. If the source is a stream close the stream before returning. Return a document.

Package

clouchdb.

Source

clouchdb.lisp.

Function: keyword-assocp (e)

Return true if element is a list that begins with a keyword. This is used to help determine associative list-ness.

Package

clouchdb.

Source

encoder.lisp.

Function: keyword-to-http-param (keyword-symbol)

Convert a keword symbol that may contain hyphen characters to a lower case string with any hyphens replaced by underscores: ’:all-the-best’ -> ’all_the_best’.

Package

clouchdb.

Source

clouchdb.lisp.

Function: lisp-special-char-to-json (lisp-char)
Package

clouchdb.

Source

encoder.lisp.

Function: logout-session (&optional db)

Logout cookie based session.

Package

clouchdb.

Source

clouchdb.lisp.

Function: make-db-auth (db)

Return user name password values or nil if no user name specified for db

Package

clouchdb.

Source

clouchdb.lisp.

Function: make-db-identifier (input)

Make a database identifier from either a string or db structure.

Package

clouchdb.

Source

clouchdb.lisp.

Function: make-default-db ()
Package

clouchdb.

Source

clouchdb.lisp.

Function: make-uri (&rest rest)

Return a URI containing protocol://host:port/ and the concatenation of the remaining parameters.

Package

clouchdb.

Source

clouchdb.lisp.

Function: new-db (&key host port name protocol user password document-fetch-fn document-update-fn)
Package

clouchdb.

Source

clouchdb.lisp.

Function: read-chars-until (stream &key terminator-fn char-converter)
Package

clouchdb.

Source

decoder.lisp.

Function: read-constant (stream expected-string ret-value)
Package

clouchdb.

Source

decoder.lisp.

Function: read-json-array (stream)
Package

clouchdb.

Source

decoder.lisp.

Function: read-json-chars (stream terminators)
Package

clouchdb.

Source

decoder.lisp.

Function: read-json-number (stream)
Package

clouchdb.

Source

decoder.lisp.

Function: read-json-object (stream)
Package

clouchdb.

Source

decoder.lisp.

Function: read-json-string (stream)
Package

clouchdb.

Source

decoder.lisp.

Function: read-n-chars (stream n)
Package

clouchdb.

Source

decoder.lisp.

Function: set-session (&optional db)

Do cookie based login.

Package

clouchdb.

Source

clouchdb.lisp.

Function: string-join (list &key delim ignore-nil)

Join list of strings into a single result. Strings are delimited by specified delimiter. If ignore-nil is true, then nil strings in the list are skipped, and no delimiter is output.

Package

clouchdb.

Source

clouchdb.lisp.

Function: 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.

Package

clouchdb.

Source

clouchdb.lisp.

Function: 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.

Package

clouchdb.

Source

clouchdb.lisp.

Function: true-if-true (value)

Return "true" if value is non-nil, otherwise nil

Package

clouchdb.

Source

clouchdb.lisp.

Function: validate-ps-view (defun fn-name fn-param fn-body)

Validation for ps-view definition

Package

clouchdb.

Source

clouchdb.lisp.

Function: value-as-integer (value)
Package

clouchdb.

Source

clouchdb.lisp.

Function: value-as-string (value)
Package

clouchdb.

Source

clouchdb.lisp.

Function: view-cleanup ()

Clean up old view data

Package

clouchdb.

Source

clouchdb.lisp.

Function: view-util (cmd)

General function called by view functions

Package

clouchdb.

Source

clouchdb.lisp.

Function: write-alist (d stream)
Package

clouchdb.

Source

encoder.lisp.

Function: write-json-chars (s stream)
Package

clouchdb.

Source

encoder.lisp.

Function: write-json-number (nr stream)
Package

clouchdb.

Source

encoder.lisp.

Function: write-json-string (s stream)
Package

clouchdb.

Source

encoder.lisp.

Function: write-json-symbol (symbol stream)
Package

clouchdb.

Source

encoder.lisp.

Function: write-list (d stream)
Package

clouchdb.

Source

encoder.lisp.


4.2.5 Generic functions

Generic Reader: att-name (condition)
Package

clouchdb.

Methods
Reader Method: att-name ((condition attachment-missing))
Source

clouchdb.lisp.

Target Slot

attachment-name.

Generic Reader: attachments (condition)
Package

clouchdb.

Methods
Reader Method: attachments ((condition attachment-missing))
Source

clouchdb.lisp.

Target Slot

attachments.

Generic Reader: db (condition)
Package

clouchdb.

Methods
Reader Method: db ((condition db-existential-error))
Source

clouchdb.lisp.

Target Slot

db.

Reader Method: db ((condition authorization-error))
Source

clouchdb.lisp.

Target Slot

db.

Generic Reader: description (condition)
Package

clouchdb.

Methods
Reader Method: description ((condition invalid-type))
Source

clouchdb.lisp.

Target Slot

description.

Generic Reader: id (condition)
Package

clouchdb.

Methods
Reader Method: id ((condition doc-error))
Source

clouchdb.lisp.

Target Slot

id.

Generic Reader: id-value (condition)
Package

clouchdb.

Methods
Reader Method: id-value ((condition invalid-id))
Source

clouchdb.lisp.

Target Slot

id-value.

Generic Reader: input (condition)
Package

clouchdb.

Methods
Reader Method: input ((condition invalid-type))
Source

clouchdb.lisp.

Target Slot

input.

Generic Reader: ps-view-def (condition)
Package

clouchdb.

Methods
Reader Method: ps-view-def ((condition ps-view-def-error))
Source

clouchdb.lisp.

Target Slot

ps-view-def.

Generic Reader: reason (condition)
Package

clouchdb.

Methods
Reader Method: reason ((condition doc-error))
Source

clouchdb.lisp.

Target Slot

reason.

Generic Reader: result (condition)
Package

clouchdb.

Methods
Reader Method: result ((condition db-existential-error))
Source

clouchdb.lisp.

Target Slot

result.

Reader Method: result ((condition authorization-error))
Source

clouchdb.lisp.

Target Slot

result.

Generic Reader: text (condition)
Package

clouchdb.

Methods
Reader Method: text ((condition doc-error))
Source

clouchdb.lisp.

Target Slot

text.

Reader Method: text ((condition authorization-error))
Source

clouchdb.lisp.

Target Slot

text.

Generic Reader: uri (condition)
Package

clouchdb.

Methods
Reader Method: uri ((condition db-existential-error))
Source

clouchdb.lisp.

Target Slot

text.

Reader Method: uri ((condition authorization-error))
Source

clouchdb.lisp.

Target Slot

uri.

Generic Reader: value (condition)
Package

clouchdb.

Methods
Reader Method: value ((condition invalid-document))
Source

clouchdb.lisp.

Target Slot

value.


4.2.6 Conditions

Condition: authorization-error
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

clouchdb-error.

Direct methods
Direct slots
Slot: result
Initargs

:result

Readers

result.

Writers

This slot is read-only.

Slot: db
Initargs

:db

Readers

db.

Writers

This slot is read-only.

Slot: uri
Initargs

:uri

Readers

uri.

Writers

This slot is read-only.

Slot: text
Initargs

:text

Readers

text.

Writers

This slot is read-only.

Condition: clouchdb-error

The base type of all errors signaled by clouchdb

Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

error.

Direct subclasses
Condition: invalid-design-doc
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Condition: invalid-document
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Direct methods

value.

Direct slots
Slot: value
Initargs

:value

Readers

value.

Writers

This slot is read-only.

Condition: invalid-id
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

doc-error.

Direct methods

id-value.

Direct slots
Slot: id-value
Initargs

:id-value

Readers

id-value.

Writers

This slot is read-only.

Condition: invalid-type
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

clouchdb-error.

Direct methods
Direct slots
Slot: input
Initargs

:input

Readers

input.

Writers

This slot is read-only.

Slot: description
Initargs

:description

Readers

description.

Writers

This slot is read-only.

Condition: json-parse-error
Package

clouchdb.

Source

decoder.lisp.

Direct superclasses

error.

Condition: ps-view-def-error

Error raised for invalid ps-view definition

Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

clouchdb-error.

Direct methods

ps-view-def.

Direct slots
Slot: ps-view-def
Initargs

:ps-view-def

Readers

ps-view-def.

Writers

This slot is read-only.


4.2.7 Structures

Structure: db
Package

clouchdb.

Source

clouchdb.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: host
Readers

db-host.

Writers

(setf db-host).

Slot: port
Readers

db-port.

Writers

(setf db-port).

Slot: name
Readers

db-name.

Writers

(setf db-name).

Slot: protocol
Readers

db-protocol.

Writers

(setf db-protocol).

Slot: user
Readers

db-user.

Writers

(setf db-user).

Slot: password
Readers

db-password.

Writers

(setf db-password).

Slot: document-fetch-fn
Readers

db-document-fetch-fn.

Writers

(setf db-document-fetch-fn).

Slot: document-update-fn
Readers

db-document-update-fn.

Writers

(setf db-document-update-fn).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   I   J   K   L   M   N   P   Q   R   S   T   U   V   W  
Index Entry  Section

(
(setf db-document-fetch-fn): Public ordinary functions
(setf db-document-update-fn): Public ordinary functions
(setf db-host): Public ordinary functions
(setf db-name): Public ordinary functions
(setf db-password): Public ordinary functions
(setf db-port): Public ordinary functions
(setf db-protocol): Public ordinary functions
(setf db-user): Public ordinary functions
(setf document-property): Public ordinary functions

A
ad-hoc-view: Public ordinary functions
add-admin: Private ordinary functions
add-attachment: Public ordinary functions
add-functions: Private ordinary functions
add-json-dispatch-rule: Private ordinary functions
add-lists-fns: Private ordinary functions
add-shows-fns: Private ordinary functions
all-docs-by-seq: Public ordinary functions
as-deleted-document: Public ordinary functions
as-field-name-string: Public ordinary functions
as-keyword-symbol: Public ordinary functions
assoclp: Private ordinary functions
att-name: Private generic functions
att-name: Private generic functions
attachment-list: Public ordinary functions
attachment-name: Public ordinary functions
attachments: Private generic functions
attachments: Private generic functions

B
bulk-document-update: Public ordinary functions

C
cat: Private macros
changes: Public ordinary functions
compact-db: Public ordinary functions
compact-view: Private ordinary functions
convert-encoding: Private ordinary functions
copy-db: Private ordinary functions
copy-document: Public ordinary functions
couchdb-database-url: Private ordinary functions
couchdb-document-properties: Public ordinary functions
couchdb-host-url: Private ordinary functions
create-db: Public ordinary functions
create-document: Public ordinary functions
create-ps-view: Public ordinary functions
create-temp-db: Public ordinary functions
create-temp-db-name: Public ordinary functions
create-view: Public ordinary functions

D
db: Private generic functions
db: Private generic functions
db: Private generic functions
db-document-fetch-fn: Public ordinary functions
db-document-update-fn: Public ordinary functions
db-host: Public ordinary functions
db-name: Public ordinary functions
db-or-db-name: Private macros
db-p: Private ordinary functions
db-password: Public ordinary functions
db-port: Public ordinary functions
db-protocol: Public ordinary functions
db-request: Private ordinary functions
db-user: Public ordinary functions
decode-json: Private ordinary functions
decode-json-strict: Private ordinary functions
define-constant: Private macros
defpsfun: Private macros
delete-attachment: Public ordinary functions
delete-db: Public ordinary functions
delete-document: Public ordinary functions
delete-view: Public ordinary functions
description: Private generic functions
description: Private generic functions
doc-as-alist: Private ordinary functions
document-as-hash: Public ordinary functions
document-id: Public ordinary functions
document-properties: Public ordinary functions
document-property: Public ordinary functions
document-revision: Public ordinary functions
document-to-json: Public ordinary functions
document-to-json-stream: Private ordinary functions
document-update-notify: Private ordinary functions
doublequote: Private ordinary functions

E
encode: Private ordinary functions
encode-attachments: Private ordinary functions
encode-file: Private ordinary functions
ensure-db: Private macros
ensure-design-doc: Private ordinary functions

F
false-if-false: Private ordinary functions
Function, (setf db-document-fetch-fn): Public ordinary functions
Function, (setf db-document-update-fn): Public ordinary functions
Function, (setf db-host): Public ordinary functions
Function, (setf db-name): Public ordinary functions
Function, (setf db-password): Public ordinary functions
Function, (setf db-port): Public ordinary functions
Function, (setf db-protocol): Public ordinary functions
Function, (setf db-user): Public ordinary functions
Function, (setf document-property): Public ordinary functions
Function, ad-hoc-view: Public ordinary functions
Function, add-admin: Private ordinary functions
Function, add-attachment: Public ordinary functions
Function, add-functions: Private ordinary functions
Function, add-json-dispatch-rule: Private ordinary functions
Function, add-lists-fns: Private ordinary functions
Function, add-shows-fns: Private ordinary functions
Function, all-docs-by-seq: Public ordinary functions
Function, as-deleted-document: Public ordinary functions
Function, as-field-name-string: Public ordinary functions
Function, as-keyword-symbol: Public ordinary functions
Function, assoclp: Private ordinary functions
Function, attachment-list: Public ordinary functions
Function, attachment-name: Public ordinary functions
Function, bulk-document-update: Public ordinary functions
Function, changes: Public ordinary functions
Function, compact-db: Public ordinary functions
Function, compact-view: Private ordinary functions
Function, convert-encoding: Private ordinary functions
Function, copy-db: Private ordinary functions
Function, copy-document: Public ordinary functions
Function, couchdb-database-url: Private ordinary functions
Function, couchdb-document-properties: Public ordinary functions
Function, couchdb-host-url: Private ordinary functions
Function, create-db: Public ordinary functions
Function, create-document: Public ordinary functions
Function, create-ps-view: Public ordinary functions
Function, create-temp-db: Public ordinary functions
Function, create-temp-db-name: Public ordinary functions
Function, create-view: Public ordinary functions
Function, db-document-fetch-fn: Public ordinary functions
Function, db-document-update-fn: Public ordinary functions
Function, db-host: Public ordinary functions
Function, db-name: Public ordinary functions
Function, db-p: Private ordinary functions
Function, db-password: Public ordinary functions
Function, db-port: Public ordinary functions
Function, db-protocol: Public ordinary functions
Function, db-request: Private ordinary functions
Function, db-user: Public ordinary functions
Function, decode-json: Private ordinary functions
Function, decode-json-strict: Private ordinary functions
Function, delete-attachment: Public ordinary functions
Function, delete-db: Public ordinary functions
Function, delete-document: Public ordinary functions
Function, delete-view: Public ordinary functions
Function, doc-as-alist: Private ordinary functions
Function, document-as-hash: Public ordinary functions
Function, document-id: Public ordinary functions
Function, document-properties: Public ordinary functions
Function, document-property: Public ordinary functions
Function, document-revision: Public ordinary functions
Function, document-to-json: Public ordinary functions
Function, document-to-json-stream: Private ordinary functions
Function, document-update-notify: Private ordinary functions
Function, doublequote: Private ordinary functions
Function, encode: Private ordinary functions
Function, encode-attachments: Private ordinary functions
Function, encode-file: Private ordinary functions
Function, ensure-design-doc: Private ordinary functions
Function, false-if-false: Private ordinary functions
Function, get-active-tasks: Public ordinary functions
Function, get-all-documents: Public ordinary functions
Function, get-attachment-stream: Public ordinary functions
Function, get-config: Public ordinary functions
Function, get-couchdb-info: Public ordinary functions
Function, get-db-info: Public ordinary functions
Function, get-document: Public ordinary functions
Function, get-session: Private ordinary functions
Function, get-stats: Private ordinary functions
Function, get-uuids: Public ordinary functions
Function, invoke-list: Private ordinary functions
Function, invoke-view: Public ordinary functions
Function, json-escaped-char-to-lisp: Private ordinary functions
Function, json-intern: Private ordinary functions
Function, json-stream-or-string-to-document: Private ordinary functions
Function, json-to-document: Public ordinary functions
Function, keyword-assocp: Private ordinary functions
Function, keyword-to-http-param: Private ordinary functions
Function, lisp-special-char-to-json: Private ordinary functions
Function, list-dbs: Public ordinary functions
Function, logout-session: Private ordinary functions
Function, make-db: Public ordinary functions
Function, make-db-auth: Private ordinary functions
Function, make-db-identifier: Private ordinary functions
Function, make-default-db: Private ordinary functions
Function, make-uri: Private ordinary functions
Function, new-db: Private ordinary functions
Function, post-document: Public ordinary functions
Function, put-document: Public ordinary functions
Function, query-document: Public ordinary functions
Function, read-chars-until: Private ordinary functions
Function, read-constant: Private ordinary functions
Function, read-json-array: Private ordinary functions
Function, read-json-chars: Private ordinary functions
Function, read-json-number: Private ordinary functions
Function, read-json-object: Private ordinary functions
Function, read-json-string: Private ordinary functions
Function, read-n-chars: Private ordinary functions
Function, replicate: Public ordinary functions
Function, save-attachment: Public ordinary functions
Function, set-connection: Public ordinary functions
Function, set-document-property: Public ordinary functions
Function, set-session: Private ordinary functions
Function, string-join: Private ordinary functions
Function, transform-param: Private ordinary functions
Function, transform-params: Private ordinary functions
Function, true-if-true: Private ordinary functions
Function, validate-ps-view: Private ordinary functions
Function, value-as-integer: Private ordinary functions
Function, value-as-string: Private ordinary functions
Function, view-cleanup: Private ordinary functions
Function, view-util: Private ordinary functions
Function, write-alist: Private ordinary functions
Function, write-json-chars: Private ordinary functions
Function, write-json-number: Private ordinary functions
Function, write-json-string: Private ordinary functions
Function, write-json-symbol: Private ordinary functions
Function, write-list: Private ordinary functions

G
Generic Function, att-name: Private generic functions
Generic Function, attachments: Private generic functions
Generic Function, db: Private generic functions
Generic Function, description: Private generic functions
Generic Function, id: Private generic functions
Generic Function, id-value: Private generic functions
Generic Function, input: Private generic functions
Generic Function, ps-view-def: Private generic functions
Generic Function, reason: Private generic functions
Generic Function, result: Private generic functions
Generic Function, text: Private generic functions
Generic Function, uri: Private generic functions
Generic Function, value: Private generic functions
get-active-tasks: Public ordinary functions
get-all-documents: Public ordinary functions
get-attachment-stream: Public ordinary functions
get-config: Public ordinary functions
get-couchdb-info: Public ordinary functions
get-db-info: Public ordinary functions
get-document: Public ordinary functions
get-session: Private ordinary functions
get-stats: Private ordinary functions
get-uuids: Public ordinary functions

I
id: Private generic functions
id: Private generic functions
id-value: Private generic functions
id-value: Private generic functions
input: Private generic functions
input: Private generic functions
invoke-list: Private ordinary functions
invoke-view: Public ordinary functions

J
json-escaped-char-to-lisp: Private ordinary functions
json-intern: Private ordinary functions
json-stream-or-string-to-document: Private ordinary functions
json-to-document: Public ordinary functions

K
keyword-assocp: Private ordinary functions
keyword-to-http-param: Private ordinary functions

L
lisp-special-char-to-json: Private ordinary functions
list-dbs: Public ordinary functions
logout-session: Private ordinary functions

M
Macro, cat: Private macros
Macro, db-or-db-name: Private macros
Macro, define-constant: Private macros
Macro, defpsfun: Private macros
Macro, ensure-db: Private macros
Macro, ps-function: Private macros
Macro, ps-view: Public macros
Macro, url-encode: Private macros
Macro, with-attachment: Public macros
Macro, with-connection: Public macros
Macro, with-temp-db: Public macros
make-db: Public ordinary functions
make-db-auth: Private ordinary functions
make-db-identifier: Private ordinary functions
make-default-db: Private ordinary functions
make-uri: Private ordinary functions
Method, att-name: Private generic functions
Method, attachments: Private generic functions
Method, db: Private generic functions
Method, db: Private generic functions
Method, description: Private generic functions
Method, id: Private generic functions
Method, id-value: Private generic functions
Method, input: Private generic functions
Method, ps-view-def: Private generic functions
Method, reason: Private generic functions
Method, result: Private generic functions
Method, result: Private generic functions
Method, text: Private generic functions
Method, text: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, value: Private generic functions

N
new-db: Private ordinary functions

P
post-document: Public ordinary functions
ps-function: Private macros
ps-view: Public macros
ps-view-def: Private generic functions
ps-view-def: Private generic functions
put-document: Public ordinary functions

Q
query-document: Public ordinary functions

R
read-chars-until: Private ordinary functions
read-constant: Private ordinary functions
read-json-array: Private ordinary functions
read-json-chars: Private ordinary functions
read-json-number: Private ordinary functions
read-json-object: Private ordinary functions
read-json-string: Private ordinary functions
read-n-chars: Private ordinary functions
reason: Private generic functions
reason: Private generic functions
replicate: Public ordinary functions
result: Private generic functions
result: Private generic functions
result: Private generic functions

S
save-attachment: Public ordinary functions
set-connection: Public ordinary functions
set-document-property: Public ordinary functions
set-session: Private ordinary functions
string-join: Private ordinary functions

T
text: Private generic functions
text: Private generic functions
text: Private generic functions
transform-param: Private ordinary functions
transform-params: Private ordinary functions
true-if-true: Private ordinary functions

U
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
url-encode: Private macros

V
validate-ps-view: Private ordinary functions
value: Private generic functions
value: Private generic functions
value-as-integer: Private ordinary functions
value-as-string: Private ordinary functions
view-cleanup: Private ordinary functions
view-util: Private ordinary functions

W
with-attachment: Public macros
with-connection: Public macros
with-temp-db: Public macros
write-alist: Private ordinary functions
write-json-chars: Private ordinary functions
write-json-number: Private ordinary functions
write-json-string: Private ordinary functions
write-json-symbol: Private ordinary functions
write-list: Private ordinary functions


A.3 Variables

Jump to:   *   +  
A   C   D   H   I   N   P   R   S   T   U   V  
Index Entry  Section

*
*changes-options*: Private special variables
*clouchdb-version*: Public special variables
*couchdb*: Public special variables
*debug-requests*: Private special variables
*default-content-type*: Private special variables
*default-db-name*: Private special variables
*default-host*: Private special variables
*default-port*: Private special variables
*default-protocol*: Private special variables
*digits*: Private special variables
*json-lisp-escaped-chars*: Private special variables
*json-make-big-number*: Private special variables
*json-number-valid-chars*: Private special variables
*json-object-factory*: Private special variables
*json-object-factory-add-key-value*: Private special variables
*json-object-factory-return*: Private special variables
*json-rules*: Private special variables
*json-symbols-package*: Private special variables
*temp-db-counter*: Private special variables
*text-types*: Private special variables
*use-strict-json-rules*: Private special variables
*view-function-names*: Private special variables
*view-options*: Private special variables

+
+utf-8+: Private constants

A
attachment-name: Public conditions
attachments: Public conditions

C
Constant, +utf-8+: Private constants

D
db: Public conditions
db: Private conditions
description: Private conditions
document-fetch-fn: Private structures
document-update-fn: Private structures

H
host: Private structures

I
id: Public conditions
id-value: Private conditions
input: Private conditions

N
name: Private structures

P
password: Private structures
port: Private structures
protocol: Private structures
ps-view-def: Private conditions

R
reason: Public conditions
result: Public conditions
result: Private conditions

S
Slot, attachment-name: Public conditions
Slot, attachments: Public conditions
Slot, db: Public conditions
Slot, db: Private conditions
Slot, description: Private conditions
Slot, document-fetch-fn: Private structures
Slot, document-update-fn: Private structures
Slot, host: Private structures
Slot, id: Public conditions
Slot, id-value: Private conditions
Slot, input: Private conditions
Slot, name: Private structures
Slot, password: Private structures
Slot, port: Private structures
Slot, protocol: Private structures
Slot, ps-view-def: Private conditions
Slot, reason: Public conditions
Slot, result: Public conditions
Slot, result: Private conditions
Slot, text: Public conditions
Slot, text: Public conditions
Slot, text: Private conditions
Slot, uri: Private conditions
Slot, user: Private structures
Slot, value: Private conditions
Special Variable, *changes-options*: Private special variables
Special Variable, *clouchdb-version*: Public special variables
Special Variable, *couchdb*: Public special variables
Special Variable, *debug-requests*: Private special variables
Special Variable, *default-content-type*: Private special variables
Special Variable, *default-db-name*: Private special variables
Special Variable, *default-host*: Private special variables
Special Variable, *default-port*: Private special variables
Special Variable, *default-protocol*: Private special variables
Special Variable, *digits*: Private special variables
Special Variable, *json-lisp-escaped-chars*: Private special variables
Special Variable, *json-make-big-number*: Private special variables
Special Variable, *json-number-valid-chars*: Private special variables
Special Variable, *json-object-factory*: Private special variables
Special Variable, *json-object-factory-add-key-value*: Private special variables
Special Variable, *json-object-factory-return*: Private special variables
Special Variable, *json-rules*: Private special variables
Special Variable, *json-symbols-package*: Private special variables
Special Variable, *temp-db-counter*: Private special variables
Special Variable, *text-types*: Private special variables
Special Variable, *use-strict-json-rules*: Private special variables
Special Variable, *view-function-names*: Private special variables
Special Variable, *view-options*: Private special variables

T
text: Public conditions
text: Public conditions
text: Private conditions

U
uri: Private conditions
user: Private structures

V
value: Private conditions


A.4 Data types

Jump to:   A   C   D   E   F   I   J   P   S  
Index Entry  Section

A
attachment-missing: Public conditions
authorization-error: Private conditions

C
clouchdb: The clouchdb system
clouchdb: The clouchdb package
clouchdb-asd: The clouchdb-asd package
clouchdb-error: Private conditions
clouchdb.asd: The clouchdb/clouchdb․asd file
clouchdb.lisp: The clouchdb/clouchdb․lisp file
Condition, attachment-missing: Public conditions
Condition, authorization-error: Private conditions
Condition, clouchdb-error: Private conditions
Condition, db-already-exists: Public conditions
Condition, db-does-not-exist: Public conditions
Condition, db-existential-error: Public conditions
Condition, doc-error: Public conditions
Condition, document-missing: Public conditions
Condition, id-missing: Public conditions
Condition, id-or-revision-conflict: Public conditions
Condition, illegal-database-name: Public conditions
Condition, invalid-design-doc: Private conditions
Condition, invalid-document: Private conditions
Condition, invalid-id: Private conditions
Condition, invalid-type: Private conditions
Condition, json-parse-error: Private conditions
Condition, ps-view-def-error: Private conditions

D
db: Private structures
db-already-exists: Public conditions
db-does-not-exist: Public conditions
db-existential-error: Public conditions
decoder.lisp: The clouchdb/decoder․lisp file
doc-error: Public conditions
document-missing: Public conditions

E
encoder.lisp: The clouchdb/encoder․lisp file

F
File, clouchdb.asd: The clouchdb/clouchdb․asd file
File, clouchdb.lisp: The clouchdb/clouchdb․lisp file
File, decoder.lisp: The clouchdb/decoder․lisp file
File, encoder.lisp: The clouchdb/encoder․lisp file
File, package.lisp: The clouchdb/package․lisp file

I
id-missing: Public conditions
id-or-revision-conflict: Public conditions
illegal-database-name: Public conditions
invalid-design-doc: Private conditions
invalid-document: Private conditions
invalid-id: Private conditions
invalid-type: Private conditions

J
json-parse-error: Private conditions

P
Package, clouchdb: The clouchdb package
Package, clouchdb-asd: The clouchdb-asd package
package.lisp: The clouchdb/package․lisp file
ps-view-def-error: Private conditions

S
Structure, db: Private structures
System, clouchdb: The clouchdb system