This is the oook Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:08:59 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
oookSome magic on the shoulders of CLSQL
Ric da Silva <ric@rmhsilva.com>
MIT
0.2.0
alexandria (system).
anaphora (system).
cl-inflector (system).
closer-mop (system).
clsql (system).
jonathan (system).
parse-number (system).
semantic-spinneret (system).
spinneret (system).
src (module).
Modules are listed depth-first from the system components tree.
oook/srcoook (system).
package.lisp (file).
utils.lisp (file).
serialise.lisp (file).
html.lisp (file).
methods.lisp (file).
macro.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
oook/oook.asdoook/src/package.lispoook/src/utils.lispoook/src/serialise.lispoook/src/html.lispoook/src/methods.lispoook/src/macro.lispoook/src/utils.lispsrc (module).
def-enhanced-printer (macro).
parse-as-type (function).
search-like (function).
sql-field (function).
ensure-integer (function).
ensure-slot-type (macro).
sql-field-keyword (function).
oook/src/serialise.lispsrc (module).
*serialisation-options* (special variable).
from-alist (function).
pprint-model (function).
to-alist (function).
with-serialisation-options (macro).
get-slot-type (function).
oook/src/html.lispsrc (module).
gen-html-table (function).
get-edit-form (function).
with-record-type (macro).
all-same-type-p (function).
field-for-normal-slot (function).
field-label-for (function).
field-name-for (function).
slot-type-without-null (function).
oook/src/methods.lispsrc (module).
destroy (function).
filter (function).
find-by-id (function).
save (function).
do-each-owns-many (macro).
new-row-p (function).
update-owns-many (function).
update-timestamps (function).
oook/src/macro.lispsrc (module).
*default-slot-type* (special variable).
created-at (generic function).
defmodel (macro).
foreign-key (generic function).
id (generic function).
join-fks (generic function).
last-modified (generic function).
owns-many (generic function).
owns-one (generic function).
serialisable-fields (generic function).
serialisable-joins (generic function).
make-clsql-base-slot (function).
make-clsql-join-slot (function).
make-clsql-key-slot (function).
make-foreign-key (function).
Packages are listed by definition order.
oook.methodscommon-lisp.
destroy (function).
filter (function).
find-by-id (function).
save (function).
do-each-owns-many (macro).
new-row-p (function).
update-owns-many (function).
update-timestamps (function).
oook.utilscommon-lisp.
def-enhanced-printer (macro).
parse-as-type (function).
search-like (function).
sql-field (function).
ensure-integer (function).
ensure-slot-type (macro).
sql-field-keyword (function).
oook.macroDefines the ‘defmodel’ macro, and the associated functions
macro
common-lisp.
*default-slot-type* (special variable).
created-at (generic function).
defmodel (macro).
foreign-key (generic function).
id (generic function).
join-fks (generic function).
last-modified (generic function).
owns-many (generic function).
owns-one (generic function).
serialisable-fields (generic function).
serialisable-joins (generic function).
make-clsql-base-slot (function).
make-clsql-join-slot (function).
make-clsql-key-slot (function).
make-foreign-key (function).
oook.serialiseA set of serialisation utilities, including to/from alists, to json (using jonathan)
common-lisp.
*serialisation-options* (special variable).
from-alist (function).
gen-html-table (function).
get-edit-form (function).
pprint-model (function).
to-alist (function).
with-record-type (macro).
with-serialisation-options (macro).
all-same-type-p (function).
field-for-normal-slot (function).
field-label-for (function).
field-name-for (function).
get-slot-type (function).
slot-type-without-null (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Options that control how objects are serialised
Enhances ‘print-object’ for ‘type’, adding the ‘slot’ attribute to it
Define a class that models DB structure
Execute ‘body’ with json options set to ‘options’
Delete ‘inst’ and associated models
Find a model with ‘id’
Create an instance of ‘class’, given ‘alist’ containing mapping of slots to values, in caveman2 parsed params format.
Print an HTML table listing the data in ‘records’
Try to parse ‘type’ from input ‘value’
Pretty print ‘inst’
Save ‘inst’ and associated models
Search the DB for ‘model’ using LIKE to match column. If ‘singlep’ is t, only one result is returned
Make ‘symbol’ suitable for SQL name
Return an a-list representation of ‘inst’
Read the ‘id’ attribute
Return the foreign keys for models in has-one and belongs-to
Return the slots in ‘inst’ that will be included when ‘to-alist’ is called
For each model in the owns-many relation of ‘inst’, execute ‘body’ with the symbol ‘right’ bound to the model type, and the symbol ‘value’ bound to the current slot-value of the relation
Create form to ensure that ‘slot’ in ‘inst’ is of type ‘type’
Check everything in ‘records’ is the same type
Return ‘thing’ as an integer
Get the type of ‘slot’ in ‘class’
Create a clsql base slot form from ‘slot’
Create a clsql foreign key slot form from ‘slot’
Create a foreign key (append _id) for symbol
Return T if ‘inst’ does not have a row in the DB
If a slot type is something like (OR NULL BOOLEAN), return just BOOLEAN
Make ‘symbol’ suitable for a field name as a keyword
Remove all olds that are no longer in new, and add the new!
Update the ‘created-at’ and ‘last-modified’ timestamps in ‘inst’
| Jump to: | A C D E F G I J L M N O P S T U W |
|---|
| Jump to: | A C D E F G I J L M N O P S T U W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | F H M O P S U |
|---|
| Jump to: | F H M O P S U |
|---|