The clouchdb Reference Manual

Table of Contents

The clouchdb Reference Manual

This is the clouchdb Reference Manual, version 0.0.12, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:35:07 2018 GMT+0.

1 Systems

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

1.1 clouchdb

Version

0.0.12

Dependencies

• closer-mop
• drakma
• parenscript
• s-base64
• flexi-streams

Source

clouchdb.asd (file)

Components

• package.lisp (file)
• clouchdb.lisp (file)
• decoder.lisp (file)
• encoder.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 clouchdb.asd

Location

clouchdb.asd

Systems

clouchdb (system)

Packages

clouchdb-asd

Exported Definitions

*clouchdb-version* (special variable)

2.1.2 clouchdb/package.lisp

Parent

clouchdb (system)

Location

package.lisp

Packages

clouchdb

2.1.3 clouchdb/clouchdb.lisp

Dependency

package.lisp (file)

Parent

clouchdb (system)

Location

clouchdb.lisp

Exported Definitions

• *couchdb* (special variable)
• ad-hoc-view (function)
• add-attachment (function)
• all-docs-by-seq (function)
• as-deleted-document (function)
• as-field-name-string (function)
• as-keyword-symbol (function)
• attachment-list (function)
• attachment-missing (condition)
• attachment-name (function)
• bulk-document-update (function)
• changes (function)
• compact-db (function)
• copy-document (function)
• couchdb-document-properties (function)
• create-db (function)
• create-document (function)
• create-ps-view (function)
• create-temp-db (function)
• create-temp-db-name (function)
• create-view (function)
• db-already-exists (condition)
• db-document-fetch-fn (function)
• (setf db-document-fetch-fn) (function)
• db-document-update-fn (function)
• (setf db-document-update-fn) (function)
• db-does-not-exist (condition)
• db-existential-error (condition)
• db-host (function)
• (setf db-host) (function)
• db-name (function)
• (setf db-name) (function)
• db-password (function)
• (setf db-password) (function)
• db-port (function)
• (setf db-port) (function)
• db-protocol (function)
• (setf db-protocol) (function)
• db-user (function)
• (setf db-user) (function)
• delete-attachment (function)
• delete-db (function)
• delete-document (function)
• delete-view (function)
• doc-error (condition)
• document-as-hash (function)
• document-id (function)
• document-missing (condition)
• document-properties (function)
• document-property (function)
• (setf document-property) (function)
• document-revision (function)
• get-active-tasks (function)
• get-all-documents (function)
• get-attachment-stream (function)
• get-config (function)
• get-couchdb-info (function)
• get-db-info (function)
• get-document (function)
• get-uuids (function)
• id-missing (condition)
• id-or-revision-conflict (condition)
• illegal-database-name (condition)
• invoke-view (function)
• list-dbs (function)
• make-db (function)
• post-document (function)
• ps-view (macro)
• put-document (function)
• query-document (function)
• replicate (function)
• save-attachment (function)
• set-connection (function)
• set-document-property (function)
• with-attachment (macro)
• with-connection (macro)
• with-temp-db (macro)

Internal Definitions

• *changes-options* (special variable)
• *debug-requests* (special variable)
• *default-content-type* (special variable)
• *default-db-name* (special variable)
• *default-host* (special variable)
• *default-port* (special variable)
• *default-protocol* (special variable)
• *temp-db-counter* (special variable)
• *text-types* (special variable)
• *view-function-names* (special variable)
• *view-options* (special variable)
• +utf-8+ (constant)
• add-admin (function)
• add-functions (function)
• add-lists-fns (function)
• add-shows-fns (function)
• att-name (method)
• attachments (method)
• authorization-error (condition)
• cat (macro)
• clouchdb-error (condition)
• compact-view (function)
• convert-encoding (function)
• copy-db (function)
• couchdb-database-url (function)
• couchdb-host-url (function)
• db (method)
• db (method)
• db (structure)
• db-or-db-name (macro)
• db-p (function)
• db-request (function)
• define-constant (macro)
• defpsfun (macro)
• description (method)
• doc-as-alist (function)
• document-update-notify (function)
• doublequote (function)
• encode-attachments (function)
• encode-file (function)
• ensure-db (macro)
• ensure-design-doc (function)
• false-if-false (function)
• get-session (function)
• get-stats (function)
• id (method)
• id-value (method)
• input (method)
• invalid-design-doc (condition)
• invalid-document (condition)
• invalid-id (condition)
• invalid-type (condition)
• invoke-list (function)
• json-stream-or-string-to-document (function)
• keyword-to-http-param (function)
• logout-session (function)
• make-db-auth (function)
• make-db-identifier (function)
• make-default-db (function)
• make-uri (function)
• new-db (function)
• ps-function (macro)
• ps-view-def (method)
• ps-view-def-error (condition)
• reason (method)
• result (method)
• result (method)
• set-session (function)
• string-join (function)
• text (method)
• text (method)
• transform-param (function)
• transform-params (function)
• true-if-true (function)
• uri (method)
• uri (method)
• url-encode (macro)
• validate-ps-view (function)
• value (method)
• value-as-integer (function)
• value-as-string (function)
• view-cleanup (function)
• view-util (function)

2.1.4 clouchdb/decoder.lisp

Dependency

clouchdb.lisp (file)

Parent

clouchdb (system)

Location

decoder.lisp

Exported Definitions

json-to-document (function)

Internal Definitions

• *digits* (special variable)
• *json-make-big-number* (special variable)
• *json-number-valid-chars* (special variable)
• *json-object-factory* (special variable)
• *json-object-factory-add-key-value* (special variable)
• *json-object-factory-return* (special variable)
• *json-rules* (special variable)
• *json-symbols-package* (special variable)
• *use-strict-json-rules* (special variable)
• add-json-dispatch-rule (function)
• decode-json (function)
• decode-json-strict (function)
• json-escaped-char-to-lisp (function)
• json-intern (function)
• json-parse-error (condition)
• read-chars-until (function)
• read-constant (function)
• read-json-array (function)
• read-json-chars (function)
• read-json-number (function)
• read-json-object (function)
• read-json-string (function)
• read-n-chars (function)

2.1.5 clouchdb/encoder.lisp

Dependency

decoder.lisp (file)

Parent

clouchdb (system)

Location

encoder.lisp

Exported Definitions

document-to-json (function)

Internal Definitions

• *json-lisp-escaped-chars* (special variable)
• assoclp (function)
• document-to-json-stream (function)
• encode (function)
• keyword-assocp (function)
• lisp-special-char-to-json (function)
• write-alist (function)
• write-json-chars (function)
• write-json-number (function)
• write-json-string (function)
• write-json-symbol (function)
• write-list (function)

3 Packages

Packages are listed by definition order.

3.1 clouchdb-asd

Source

clouchdb.asd

Use List

• asdf/interface
• common-lisp

Exported Definitions

*clouchdb-version* (special variable)

3.2 clouchdb

Source

package.lisp (file)

Use List

• parenscript
• common-lisp

Exported Definitions

• *couchdb* (special variable)
• ad-hoc-view (function)
• add-attachment (function)
• all-docs-by-seq (function)
• as-deleted-document (function)
• as-field-name-string (function)
• as-keyword-symbol (function)
• attachment-list (function)
• attachment-missing (condition)
• attachment-name (function)
• bulk-document-update (function)
• changes (function)
• compact-db (function)
• copy-document (function)
• couchdb-document-properties (function)
• create-db (function)
• create-document (function)
• create-ps-view (function)
• create-temp-db (function)
• create-temp-db-name (function)
• create-view (function)
• db-already-exists (condition)
• db-document-fetch-fn (function)
• (setf db-document-fetch-fn) (function)
• db-document-update-fn (function)
• (setf db-document-update-fn) (function)
• db-does-not-exist (condition)
• db-existential-error (condition)
• db-host (function)
• (setf db-host) (function)
• db-name (function)
• (setf db-name) (function)
• db-password (function)
• (setf db-password) (function)
• db-port (function)
• (setf db-port) (function)
• db-protocol (function)
• (setf db-protocol) (function)
• db-user (function)
• (setf db-user) (function)
• delete-attachment (function)
• delete-db (function)
• delete-document (function)
• delete-view (function)
• doc-error (condition)
• document-as-hash (function)
• document-id (function)
• document-missing (condition)
• document-properties (function)
• document-property (function)
• (setf document-property) (function)
• document-revision (function)
• document-to-json (function)
• get-active-tasks (function)
• get-all-documents (function)
• get-attachment-stream (function)
• get-config (function)
• get-couchdb-info (function)
• get-db-info (function)
• get-document (function)
• get-uuids (function)
• id-missing (condition)
• id-or-revision-conflict (condition)
• illegal-database-name (condition)
• invoke-view (function)
• json-to-document (function)
• list-dbs (function)
• make-db (function)
• post-document (function)
• ps-view (macro)
• put-document (function)
• query-document (function)
• replicate (function)
• save-attachment (function)
• set-connection (function)
• set-document-property (function)
• with-attachment (macro)
• with-connection (macro)
• with-temp-db (macro)

Internal Definitions

• *changes-options* (special variable)
• *debug-requests* (special variable)
• *default-content-type* (special variable)
• *default-db-name* (special variable)
• *default-host* (special variable)
• *default-port* (special variable)
• *default-protocol* (special variable)
• *digits* (special variable)
• *json-lisp-escaped-chars* (special variable)
• *json-make-big-number* (special variable)
• *json-number-valid-chars* (special variable)
• *json-object-factory* (special variable)
• *json-object-factory-add-key-value* (special variable)
• *json-object-factory-return* (special variable)
• *json-rules* (special variable)
• *json-symbols-package* (special variable)
• *temp-db-counter* (special variable)
• *text-types* (special variable)
• *use-strict-json-rules* (special variable)
• *view-function-names* (special variable)
• *view-options* (special variable)
• +utf-8+ (constant)
• add-admin (function)
• add-functions (function)
• add-json-dispatch-rule (function)
• add-lists-fns (function)
• add-shows-fns (function)
• assoclp (function)
• att-name (generic function)
• att-name (method)
• attachments (generic function)
• attachments (method)
• authorization-error (condition)
• cat (macro)
• clouchdb-error (condition)
• compact-view (function)
• convert-encoding (function)
• copy-db (function)
• couchdb-database-url (function)
• couchdb-host-url (function)
• db (generic function)
• db (method)
• db (method)
• db (structure)
• db-or-db-name (macro)
• db-p (function)
• db-request (function)
• decode-json (function)
• decode-json-strict (function)
• define-constant (macro)
• defpsfun (macro)
• description (generic function)
• description (method)
• doc-as-alist (function)
• document-to-json-stream (function)
• document-update-notify (function)
• doublequote (function)
• encode (function)
• encode-attachments (function)
• encode-file (function)
• ensure-db (macro)
• ensure-design-doc (function)
• false-if-false (function)
• get-session (function)
• get-stats (function)
• id (generic function)
• id (method)
• id-value (generic function)
• id-value (method)
• input (generic function)
• input (method)
• invalid-design-doc (condition)
• invalid-document (condition)
• invalid-id (condition)
• invalid-type (condition)
• invoke-list (function)
• json-escaped-char-to-lisp (function)
• json-intern (function)
• json-parse-error (condition)
• json-stream-or-string-to-document (function)
• keyword-assocp (function)
• keyword-to-http-param (function)
• lisp-special-char-to-json (function)
• logout-session (function)
• make-db-auth (function)
• make-db-identifier (function)
• make-default-db (function)
• make-uri (function)
• new-db (function)
• ps-function (macro)
• ps-view-def (generic function)
• ps-view-def (method)
• ps-view-def-error (condition)
• read-chars-until (function)
• read-constant (function)
• read-json-array (function)
• read-json-chars (function)
• read-json-number (function)
• read-json-object (function)
• read-json-string (function)
• read-n-chars (function)
• reason (generic function)
• reason (method)
• result (generic function)
• result (method)
• result (method)
• set-session (function)
• string-join (function)
• text (generic function)
• text (method)
• text (method)
• transform-param (function)
• transform-params (function)
• true-if-true (function)
• uri (generic function)
• uri (method)
• uri (method)
• url-encode (macro)
• validate-ps-view (function)
• value (generic function)
• value (method)
• value-as-integer (function)
• value-as-string (function)
• view-cleanup (function)
• view-util (function)
• write-alist (function)
• write-json-chars (function)
• write-json-number (function)
• write-json-string (function)
• write-json-symbol (function)
• write-list (function)

4 Definitions

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

4.1 Exported definitions

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 (file)

4.1.2 Macros

Macro: ps-view (&optional VIEW-NAME) &body BODY

Create a view using parenscript

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

Macro: with-temp-db &body BODY

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

Package

clouchdb

Source

clouchdb.lisp (file)

4.1.3 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 (file)

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 (file)

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 (file)

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 (file)

Function: as-field-name-string VALUE

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

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: couchdb-document-properties DOCUMENT

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

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

Function: create-document DOC &key ID ATTACHMENTS

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: create-ps-view ID &rest VIEW-DEFS

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: create-temp-db &key DB-NAME-CREATOR

Create a temporary database.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: create-temp-db-name ()

Return a database name that’s probably unique.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: create-view ID VIEW &key LANGUAGE

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-document-fetch-fn INSTANCE

Function: (setf db-document-fetch-fn) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-document-update-fn INSTANCE

Function: (setf db-document-update-fn) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-host INSTANCE

Function: (setf db-host) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-name INSTANCE

Function: (setf db-name) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-password INSTANCE

Function: (setf db-password) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-port INSTANCE

Function: (setf db-port) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-protocol INSTANCE

Function: (setf db-protocol) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-user INSTANCE

Function: (setf db-user) VALUE INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

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 (file)

Function: delete-view ID &key REVISION IF-MISSING

Delete identified view document

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Writer

(setf document-property) (function)

Function: (setf document-property) VALUE 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 (file)

Reader

document-property (function)

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 (file)

Function: document-to-json DOC

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

Package

clouchdb

Source

encoder.lisp (file)

Function: get-active-tasks &optional DB

Get active tasks for database or nil.

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

Function: get-config &key DB SECTION OPTION

Get database configuration.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: get-couchdb-info &key DB

Get information from the couchdb server.

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

Function: get-uuids &key COUNT DB

Returns one or more new UUID from the current database.

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

Function: json-to-document JSON-STRING

Package

clouchdb

Source

decoder.lisp (file)

Function: list-dbs &optional DB

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

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

4.1.4 Conditions

Condition: attachment-missing ()

Error raised when specified attachment is not found

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Direct methods

• attachments (method)
• att-name (method)

Direct slots

Slot: attachment-name

Initargs

:attachment-name

Readers

att-name (generic function)

Slot: attachments

Initargs

:attachments

Readers

attachments (generic function)

Condition: db-already-exists ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

db-existential-error (condition)

Condition: db-does-not-exist ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

db-existential-error (condition)

Condition: db-existential-error ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

clouchdb-error (condition)

Direct subclasses

• db-does-not-exist (condition)
• db-already-exists (condition)
• illegal-database-name (condition)

Direct methods

• result (method)
• db (method)
• uri (method)

Direct slots

Slot: text

Initargs

:uri

Readers

uri (generic function)

Slot: db

Initargs

:db

Readers

db (generic function)

Slot: result

Initargs

:result

Readers

result (generic function)

Condition: doc-error ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

clouchdb-error (condition)

Direct subclasses

• invalid-design-doc (condition)
• id-or-revision-conflict (condition)
• id-missing (condition)
• invalid-id (condition)
• invalid-document (condition)
• document-missing (condition)
• attachment-missing (condition)

Direct methods

• id (method)
• reason (method)
• text (method)

Direct slots

Slot: text

Initargs

:uri

Readers

text (generic function)

Slot: reason

Initargs

:reason

Readers

reason (generic function)

Slot: id

Initargs

:id

Readers

id (generic function)

Condition: document-missing ()

Error raised when no document matching ID is found

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Condition: id-missing ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Condition: id-or-revision-conflict ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Condition: illegal-database-name ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

db-existential-error (condition)

4.2 Internal definitions

4.2.1 Constants

Constant: +utf-8+

Default external format for document content.

Package

clouchdb

Source

clouchdb.lisp (file)

4.2.2 Special variables

Special Variable: *changes-options*

Parameters for the changes function.

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *debug-requests*

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *default-content-type*

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *default-db-name*

Default database name

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *default-host*

CouchDb server host name

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *default-port*

The IANA assigned CouchDb port

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *default-protocol*

http or https

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *digits*

Package

clouchdb

Source

decoder.lisp (file)

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

Package

clouchdb

Source

encoder.lisp (file)

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

Package

clouchdb

Source

decoder.lisp (file)

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

Package

clouchdb

Source

decoder.lisp (file)

Special Variable: *json-object-factory*

Package

clouchdb

Source

decoder.lisp (file)

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

Package

clouchdb

Source

decoder.lisp (file)

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

Package

clouchdb

Source

decoder.lisp (file)

Special Variable: *json-rules*

Package

clouchdb

Source

decoder.lisp (file)

Special Variable: *json-symbols-package*

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

Package

clouchdb

Source

decoder.lisp (file)

Special Variable: *temp-db-counter*

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *text-types*

Defined to instruct Drakma to treat json responses as text

Package

clouchdb

Source

clouchdb.lisp (file)

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

Package

clouchdb

Source

decoder.lisp (file)

Special Variable: *view-function-names*

Package

clouchdb

Source

clouchdb.lisp (file)

Special Variable: *view-options*

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

Package

clouchdb

Source

clouchdb.lisp (file)

4.2.3 Macros

Macro: cat &rest REST

Shorthand for (concatenate ’string)

Package

clouchdb

Source

clouchdb.lisp (file)

Macro: db-or-db-name DB

Package

clouchdb

Source

clouchdb.lisp (file)

Macro: define-constant NAME VALUE &optional DOC

A version of DEFCONSTANT for /strict/ CL implementations.

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

Macro: ps-function &body BODY

Create a view using parenscript

Package

clouchdb

Source

clouchdb.lisp (file)

Macro: url-encode STRING

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

Package

clouchdb

Source

clouchdb.lisp (file)

4.2.4 Functions

Function: add-admin NAME PASSWORD &key DB

Add an admin user.

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

Function: add-json-dispatch-rule CHARACTER FN

Package

clouchdb

Source

decoder.lisp (file)

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 (file)

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 (file)

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 (file)

Function: compact-view VIEW-NAME

Compact named view

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

Function: copy-db INSTANCE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: couchdb-database-url DB

Package

clouchdb

Source

clouchdb.lisp (file)

Function: couchdb-host-url DB

Package

clouchdb

Source

clouchdb.lisp (file)

Function: db-p OBJECT

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

Function: decode-json &optional STREAM

Reads a json element from stream

Package

clouchdb

Source

decoder.lisp (file)

Function: decode-json-strict &optional STREAM

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

Package

clouchdb

Source

decoder.lisp (file)

Function: doc-as-alist DOC

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

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

Function: doublequote VALUE

Wrap specified value in double quotes.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: encode D STREAM

Package

clouchdb

Source

encoder.lisp (file)

Function: encode-attachments ATTACHMENTS

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: encode-file FILE

Encode a file in the format suitable for CouchDb attachments

Package

clouchdb

Source

clouchdb.lisp (file)

Function: ensure-design-doc ID

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: false-if-false VALUE

Return "false" if value is nil, otherwise nil

Package

clouchdb

Source

clouchdb.lisp (file)

Function: get-session &optional DB

Get cookie based login user information.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: get-stats &optional DB

Get database statistics overview.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: invoke-list DOC-ID LIST-ID

Package

clouchdb

Source

clouchdb.lisp (file)

Function: json-escaped-char-to-lisp JSON-ESCAPED-CHAR

Package

clouchdb

Source

decoder.lisp (file)

Function: json-intern STRING

Package

clouchdb

Source

decoder.lisp (file)

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 (file)

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 (file)

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 (file)

Function: lisp-special-char-to-json LISP-CHAR

Package

clouchdb

Source

encoder.lisp (file)

Function: logout-session &optional DB

Logout cookie based session.

Package

clouchdb

Source

clouchdb.lisp (file)

Function: make-db-auth DB

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: make-db-identifier INPUT

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: make-default-db ()

Package

clouchdb

Source

clouchdb.lisp (file)

Function: make-uri &rest REST

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: new-db &key (HOST HOST) (PORT PORT) (NAME NAME) (PROTOCOL PROTOCOL) (USER USER) (PASSWORD PASSWORD) (DOCUMENT-FETCH-FN DOCUMENT-FETCH-FN) (DOCUMENT-UPDATE-FN DOCUMENT-UPDATE-FN)

Package

clouchdb

Source

clouchdb.lisp (file)

Function: read-chars-until STREAM &key TERMINATOR-FN CHAR-CONVERTER

Package

clouchdb

Source

decoder.lisp (file)

Function: read-constant STREAM EXPECTED-STRING RET-VALUE

Package

clouchdb

Source

decoder.lisp (file)

Function: read-json-array STREAM

Package

clouchdb

Source

decoder.lisp (file)

Function: read-json-chars STREAM TERMINATORS

Package

clouchdb

Source

decoder.lisp (file)

Function: read-json-number STREAM

Package

clouchdb

Source

decoder.lisp (file)

Function: read-json-object STREAM

Package

clouchdb

Source

decoder.lisp (file)

Function: read-json-string STREAM

Package

clouchdb

Source

decoder.lisp (file)

Function: read-n-chars STREAM N

Package

clouchdb

Source

decoder.lisp (file)

Function: set-session &optional DB

Do cookie based login.

Package

clouchdb

Source

clouchdb.lisp (file)

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 (file)

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 (file)

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 (file)

Function: true-if-true VALUE

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

Package

clouchdb

Source

clouchdb.lisp (file)

Function: validate-ps-view DEFUN FN-NAME FN-PARAM FN-BODY

Validation for ps-view definition

Package

clouchdb

Source

clouchdb.lisp (file)

Function: value-as-integer VALUE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: value-as-string VALUE

Package

clouchdb

Source

clouchdb.lisp (file)

Function: view-cleanup ()

Clean up old view data

Package

clouchdb

Source

clouchdb.lisp (file)

Function: view-util CMD

General function called by view functions

Package

clouchdb

Source

clouchdb.lisp (file)

Function: write-alist D STREAM

Package

clouchdb

Source

encoder.lisp (file)

Function: write-json-chars S STREAM

Package

clouchdb

Source

encoder.lisp (file)

Function: write-json-number NR STREAM

Package

clouchdb

Source

encoder.lisp (file)

Function: write-json-string S STREAM

Package

clouchdb

Source

encoder.lisp (file)

Function: write-json-symbol SYMBOL STREAM

Package

clouchdb

Source

encoder.lisp (file)

Function: write-list D STREAM

Package

clouchdb

Source

encoder.lisp (file)

4.2.5 Generic functions

Generic Function: att-name CONDITION

Package

clouchdb

Methods

Method: att-name (CONDITION attachment-missing)

Source

clouchdb.lisp (file)

Generic Function: attachments CONDITION

Package

clouchdb

Methods

Method: attachments (CONDITION attachment-missing)

Source

clouchdb.lisp (file)

Generic Function: db CONDITION

Package

clouchdb

Methods

Method: db (CONDITION db-existential-error)

Source

clouchdb.lisp (file)

Method: db (CONDITION authorization-error)

Source

clouchdb.lisp (file)

Generic Function: description CONDITION

Package

clouchdb

Methods

Method: description (CONDITION invalid-type)

Source

clouchdb.lisp (file)

Generic Function: id CONDITION

Package

clouchdb

Methods

Method: id (CONDITION doc-error)

Source

clouchdb.lisp (file)

Generic Function: id-value CONDITION

Package

clouchdb

Methods

Method: id-value (CONDITION invalid-id)

Source

clouchdb.lisp (file)

Generic Function: input CONDITION

Package

clouchdb

Methods

Method: input (CONDITION invalid-type)

Source

clouchdb.lisp (file)

Generic Function: ps-view-def CONDITION

Package

clouchdb

Methods

Method: ps-view-def (CONDITION ps-view-def-error)

Source

clouchdb.lisp (file)

Generic Function: reason CONDITION

Package

clouchdb

Methods

Method: reason (CONDITION doc-error)

Source

clouchdb.lisp (file)

Generic Function: result CONDITION

Package

clouchdb

Methods

Method: result (CONDITION db-existential-error)

Source

clouchdb.lisp (file)

Method: result (CONDITION authorization-error)

Source

clouchdb.lisp (file)

Generic Function: text CONDITION

Package

clouchdb

Methods

Method: text (CONDITION doc-error)

Source

clouchdb.lisp (file)

Method: text (CONDITION authorization-error)

Source

clouchdb.lisp (file)

Generic Function: uri CONDITION

Package

clouchdb

Methods

Method: uri (CONDITION db-existential-error)

Source

clouchdb.lisp (file)

Method: uri (CONDITION authorization-error)

Source

clouchdb.lisp (file)

Generic Function: value CONDITION

Package

clouchdb

Methods

Method: value (CONDITION invalid-document)

Source

clouchdb.lisp (file)

4.2.6 Conditions

Condition: authorization-error ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

clouchdb-error (condition)

Direct methods

• text (method)
• uri (method)
• db (method)
• result (method)

Direct slots

Slot: result

Initargs

:result

Readers

result (generic function)

Slot: db

Initargs

:db

Readers

db (generic function)

Slot: uri

Initargs

:uri

Readers

uri (generic function)

Slot: text

Initargs

:text

Readers

text (generic function)

Condition: clouchdb-error ()

The base type of all errors signaled by clouchdb

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• authorization-error (condition)
• db-existential-error (condition)
• doc-error (condition)
• ps-view-def-error (condition)
• invalid-type (condition)

Condition: invalid-design-doc ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Condition: invalid-document ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Direct methods

value (method)

Direct slots

Slot: value

Initargs

:value

Readers

value (generic function)

Condition: invalid-id ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

doc-error (condition)

Direct methods

id-value (method)

Direct slots

Slot: id-value

Initargs

:id-value

Readers

id-value (generic function)

Condition: invalid-type ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

clouchdb-error (condition)

Direct methods

• description (method)
• input (method)

Direct slots

Slot: input

Initargs

:input

Readers

input (generic function)

Slot: description

Initargs

:description

Readers

description (generic function)

Condition: json-parse-error ()

Package

clouchdb

Source

decoder.lisp (file)

Direct superclasses

error (condition)

Condition: ps-view-def-error ()

Error raised for invalid ps-view definition

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

clouchdb-error (condition)

Direct methods

ps-view-def (method)

Direct slots

Slot: ps-view-def

Initargs

:ps-view-def

Readers

ps-view-def (generic function)

4.2.7 Structures

Structure: db ()

Package

clouchdb

Source

clouchdb.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: host

Readers

db-host (function)

Writers

(setf db-host) (function)

Slot: port

Readers

db-port (function)

Writers

(setf db-port) (function)

Slot: name

Readers

db-name (function)

Writers

(setf db-name) (function)

Slot: protocol

Readers

db-protocol (function)

Writers

(setf db-protocol) (function)

Slot: user

Readers

db-user (function)

Writers

(setf db-user) (function)

Slot: password

Readers

db-password (function)

Writers

(setf db-password) (function)

Slot: document-fetch-fn

Readers

db-document-fetch-fn (function)

Writers

(setf db-document-fetch-fn) (function)

Slot: document-update-fn

Readers

db-document-update-fn (function)

Writers

(setf db-document-update-fn) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions