The chillax Reference Manual

This is the chillax Reference Manual, version 0.4.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:53:51 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 chillax

CouchDB abstraction layer - Easy-load system with sane defaults

Maintainer

Kat Marchán <>

Author

Kat Marchán <>

License

MIT

Version

0.4.1

Dependencies
Source

chillax.asd.

Child Component

src (module).


2.2 chillax.core

CouchDB abstraction layer - core API and protocols.

Maintainer

Kat Marchán <>

Author

Kat Marchán <>

License

MIT

Dependencies
  • alexandria (system).
  • flexi-streams (system).
  • drakma (system).
Source

chillax.core.asd.

Child Component

src (module).


2.3 chillax.yason

CouchDB abstraction layer - Implementation of protocols using Yason.

Maintainer

Kat Marchán <>

Author

Kat Marchán <>

License

MIT

Dependencies
Source

chillax.yason.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 chillax/src

Source

chillax.asd.

Parent Component

chillax (system).

Child Component

chillax.lisp (file).


3.2 chillax.core/src

Source

chillax.core.asd.

Parent Component

chillax.core (system).

Child Components

3.3 chillax.core/src/core

Dependency

utils.lisp (file).

Source

chillax.core.asd.

Parent Component

src (module).

Child Components

3.4 chillax.yason/src

Source

chillax.yason.asd.

Parent Component

chillax.yason (system).

Child Component

yason.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 chillax/chillax.asd

Source

chillax.asd.

Parent Component

chillax (system).

ASDF Systems

chillax.


4.1.2 chillax.core/chillax.core.asd

Source

chillax.core.asd.

Parent Component

chillax.core (system).

ASDF Systems

chillax.core.


4.1.3 chillax.yason/chillax.yason.asd

Source

chillax.yason.asd.

Parent Component

chillax.yason (system).

ASDF Systems

chillax.yason.


4.1.4 chillax/src/chillax.lisp

Source

chillax.asd.

Parent Component

src (module).

Packages

chillax.

Public Interface

*chillax-version* (special variable).


4.1.5 chillax.core/src/utils.lisp

Source

chillax.core.asd.

Parent Component

src (module).

Packages

chillax.utils.

Public Interface
Internals

4.1.6 chillax.core/src/core/package.lisp

Source

chillax.core.asd.

Parent Component

core (module).

Packages

chillax.core.


4.1.7 chillax.core/src/core/server.lisp

Dependency

package.lisp (file).

Source

chillax.core.asd.

Parent Component

core (module).

Public Interface
Internals

4.1.8 chillax.core/src/core/database.lisp

Dependency

server.lisp (file).

Source

chillax.core.asd.

Parent Component

core (module).

Public Interface
Internals

4.1.9 chillax.core/src/core/document.lisp

Dependency

database.lisp (file).

Source

chillax.core.asd.

Parent Component

core (module).

Public Interface
Internals

4.1.10 chillax.core/src/core/design-document.lisp

Dependency

document.lisp (file).

Source

chillax.core.asd.

Parent Component

core (module).

Public Interface
Internals

4.1.11 chillax.yason/src/yason.lisp

Source

chillax.yason.asd.

Parent Component

src (module).

Packages

chillax.yason.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 chillax

Source

chillax.lisp.

Use List
Public Interface

*chillax-version* (special variable).


5.2 chillax.core

Source

package.lisp.

Use List
Used By List
Public Interface
Internals

5.3 chillax.utils

Source

utils.lisp.

Use List
  • alexandria.
  • common-lisp.
Used By List

chillax.core.

Public Interface
Internals

5.4 chillax.yason

Source

yason.lisp.

Use List
Used By List

chillax.

Public Interface

yason-server (class).

Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *chillax-version*
Package

chillax.

Source

chillax.lisp.


6.1.2 Macros

Macro: fun (&body body)

This macro puts the FUN back in FUNCTION.

Package

chillax.utils.

Source

utils.lisp.


6.1.3 Compiler macros

Compiler Macro: hashget (hash &rest keys)
Package

chillax.utils.

Source

utils.lisp.


6.1.4 Ordinary functions

Function: active-tasks (server)

Lists all the currently active tasks on SERVER.

Package

chillax.core.

Source

server.lisp.

Function: all-dbs (server)

Requests a list of all existing databases from SERVER.

Package

chillax.core.

Source

server.lisp.

Function: all-documents (db &rest all-keys)

Requests the _all_docs document. ALL-KEYS correspond to GET-DOCUMENT’s keyword arguments.

Package

chillax.core.

Source

document.lisp.

Function: batch-get-documents (db doc-ids)

Uses _all_docs to quickly fetch the given DOC-IDs in a single request. Note that this function will NOT signal a DOCUMENT-NOT-FOUND error when one or more DOC-IDs are not found. Instead, the results will be returned, and it’s the user’s responsibility to deal with any missing docs.

Package

chillax.core.

Source

document.lisp.

Function: bulk-post-documents (db documents &key all-or-nothing-p)

Allows you to update or submit multiple documents at the same time, using CouchDB’s _bulk_docs API. In order to delete a document through this API, the document must have a _document attribute with JSON ’true’ as its value (note that what gets translated into ’true’ depends on the server).

DOCUMENTS must be a sequence or sequence-like (depending on what DATA->JSON will do to it).

If ALL-OR-NOTHING-P is true, the entire submission will fail if a single one fails.

Package

chillax.core.

Source

document.lisp.

Function: compact-design-doc (db design-doc-name)

Compaction can really help when you have very large views, very little space, or both.

Package

chillax.core.

Source

design-document.lisp.

Function: config-info (server)

Requests the current configuration from SERVER.

Package

chillax.core.

Source

server.lisp.

Function: copy-attachment (db doc-id attachment-name output-stream &key max-buffer-size)

Copies data from the named attachment to OUTPUT-STREAM. Returns the number of bytes copied.

Package

chillax.core.

Source

document.lisp.

Function: copy-document (db from-id to-id &key revision)

Copies a document’s content in-database.

Package

chillax.core.

Source

document.lisp.

Function: couch-request (server uri &rest all-keys &key content convert-data-p &allow-other-keys)

Sends an HTTP request to the CouchDB server represented by SERVER. Most of the keyword arguments for drakma:http-request are available as kwargs for this message.

Package

chillax.core.

Source

server.lisp.

Function: db-changes (db)

Returns the changes feed for DB

Package

chillax.core.

Source

database.lisp.

Function: db-compact (db)

Triggers a database compaction.

Package

chillax.core.

Source

database.lisp.

Function: db-connect (server name)

Confirms that a particular CouchDB database exists. If so, returns a new database object that can be used to perform operations on it. Will signal a DB-NOT-FOUND error if the database does not already exist.

Package

chillax.core.

Source

database.lisp.

Function: db-create (server name)

Creates a new CouchDB database. Returns a database object that can be used to operate on it. Will signal a DB-ALREADY-EXISTS error if there is already a database with the same NAME in SERVER.

Package

chillax.core.

Source

database.lisp.

Function: db-delete (db)

Deletes a CouchDB database.

Package

chillax.core.

Source

database.lisp.

Function: db-info (db)

Fetches info about a given database from the CouchDB server.

Package

chillax.core.

Source

database.lisp.

Function: db-uri (db)

Returns a string representing the full URI for DB.

Package

chillax.core.

Source

database.lisp.

Function: delete-attachment (db doc-id attachment-name doc-revision)

Deletes an attachment from a document. DOC-REVISION must be the latest revision for the document.

Package

chillax.core.

Source

document.lisp.

Function: delete-document (db id revision)

Deletes an existing document.

Package

chillax.core.

Source

document.lisp.

Function: dequote (string)
Package

chillax.utils.

Source

utils.lisp.

Function: design-doc-info (db design-doc-name)

Returns an object with various bits of status information. Refer to CouchDB documentation for specifics on each value.

Package

chillax.core.

Source

design-document.lisp.

Function: ensure-db (server name)

Either connects to an existing database, or creates a new one. Returns two values: If a new database was created, (DB-OBJECT T) is returned. Otherwise, (DB-OBJECT NIL)

Package

chillax.core.

Source

database.lisp.

Function: get-attachment (db doc-id attachment-name)

Returns 3 values:

1. STREAM - An open flexi-stream that can be READ. In order to read straight binary data, you must first fetch the underlying stream with FLEXI-STREAMS:FLEXI-STREAM-STREAM.
2. MUST-CLOSE-P - A boolean. If TRUE, the user must CLOSE this stream themselves
once reading is done.
3. CONTENT-LENGTH - Declared content length for the incoming data.

Package

chillax.core.

Source

document.lisp.

Function: get-document (db id &key attachmentsp errorp params)

Finds a CouchDB document in DB, named by ID. PARAMS should be an alist containing the parameters for the HTTP GET request. If ATTACHMENTSP is TRUE, the document’s attachments will be included in their entirety in their base64-encoded version. It is not recommended you use this unless you really know what you’re doing. If ERRORP is NIL, GET-DOCUMENT will simply return NIL on 404.

Package

chillax.core.

Source

document.lisp.

Function: get-document-revision (db doc-id &key errorp)

Quickly fetches the latest revision for DOC-ID. If ERRORP is NIL, this can be used to quickly test the existence of a document.

Package

chillax.core.

Source

document.lisp.

Function: get-uuids (server &key number)

Returns a list of NUMBER unique IDs requested from SERVER. The UUIDs generated by the server are reasonably unique, but are not checked against existing UUIDs, so conflicts may still happen.

Package

chillax.core.

Source

server.lisp.

Function: hashget (hash &rest keys)

Convenience function for recursively accessing hash tables.

Package

chillax.utils.

Source

utils.lisp.

Function: (setf hashget) (hash key &rest more-keys)

Uses the last key given to hashget to insert NEW-VALUE into the hash table returned by the second-to-last key.
tl;dr: DWIM SETF function for HASHGET.

Package

chillax.utils.

Source

utils.lisp.

Function: mkhash (&rest keys-and-values)

Convenience function for ‘literal’ hash table definition.

Package

chillax.utils.

Source

utils.lisp.

Function: post-document (db doc)

POSTs a document into DB. CouchDB will automatically assign a UUID if the document does not already exist. Note that using this function is discouraged in the CouchDB documentation, since it may result in duplicate documents because of proxies and other network intermediaries. If what you need is to create a new document with a generated id, consider using GET-UUIDS with PUT-DOCUMENT.

Package

chillax.core.

Source

document.lisp.

Function: put-attachment (db doc-id attachment-name data &key rev content-type)

Adds DATA as an attachment. DATA can be a number of things:

* String or sequence of octets - DATA will be sent as-is directly to the server (using EXTERNAL-FORMAT-OUT for strings).
* Stream - The stream will be read until EOF is reached.
* Pathname - The file the pathname denotes will be opened and its data uploaded.
* Function designator - The corresponding function will be called with one argument, the stream to the server, to which it should send data.

If the document already exists, REV is required. This function can be used on non-existent documents. If so, REV is not needed, and a document will be created automatically, and the attachment associated with it.

The CONTENT-TYPE should be a string specifying the content type for DATA.

Package

chillax.core.

Source

document.lisp.

Function: put-document (db id doc &key batch-ok-p)

Puts a document into DB, using ID.

Package

chillax.core.

Source

document.lisp.

Function: query-temporary-view (db &rest all-keys &key language reduce map key startkey startkey-docid endkey endkey-docid limit skip descendingp groupp group-level reducep stalep include-docs-p inclusive-end-p)

Queries a temporary view. These views are meant to be for testing and development purposes, and should _not_ be used in actual code.

Package

chillax.core.

Source

design-document.lisp.

Function: query-view (db design-doc-name view-name &rest all-keys &key key startkey startkey-docid endkey multi-keys endkey-docid limit skip descendingp groupp group-level reducep stalep include-docs-p inclusive-end-p)

Queries view named by VIEW-NAME in DESIGN-DOC-NAME. Keyword arguments correspond to CouchDB view query arguments.

* key - Single key to search for.
* multi-keys - Multiple keys to search for.
* startkey - When searching for a range of keys, the key to start from.
* endkey - When searching for a range of keys, the key to end at. Whether this is inclusive or not depends on inclusive-end-p (default: true)
* inclusive-end-p - If TRUE, endkey is included in the result. (default: true)
* startkey-docid - Like startkey, but keyed on the result documents’ doc-ids.
* endkey-docid - Like endkey, but keyed on the result documents’ doc-ids.
* limit - Maximum number of results to return.
* stalep - If TRUE, CouchDB will not refresh the view, even if it is stalled. (default: false)
* descendingp - If TRUE, will return reversed results. (default: false)
* skip - Number of documents to skip while querying.
* groupp - Controls whether the reduce function reduces to a set of distinct keys, or to a single result row.
* group-level - It’s complicated. Google it!
* reducep - If FALSE, return the view without applying its reduce function (if any). (default: true) * include-docs-p - If TRUE, includes the entire document with the result of the query. (default: false)

Package

chillax.core.

Source

design-document.lisp.

Function: replicate (server source target &key create-target-p continuousp)

Replicates the database in SOURCE to TARGET. SOURCE and TARGET can both be either database names in the local server, or full URLs to local or remote databases. If CREATE-TARGET-P is true, the target database will automatically be created if it does not exist. If CONTINUOUSP is true, CouchDB will continue propagating any changes in SOURCE to TARGET.

Package

chillax.core.

Source

server.lisp.

Function: server-uri (server)

Returns a string representation of the URL SERVER represents.

Package

chillax.core.

Source

server.lisp.

Function: stats (server)

Requests general statistics from SERVER.

Package

chillax.core.

Source

server.lisp.

Function: strcat (string &rest more-strings)
Package

chillax.utils.

Source

utils.lisp.

Function: view-cleanup (db)

Invokes _view_cleanup on DB. Old view output will remain on disk until this is invoked.

Package

chillax.core.

Source

design-document.lisp.


6.1.5 Generic functions

Generic Function: at (doc &rest keys)
Package

chillax.utils.

Source

utils.lisp.

Methods
Method: at ((doc list) &rest keys)
Method: at ((doc hash-table) &rest keys)
Generic Function: (setf at) (doc key &rest more-keys)
Package

chillax.utils.

Source

utils.lisp.

Methods
Method: (setf at) ((doc list) key &rest more-keys)
Method: (setf at) ((doc hash-table) key &rest more-keys)
Generic Function: data->json (server data &key)

Converts DATA to JSON suitable for sending to CouchDB.

Package

chillax.core.

Source

server.lisp.

Methods
Method: data->json ((server yason-server) data &key)
Source

yason.lisp.

Method: data->json ((server standard-server) data &key)
Generic Reader: database-name (database)

Returns the URL-encoded name of the database, a string. Note that CouchDB accepts certain characters in database names -only- if they are URL-encoded (such as #/). It is up to individual implementations of DATABASE-NAME to implement this encoding.

Package

chillax.core.

Source

database.lisp.

Methods
Reader Method: database-name ((standard-database standard-database))

automatically generated reader method

Target Slot

name.

Generic Reader: database-server (database)

Returns the server object with which DATABASE is associated.

Package

chillax.core.

Source

database.lisp.

Methods
Reader Method: database-server ((standard-database standard-database))

automatically generated reader method

Target Slot

server.

Generic Function: json->data (server json &key)

Converts JSON to the desired data structure.

Package

chillax.core.

Source

server.lisp.

Methods
Method: json->data ((server yason-server) json &key)
Source

yason.lisp.

Method: json->data ((server standard-server) json &key)
Generic Function: make-db-object (server name)

Creates an object which represents a database connection in SERVER. The object must conform to the database protocol.

Package

chillax.core.

Source

server.lisp.

Methods
Method: make-db-object ((server standard-server) name)
Source

database.lisp.

Generic Reader: server-host (server)
Package

chillax.core.

Source

server.lisp.

Methods
Reader Method: server-host ((standard-server standard-server))

automatically generated reader method

Target Slot

host.

Generic Reader: server-password (server)
Package

chillax.core.

Source

server.lisp.

Methods
Reader Method: server-password ((standard-server standard-server))

automatically generated reader method

Target Slot

password.

Generic Reader: server-port (server)
Package

chillax.core.

Source

server.lisp.

Methods
Reader Method: server-port ((standard-server standard-server))

automatically generated reader method

Target Slot

port.

Generic Reader: server-secure-p (server)
Package

chillax.core.

Source

server.lisp.

Methods
Reader Method: server-secure-p ((standard-server standard-server))

automatically generated reader method

Target Slot

securep.

Generic Reader: server-username (server)
Package

chillax.core.

Source

server.lisp.

Methods
Reader Method: server-username ((standard-server standard-server))

automatically generated reader method

Target Slot

username.


6.1.6 Standalone methods

Method: initialize-instance :after ((db standard-database) &key name)
Source

database.lisp.

Method: print-object ((db standard-database) stream)
Source

database.lisp.


6.1.7 Conditions

Condition: couchdb-error
Package

chillax.core.

Source

server.lisp.

Direct superclasses

condition.

Direct subclasses
Condition: database-error
Package

chillax.core.

Source

database.lisp.

Direct superclasses

couchdb-error.

Direct subclasses
Direct methods

database-error-uri.

Direct slots
Slot: uri
Initargs

:uri

Readers

database-error-uri.

Writers

This slot is read-only.

Condition: db-already-exists
Package

chillax.core.

Source

database.lisp.

Direct superclasses

database-error.

Condition: db-not-found
Package

chillax.core.

Source

database.lisp.

Direct superclasses

database-error.

Condition: document-conflict
Package

chillax.core.

Source

document.lisp.

Direct superclasses

document-error.

Direct methods
Direct slots
Slot: conflicting-doc
Initargs

:doc

Readers

conflicting-document.

Writers

This slot is read-only.

Slot: conflicting-doc-id
Initargs

:id

Readers

conflicting-document-id.

Writers

This slot is read-only.

Condition: document-error
Package

chillax.core.

Source

document.lisp.

Direct superclasses

couchdb-error.

Direct subclasses
Condition: document-not-found
Package

chillax.core.

Source

document.lisp.

Direct superclasses

document-error.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

document-404-id.

Writers

This slot is read-only.

Slot: db
Initargs

:db

Readers

document-404-db.

Writers

This slot is read-only.

Condition: unexpected-response
Package

chillax.core.

Source

server.lisp.

Direct superclasses

couchdb-error.

Direct methods
Direct slots
Slot: status-code
Initargs

:status-code

Readers

error-status-code.

Writers

This slot is read-only.

Slot: response
Initargs

:response

Readers

error-response.

Writers

This slot is read-only.


6.1.8 Classes

Class: standard-database

Minimal, class-based implementation of the database protocol.

Package

chillax.core.

Source

database.lisp.

Direct methods
Direct slots
Slot: server
Initargs

:server

Readers

database-server.

Writers

This slot is read-only.

Slot: name
Readers

database-name.

Writers

This slot is read-only.

Class: standard-server

Default implementation of the server protocol.

Package

chillax.core.

Source

server.lisp.

Direct subclasses

yason-server.

Direct methods
Direct Default Initargs
InitargValue
:host127.0.0.1
:port5984
:usernamenil
:passwordnil
:securepnil
Direct slots
Slot: host
Initargs

:host

Readers

server-host.

Writers

This slot is read-only.

Slot: port
Initargs

:port

Readers

server-port.

Writers

This slot is read-only.

Slot: username
Initargs

:username

Readers

server-username.

Writers

This slot is read-only.

Slot: password
Initargs

:password

Readers

server-password.

Writers

This slot is read-only.

Slot: securep
Initargs

:securep

Readers

server-secure-p.

Writers

This slot is read-only.

Class: yason-server

YASON-SERVERs use Yason’s JSON parser/encoder to automatically translate content going to/coming from the associated CouchDB server.

Package

chillax.yason.

Source

yason.lisp.

Direct superclasses

standard-server.

Direct methods
Direct Default Initargs
InitargValue
:array-as-vector-pnil
:boolean-as-symbol-pnil
:object-as-alist-pnil
:parse-object-key-fun(function identity)
Direct slots
Slot: array-as-vector-p
Initargs

:array-as-vector-p

Readers

parse-json-arrays-as-vectors-p.

Writers

This slot is read-only.

Slot: boolean-as-symbol-p
Initargs

:boolean-as-symbol-p

Readers

parse-json-booleans-as-symbols-p.

Writers

This slot is read-only.

Slot: object-as-alist-p
Initargs

:object-as-alist-p

Readers

parse-object-as-alist-p.

Writers

This slot is read-only.

Slot: parse-object-key-fun
Initargs

:parse-object-key-fun

Readers

parse-object-key-fun.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: +status-codes+

A simple alist of keyword names for HTTP status codes, keyed by status code.

Package

chillax.core.

Source

server.lisp.

Special Variable: +utf-8+
Package

chillax.core.

Source

server.lisp.


6.2.2 Macros

Macro: handle-request ((result-var db uri &rest db-request-keys &key &allow-other-keys) &body expected-responses)

Provides a nice interface to the relatively manual, low-level status-code checking that Chillax uses to understand CouchDB’s responses. The format for EXPECTED-RESPONSES is the same as the CASE macro: The keys should be either keywords, or lists o keywords (not evaluated), which correspond to translated HTTP status code names. See +status-codes+ for all the currently-recognized keywords.

Package

chillax.core.

Source

database.lisp.


6.2.3 Ordinary functions

Function: @ (doc &rest keys)
Package

chillax.utils.

Source

utils.lisp.

Function: (setf @) (doc key &rest more-keys)
Package

chillax.utils.

Source

utils.lisp.

Function: build-view-params (database &key key startkey endkey startkey-docid endkey-docid limit skip descendingp groupp group-level reducep stalep include-docs-p inclusive-end-p &allow-other-keys)
Package

chillax.core.

Source

design-document.lisp.

Function: db-request (db uri &rest all-keys)

Sends a CouchDB request to DB.

Package

chillax.core.

Source

database.lisp.

Function: print-database (db stream)

Objects implementing the database protocol may use this function in their PRINT-OBJECT method.

Package

chillax.core.

Source

database.lisp.

Function: url-encode (string)
Package

chillax.core.

Source

database.lisp.


6.2.4 Generic functions

Generic Reader: conflicting-document (condition)
Package

chillax.core.

Methods
Reader Method: conflicting-document ((condition document-conflict))
Source

document.lisp.

Target Slot

conflicting-doc.

Generic Reader: conflicting-document-id (condition)
Package

chillax.core.

Methods
Reader Method: conflicting-document-id ((condition document-conflict))
Source

document.lisp.

Target Slot

conflicting-doc-id.

Generic Reader: database-error-uri (condition)
Package

chillax.core.

Methods
Reader Method: database-error-uri ((condition database-error))
Source

database.lisp.

Target Slot

uri.

Generic Reader: document-404-db (condition)
Package

chillax.core.

Methods
Reader Method: document-404-db ((condition document-not-found))
Source

document.lisp.

Target Slot

db.

Generic Reader: document-404-id (condition)
Package

chillax.core.

Methods
Reader Method: document-404-id ((condition document-not-found))
Source

document.lisp.

Target Slot

id.

Generic Reader: error-response (condition)
Package

chillax.core.

Methods
Reader Method: error-response ((condition unexpected-response))
Source

server.lisp.

Target Slot

response.

Generic Reader: error-status-code (condition)
Package

chillax.core.

Methods
Reader Method: error-status-code ((condition unexpected-response))
Source

server.lisp.

Target Slot

status-code.

Generic Reader: parse-json-arrays-as-vectors-p (server)
Package

chillax.yason.

Source

yason.lisp.

Methods
Reader Method: parse-json-arrays-as-vectors-p ((yason-server yason-server))

automatically generated reader method

Target Slot

array-as-vector-p.

Generic Reader: parse-json-booleans-as-symbols-p (server)
Package

chillax.yason.

Source

yason.lisp.

Methods
Reader Method: parse-json-booleans-as-symbols-p ((yason-server yason-server))

automatically generated reader method

Target Slot

boolean-as-symbol-p.

Generic Reader: parse-object-as-alist-p (server)
Package

chillax.yason.

Source

yason.lisp.

Methods
Reader Method: parse-object-as-alist-p ((yason-server yason-server))

automatically generated reader method

Target Slot

object-as-alist-p.

Generic Reader: parse-object-key-fun (server)
Package

chillax.yason.

Source

yason.lisp.

Methods
Reader Method: parse-object-key-fun ((yason-server yason-server))

automatically generated reader method

Target Slot

parse-object-key-fun.

Generic Reader: view-404-db (condition)
Package

chillax.core.

Methods
Reader Method: view-404-db ((condition view-not-found))
Source

design-document.lisp.

Target Slot

db.

Generic Reader: view-404-design-document (condition)
Package

chillax.core.

Methods
Reader Method: view-404-design-document ((condition view-not-found))
Source

design-document.lisp.

Target Slot

design-doc.

Generic Reader: view-404-view (condition)
Package

chillax.core.

Methods
Reader Method: view-404-view ((condition view-not-found))
Source

design-document.lisp.

Target Slot

view.


6.2.5 Conditions

Condition: view-not-found
Package

chillax.core.

Source

design-document.lisp.

Direct superclasses

couchdb-error.

Direct methods
Direct slots
Slot: view
Initargs

:view

Readers

view-404-view.

Writers

This slot is read-only.

Slot: design-doc
Initargs

:ddoc

Readers

view-404-design-document.

Writers

This slot is read-only.

Slot: db
Initargs

:db

Readers

view-404-db.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (   @  
A   B   C   D   E   F   G   H   I   J   M   P   Q   R   S   U   V  
Index Entry  Section

(
(setf @): Private ordinary functions
(setf at): Public generic functions
(setf at): Public generic functions
(setf at): Public generic functions
(setf hashget): Public ordinary functions

@
@: Private ordinary functions

A
active-tasks: Public ordinary functions
all-dbs: Public ordinary functions
all-documents: Public ordinary functions
at: Public generic functions
at: Public generic functions
at: Public generic functions

B
batch-get-documents: Public ordinary functions
build-view-params: Private ordinary functions
bulk-post-documents: Public ordinary functions

C
compact-design-doc: Public ordinary functions
Compiler Macro, hashget: Public compiler macros
config-info: Public ordinary functions
conflicting-document: Private generic functions
conflicting-document: Private generic functions
conflicting-document-id: Private generic functions
conflicting-document-id: Private generic functions
copy-attachment: Public ordinary functions
copy-document: Public ordinary functions
couch-request: Public ordinary functions

D
data->json: Public generic functions
data->json: Public generic functions
data->json: Public generic functions
database-error-uri: Private generic functions
database-error-uri: Private generic functions
database-name: Public generic functions
database-name: Public generic functions
database-server: Public generic functions
database-server: Public generic functions
db-changes: Public ordinary functions
db-compact: Public ordinary functions
db-connect: Public ordinary functions
db-create: Public ordinary functions
db-delete: Public ordinary functions
db-info: Public ordinary functions
db-request: Private ordinary functions
db-uri: Public ordinary functions
delete-attachment: Public ordinary functions
delete-document: Public ordinary functions
dequote: Public ordinary functions
design-doc-info: Public ordinary functions
document-404-db: Private generic functions
document-404-db: Private generic functions
document-404-id: Private generic functions
document-404-id: Private generic functions

E
ensure-db: Public ordinary functions
error-response: Private generic functions
error-response: Private generic functions
error-status-code: Private generic functions
error-status-code: Private generic functions

F
fun: Public macros
Function, (setf @): Private ordinary functions
Function, (setf hashget): Public ordinary functions
Function, @: Private ordinary functions
Function, active-tasks: Public ordinary functions
Function, all-dbs: Public ordinary functions
Function, all-documents: Public ordinary functions
Function, batch-get-documents: Public ordinary functions
Function, build-view-params: Private ordinary functions
Function, bulk-post-documents: Public ordinary functions
Function, compact-design-doc: Public ordinary functions
Function, config-info: Public ordinary functions
Function, copy-attachment: Public ordinary functions
Function, copy-document: Public ordinary functions
Function, couch-request: Public ordinary functions
Function, db-changes: Public ordinary functions
Function, db-compact: Public ordinary functions
Function, db-connect: Public ordinary functions
Function, db-create: Public ordinary functions
Function, db-delete: Public ordinary functions
Function, db-info: Public ordinary functions
Function, db-request: Private ordinary functions
Function, db-uri: Public ordinary functions
Function, delete-attachment: Public ordinary functions
Function, delete-document: Public ordinary functions
Function, dequote: Public ordinary functions
Function, design-doc-info: Public ordinary functions
Function, ensure-db: Public ordinary functions
Function, get-attachment: Public ordinary functions
Function, get-document: Public ordinary functions
Function, get-document-revision: Public ordinary functions
Function, get-uuids: Public ordinary functions
Function, hashget: Public ordinary functions
Function, mkhash: Public ordinary functions
Function, post-document: Public ordinary functions
Function, print-database: Private ordinary functions
Function, put-attachment: Public ordinary functions
Function, put-document: Public ordinary functions
Function, query-temporary-view: Public ordinary functions
Function, query-view: Public ordinary functions
Function, replicate: Public ordinary functions
Function, server-uri: Public ordinary functions
Function, stats: Public ordinary functions
Function, strcat: Public ordinary functions
Function, url-encode: Private ordinary functions
Function, view-cleanup: Public ordinary functions

G
Generic Function, (setf at): Public generic functions
Generic Function, at: Public generic functions
Generic Function, conflicting-document: Private generic functions
Generic Function, conflicting-document-id: Private generic functions
Generic Function, data->json: Public generic functions
Generic Function, database-error-uri: Private generic functions
Generic Function, database-name: Public generic functions
Generic Function, database-server: Public generic functions
Generic Function, document-404-db: Private generic functions
Generic Function, document-404-id: Private generic functions
Generic Function, error-response: Private generic functions
Generic Function, error-status-code: Private generic functions
Generic Function, json->data: Public generic functions
Generic Function, make-db-object: Public generic functions
Generic Function, parse-json-arrays-as-vectors-p: Private generic functions
Generic Function, parse-json-booleans-as-symbols-p: Private generic functions
Generic Function, parse-object-as-alist-p: Private generic functions
Generic Function, parse-object-key-fun: Private generic functions
Generic Function, server-host: Public generic functions
Generic Function, server-password: Public generic functions
Generic Function, server-port: Public generic functions
Generic Function, server-secure-p: Public generic functions
Generic Function, server-username: Public generic functions
Generic Function, view-404-db: Private generic functions
Generic Function, view-404-design-document: Private generic functions
Generic Function, view-404-view: Private generic functions
get-attachment: Public ordinary functions
get-document: Public ordinary functions
get-document-revision: Public ordinary functions
get-uuids: Public ordinary functions

H
handle-request: Private macros
hashget: Public compiler macros
hashget: Public ordinary functions

I
initialize-instance: Public standalone methods

J
json->data: Public generic functions
json->data: Public generic functions
json->data: Public generic functions

M
Macro, fun: Public macros
Macro, handle-request: Private macros
make-db-object: Public generic functions
make-db-object: Public generic functions
Method, (setf at): Public generic functions
Method, (setf at): Public generic functions
Method, at: Public generic functions
Method, at: Public generic functions
Method, conflicting-document: Private generic functions
Method, conflicting-document-id: Private generic functions
Method, data->json: Public generic functions
Method, data->json: Public generic functions
Method, database-error-uri: Private generic functions
Method, database-name: Public generic functions
Method, database-server: Public generic functions
Method, document-404-db: Private generic functions
Method, document-404-id: Private generic functions
Method, error-response: Private generic functions
Method, error-status-code: Private generic functions
Method, initialize-instance: Public standalone methods
Method, json->data: Public generic functions
Method, json->data: Public generic functions
Method, make-db-object: Public generic functions
Method, parse-json-arrays-as-vectors-p: Private generic functions
Method, parse-json-booleans-as-symbols-p: Private generic functions
Method, parse-object-as-alist-p: Private generic functions
Method, parse-object-key-fun: Private generic functions
Method, print-object: Public standalone methods
Method, server-host: Public generic functions
Method, server-password: Public generic functions
Method, server-port: Public generic functions
Method, server-secure-p: Public generic functions
Method, server-username: Public generic functions
Method, view-404-db: Private generic functions
Method, view-404-design-document: Private generic functions
Method, view-404-view: Private generic functions
mkhash: Public ordinary functions

P
parse-json-arrays-as-vectors-p: Private generic functions
parse-json-arrays-as-vectors-p: Private generic functions
parse-json-booleans-as-symbols-p: Private generic functions
parse-json-booleans-as-symbols-p: Private generic functions
parse-object-as-alist-p: Private generic functions
parse-object-as-alist-p: Private generic functions
parse-object-key-fun: Private generic functions
parse-object-key-fun: Private generic functions
post-document: Public ordinary functions
print-database: Private ordinary functions
print-object: Public standalone methods
put-attachment: Public ordinary functions
put-document: Public ordinary functions

Q
query-temporary-view: Public ordinary functions
query-view: Public ordinary functions

R
replicate: Public ordinary functions

S
server-host: Public generic functions
server-host: Public generic functions
server-password: Public generic functions
server-password: Public generic functions
server-port: Public generic functions
server-port: Public generic functions
server-secure-p: Public generic functions
server-secure-p: Public generic functions
server-uri: Public ordinary functions
server-username: Public generic functions
server-username: Public generic functions
stats: Public ordinary functions
strcat: Public ordinary functions

U
url-encode: Private ordinary functions

V
view-404-db: Private generic functions
view-404-db: Private generic functions
view-404-design-document: Private generic functions
view-404-design-document: Private generic functions
view-404-view: Private generic functions
view-404-view: Private generic functions
view-cleanup: Public ordinary functions


A.3 Variables

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

*
*chillax-version*: Public special variables

+
+status-codes+: Private special variables
+utf-8+: Private special variables

A
array-as-vector-p: Public classes

B
boolean-as-symbol-p: Public classes

C
conflicting-doc: Public conditions
conflicting-doc-id: Public conditions

D
db: Public conditions
db: Private conditions
design-doc: Private conditions

H
host: Public classes

I
id: Public conditions

N
name: Public classes

O
object-as-alist-p: Public classes

P
parse-object-key-fun: Public classes
password: Public classes
port: Public classes

R
response: Public conditions

S
securep: Public classes
server: Public classes
Slot, array-as-vector-p: Public classes
Slot, boolean-as-symbol-p: Public classes
Slot, conflicting-doc: Public conditions
Slot, conflicting-doc-id: Public conditions
Slot, db: Public conditions
Slot, db: Private conditions
Slot, design-doc: Private conditions
Slot, host: Public classes
Slot, id: Public conditions
Slot, name: Public classes
Slot, object-as-alist-p: Public classes
Slot, parse-object-key-fun: Public classes
Slot, password: Public classes
Slot, port: Public classes
Slot, response: Public conditions
Slot, securep: Public classes
Slot, server: Public classes
Slot, status-code: Public conditions
Slot, uri: Public conditions
Slot, username: Public classes
Slot, view: Private conditions
Special Variable, *chillax-version*: Public special variables
Special Variable, +status-codes+: Private special variables
Special Variable, +utf-8+: Private special variables
status-code: Public conditions

U
uri: Public conditions
username: Public classes

V
view: Private conditions


A.4 Data types

Jump to:   C   D   F   M   P   S   U   V   Y  
Index Entry  Section

C
chillax: The chillax system
chillax: The chillax package
chillax.asd: The chillax/chillax․asd file
chillax.core: The chillax․core system
chillax.core: The chillax․core package
chillax.core.asd: The chillax․core/chillax․core․asd file
chillax.lisp: The chillax/src/chillax․lisp file
chillax.utils: The chillax․utils package
chillax.yason: The chillax․yason system
chillax.yason: The chillax․yason package
chillax.yason.asd: The chillax․yason/chillax․yason․asd file
Class, standard-database: Public classes
Class, standard-server: Public classes
Class, yason-server: Public classes
Condition, couchdb-error: Public conditions
Condition, database-error: Public conditions
Condition, db-already-exists: Public conditions
Condition, db-not-found: Public conditions
Condition, document-conflict: Public conditions
Condition, document-error: Public conditions
Condition, document-not-found: Public conditions
Condition, unexpected-response: Public conditions
Condition, view-not-found: Private conditions
core: The chillax․core/src/core module
couchdb-error: Public conditions

D
database-error: Public conditions
database.lisp: The chillax․core/src/core/database․lisp file
db-already-exists: Public conditions
db-not-found: Public conditions
design-document.lisp: The chillax․core/src/core/design-document․lisp file
document-conflict: Public conditions
document-error: Public conditions
document-not-found: Public conditions
document.lisp: The chillax․core/src/core/document․lisp file

F
File, chillax.asd: The chillax/chillax․asd file
File, chillax.core.asd: The chillax․core/chillax․core․asd file
File, chillax.lisp: The chillax/src/chillax․lisp file
File, chillax.yason.asd: The chillax․yason/chillax․yason․asd file
File, database.lisp: The chillax․core/src/core/database․lisp file
File, design-document.lisp: The chillax․core/src/core/design-document․lisp file
File, document.lisp: The chillax․core/src/core/document․lisp file
File, package.lisp: The chillax․core/src/core/package․lisp file
File, server.lisp: The chillax․core/src/core/server․lisp file
File, utils.lisp: The chillax․core/src/utils․lisp file
File, yason.lisp: The chillax․yason/src/yason․lisp file

M
Module, core: The chillax․core/src/core module
Module, src: The chillax/src module
Module, src: The chillax․core/src module
Module, src: The chillax․yason/src module

P
Package, chillax: The chillax package
Package, chillax.core: The chillax․core package
Package, chillax.utils: The chillax․utils package
Package, chillax.yason: The chillax․yason package
package.lisp: The chillax․core/src/core/package․lisp file

S
server.lisp: The chillax․core/src/core/server․lisp file
src: The chillax/src module
src: The chillax․core/src module
src: The chillax․yason/src module
standard-database: Public classes
standard-server: Public classes
System, chillax: The chillax system
System, chillax.core: The chillax․core system
System, chillax.yason: The chillax․yason system

U
unexpected-response: Public conditions
utils.lisp: The chillax․core/src/utils․lisp file

V
view-not-found: Private conditions

Y
yason-server: Public classes
yason.lisp: The chillax․yason/src/yason․lisp file