The cl-mango Reference Manual

This is the cl-mango Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:13:05 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-mango

A minimalist CouchDB 2.x database client.

Author

Clint Moore <>

License

BSD3

Dependencies
  • drakma (system).
  • yason (system).
  • json-mop (system).
Source

cl-mango.asd.

Child Component

cl-mango.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-mango/cl-mango.asd

Source

cl-mango.asd.

Parent Component

cl-mango (system).

ASDF Systems

cl-mango.


3.1.2 cl-mango/cl-mango.lisp

Source

cl-mango.asd.

Parent Component

cl-mango (system).

Packages

cl-mango.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-mango

Source

cl-mango.lisp.

Nicknames
  • mango
  • mango
Use List
  • common-lisp.
  • json-mop.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *explain*
Package

cl-mango.

Source

cl-mango.lisp.

Special Variable: *host*
Package

cl-mango.

Source

cl-mango.lisp.

Special Variable: *password*
Package

cl-mango.

Source

cl-mango.lisp.

Special Variable: *port*
Package

cl-mango.

Source

cl-mango.lisp.

Special Variable: *scheme*
Package

cl-mango.

Source

cl-mango.lisp.

Special Variable: *username*
Package

cl-mango.

Source

cl-mango.lisp.


5.1.2 Macros

Macro: couch-query (database selector &rest args)
Package

cl-mango.

Source

cl-mango.lisp.

Macro: defmango (name database slot-definitions)
Package

cl-mango.

Source

cl-mango.lisp.

Macro: make-selector (selector &key limit fields sort skip stale use-index r bookmark update stable execution-stats)
Package

cl-mango.

Source

cl-mango.lisp.

Macro: query-view (db view index parameters)
Package

cl-mango.

Source

cl-mango.lisp.


5.1.3 Ordinary functions

Function: bulk-docs (db bundle)
Package

cl-mango.

Source

cl-mango.lisp.

Function: doc-batch-put (db bundle)
Package

cl-mango.

Source

cl-mango.lisp.

Function: doc-delete (db docid revision)
Package

cl-mango.

Source

cl-mango.lisp.

Function: doc-find (db query)
Package

cl-mango.

Source

cl-mango.lisp.

Function: doc-get (db docid)
Package

cl-mango.

Source

cl-mango.lisp.

Function: doc-get-all (db &key all-docs)
Package

cl-mango.

Source

cl-mango.lisp.

Function: doc-put (db bundle)
Package

cl-mango.

Source

cl-mango.lisp.


5.1.4 Conditions

Condition: unexpected-http-response
Package

cl-mango.

Source

cl-mango.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: status-code
Initform

(quote nil)

Initargs

:status-code

Readers

status-code.

Writers

This slot is read-only.

Slot: status-body
Initform

(quote nil)

Initargs

:body

Readers

status-body.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Macros

Macro: couchdb-request (path &key parameters content method content-type accept preserve-uri)
Package

cl-mango.

Source

cl-mango.lisp.


5.2.2 Ordinary functions

Function: %json-to-clos (bundle class &key doc-name)
Package

cl-mango.

Source

cl-mango.lisp.

Function: allowed-slot-p (class name)
Package

cl-mango.

Source

cl-mango.lisp.

Function: make-request-uri (req-path)
Package

cl-mango.

Source

cl-mango.lisp.

Function: mango-find (db class query)
Package

cl-mango.

Source

cl-mango.lisp.

Function: mango-get-all (db class)
Package

cl-mango.

Source

cl-mango.lisp.

Function: mango-update (db object)
Package

cl-mango.

Source

cl-mango.lisp.

Function: symb (a b)
Package

cl-mango.

Source

cl-mango.lisp.


5.2.3 Generic functions

Generic Reader: status-body (condition)
Package

cl-mango.

Methods
Reader Method: status-body ((condition unexpected-http-response))
Source

cl-mango.lisp.

Target Slot

status-body.

Generic Reader: status-code (condition)
Package

cl-mango.

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

cl-mango.lisp.

Target Slot

status-code.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
A   B   C   D   F   G   M   Q   S  
Index Entry  Section

%
%json-to-clos: Private ordinary functions

A
allowed-slot-p: Private ordinary functions

B
bulk-docs: Public ordinary functions

C
couch-query: Public macros
couchdb-request: Private macros

D
defmango: Public macros
doc-batch-put: Public ordinary functions
doc-delete: Public ordinary functions
doc-find: Public ordinary functions
doc-get: Public ordinary functions
doc-get-all: Public ordinary functions
doc-put: Public ordinary functions

F
Function, %json-to-clos: Private ordinary functions
Function, allowed-slot-p: Private ordinary functions
Function, bulk-docs: Public ordinary functions
Function, doc-batch-put: Public ordinary functions
Function, doc-delete: Public ordinary functions
Function, doc-find: Public ordinary functions
Function, doc-get: Public ordinary functions
Function, doc-get-all: Public ordinary functions
Function, doc-put: Public ordinary functions
Function, make-request-uri: Private ordinary functions
Function, mango-find: Private ordinary functions
Function, mango-get-all: Private ordinary functions
Function, mango-update: Private ordinary functions
Function, symb: Private ordinary functions

G
Generic Function, status-body: Private generic functions
Generic Function, status-code: Private generic functions

M
Macro, couch-query: Public macros
Macro, couchdb-request: Private macros
Macro, defmango: Public macros
Macro, make-selector: Public macros
Macro, query-view: Public macros
make-request-uri: Private ordinary functions
make-selector: Public macros
mango-find: Private ordinary functions
mango-get-all: Private ordinary functions
mango-update: Private ordinary functions
Method, status-body: Private generic functions
Method, status-code: Private generic functions

Q
query-view: Public macros

S
status-body: Private generic functions
status-body: Private generic functions
status-code: Private generic functions
status-code: Private generic functions
symb: Private ordinary functions