This is the cl-ohm Reference Manual, version 0.2.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:17:27 2024 GMT+0.
cl-ohm/cl-ohm.asd
cl-ohm/package.lisp
cl-ohm/utils.lisp
cl-ohm/connection.lisp
cl-ohm/conditions.lisp
cl-ohm/mop.lisp
cl-ohm/ohm-object.lisp
cl-ohm/ohm-counter.lisp
cl-ohm/ohm-collection.lisp
cl-ohm/ohm-list.lisp
cl-ohm/ohm-set-algebra.lisp
cl-ohm/ohm-set.lisp
cl-ohm/cl-ohm.lisp
The main system appears first, followed by any subsystem dependency.
cl-ohm
An object-hash mapping for Redis in Common Lisp
Sebastian Christ <rudolfo.christ@gmail.com>
(GIT git@github.com:rudolfochrist/cl-ohm.git)
MIT
0.2.1
alexandria
(system).
closer-mop
(system).
cl-redis
(system).
package.lisp
(file).
utils.lisp
(file).
connection.lisp
(file).
conditions.lisp
(file).
mop.lisp
(file).
ohm-object.lisp
(file).
ohm-counter.lisp
(file).
ohm-collection.lisp
(file).
ohm-list.lisp
(file).
ohm-set-algebra.lisp
(file).
ohm-set.lisp
(file).
cl-ohm.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-ohm/cl-ohm.asd
cl-ohm/package.lisp
cl-ohm/utils.lisp
cl-ohm/connection.lisp
cl-ohm/conditions.lisp
cl-ohm/mop.lisp
cl-ohm/ohm-object.lisp
cl-ohm/ohm-counter.lisp
cl-ohm/ohm-collection.lisp
cl-ohm/ohm-list.lisp
cl-ohm/ohm-set-algebra.lisp
cl-ohm/ohm-set.lisp
cl-ohm/cl-ohm.lisp
cl-ohm/utils.lisp
package.lisp
(file).
cl-ohm
(system).
onep
(function).
cl-ohm/connection.lisp
utils.lisp
(file).
cl-ohm
(system).
flush-db
(function).
setup-redis-connection
(function).
with-connection
(macro).
with-transaction
(macro).
*connection-parameters*
(special variable).
*default-connection-parameters*
(special variable).
cl-ohm/conditions.lisp
connection.lisp
(file).
cl-ohm
(system).
ohm-missing-id-error
(condition).
ohm-no-index-found-error
(condition).
ohm-unique-constraint-violation
(condition).
cl-ohm/mop.lisp
conditions.lisp
(file).
cl-ohm
(system).
compute-effective-slot-definition
(method).
direct-slot-definition-class
(method).
effective-slot-definition-class
(method).
validate-superclass
(method).
counterp
(reader method).
(setf counterp)
(writer method).
element-type
(reader method).
(setf element-type)
(writer method).
indexp
(reader method).
(setf indexp)
(writer method).
list-attr-p
(reader method).
(setf list-attr-p)
(writer method).
ohm-class
(class).
ohm-direct-slot-definition
(class).
ohm-effective-slot-definition
(class).
ohm-slot-definition-mixin
(class).
set-attr-p
(reader method).
(setf set-attr-p)
(writer method).
uniquep
(reader method).
(setf uniquep)
(writer method).
cl-ohm/ohm-object.lisp
mop.lisp
(file).
cl-ohm
(system).
define-ohm-model
(macro).
initialize-instance
(method).
ohm-id
(reader method).
print-object
(method).
fetch
(function).
fetch-one
(function).
keys
(function).
normalize-plist
(function).
object->plist
(function).
ohm-object
(class).
plist->object
(function).
cl-ohm/ohm-counter.lisp
ohm-object.lisp
(file).
cl-ohm
(system).
counter-key
(reader method).
counter-name
(reader method).
ohm-counter
(class).
cl-ohm/ohm-collection.lisp
ohm-counter.lisp
(file).
cl-ohm
(system).
element-type
(reader method).
key
(reader method).
ohm-collection
(class).
cl-ohm/ohm-list.lisp
ohm-collection.lisp
(file).
cl-ohm
(system).
add
(method).
add-left
(generic function).
elements
(method).
first
(generic function).
index
(generic function).
last
(generic function).
list-ids
(generic function).
member
(method).
pop
(generic function).
pop-left
(generic function).
range
(generic function).
remove
(method).
replace
(method).
size
(method).
cl-ohm/ohm-set-algebra.lisp
ohm-list.lisp
(file).
cl-ohm
(system).
*commands*
(special variable).
command
(function).
compile-expr
(function).
convert-expr
(function).
execute
(function).
explain
(function).
cl-ohm/ohm-set.lisp
ohm-set-algebra.lisp
(file).
cl-ohm
(system).
assert-same-type
(macro).
generic-set-operation
(function).
make-sort-key
(function).
ohm-set
(class).
cl-ohm/cl-ohm.lisp
ohm-set.lisp
(file).
cl-ohm
(system).
class-key
(generic function).
create
(function).
del
(generic function).
filter
(function).
filter-id
(generic function).
filter-with
(function).
object-key
(generic function).
save
(generic function).
*class-indices*
(special variable).
*global-object-counter*
(special variable).
check-uniques
(function).
create-indices
(function).
ensure-id
(function).
make-key
(function).
map-attributes
(function).
map-indices
(function).
remove-uniques
(function).
Packages are listed by definition order.
cl-ohm
Object-hash mapping for Redis.
ohm
common-lisp
.
add
(generic function).
add-left
(generic function).
class-key
(generic function).
combine
(generic function).
counter
(generic function).
create
(function).
decr
(generic function).
define-ohm-model
(macro).
del
(generic function).
elements
(generic function).
except
(generic function).
filter
(function).
filter-id
(generic function).
filter-with
(function).
find-id
(generic function).
first
(generic function).
flush-db
(function).
incr
(generic function).
index
(generic function).
last
(generic function).
list-ids
(generic function).
member
(generic function).
object-key
(generic function).
ohm-id
(generic reader).
ohm-missing-id-error
(condition).
ohm-no-index-found-error
(condition).
ohm-unique-constraint-violation
(condition).
pop
(generic function).
pop-left
(generic function).
range
(generic function).
remove
(generic function).
replace
(generic function).
save
(generic function).
set-ids
(generic function).
setup-redis-connection
(function).
size
(generic function).
sort
(generic function).
sort-by
(generic function).
union
(generic function).
with-connection
(macro).
with-transaction
(macro).
*class-indices*
(special variable).
*commands*
(special variable).
*connection-parameters*
(special variable).
*default-connection-parameters*
(special variable).
*global-object-counter*
(special variable).
access
(function).
assert-same-type
(macro).
attribute
(generic reader).
check-uniques
(function).
command
(function).
compile-expr
(function).
convert-expr
(function).
counter-key
(generic reader).
counter-name
(generic reader).
counterp
(generic reader).
(setf counterp)
(generic writer).
create-indices
(function).
element-type
(generic reader).
(setf element-type)
(generic writer).
ensure-id
(function).
execute
(function).
explain
(function).
fetch
(function).
fetch-one
(function).
generic-set-operation
(function).
indexp
(generic reader).
(setf indexp)
(generic writer).
key
(generic reader).
keys
(function).
list-attr-p
(generic reader).
(setf list-attr-p)
(generic writer).
make-key
(function).
make-sort-key
(function).
map-attributes
(function).
map-indices
(function).
normalize-plist
(function).
object->plist
(function).
ohm-class
(class).
ohm-collection
(class).
ohm-counter
(class).
ohm-direct-slot-definition
(class).
ohm-effective-slot-definition
(class).
ohm-error
(condition).
ohm-list
(class).
ohm-object
(class).
ohm-set
(class).
ohm-slot-definition-mixin
(class).
onep
(function).
plist->object
(function).
remove-uniques
(function).
set-attr-p
(generic reader).
(setf set-attr-p)
(generic writer).
uniquep
(generic reader).
(setf uniquep)
(generic writer).
value
(generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Creates a persisted instance of NAME.
Find objects in the data store.
If no keyword arguments are given, all objects of
CLASS-NAME fetched.
Find an object with unique value. e.g. (find-one ’user :email "foo@foo.com")
Erase the data store.
Configure Redis backend.
Adds a ELEMENT to the COLLECTION. ELEMENT must be a persistable object.
ohm-set
) (element ohm-object
)) ¶ohm-list
) (element ohm-object
)) ¶ohm-collection
) (element ohm-object
)) ¶Add ELEMENT to the left side of LIST.
ohm-list
) (element ohm-object
)) ¶ohm-list
) (element ohm-object
)) ¶Creates a persistence key for class of OBJECT.
ohm-object
) &rest segments) ¶Combines SET1 and SET2. Some would say intersection.
Retrieves the value of the counter COUNTER/
ohm-counter
)) ¶Decrements COUNTER by DECREMENT.
ohm-counter
) &optional decrement) ¶Removes OBJECT from the data store.
ohm-object
)) ¶ohm-object
)) ¶Returns all elements in COLLECTION.
Removes elements from SET1 that are also in SET2. Same people would say set-difference.
Retrieves an object by id from the data store.
Checks if ID is a member of SET.
Returns the first element of the LIST.
Increments COUNTER by INCREMENT.
ohm-counter
) &optional increment) ¶Returns the element with INDEX from LIST.
Returns the last element of the LIST.
Returns the IDs stored in COLLECTION.
Checks if ELEMENT is a member of COLLECTION.
ohm-set
) (element ohm-object
)) ¶ohm-list
) (element ohm-object
)) ¶ohm-collection
) (element ohm-object
)) ¶Creates a persistence key for OBJECT.
ohm-object
) &rest segments) ¶ohm-object
) &rest segments) ¶ohm-object
)) ¶automatically generated reader method
id
.
Removes and returns an the right outermost element from the LIST.
Removes and returns the left outermost element of the LIST.
Returns a sublist of LIST from START to STOP.
Removes ELEMENT from the COLLECTION.
ohm-set
) (element ohm-object
)) ¶ohm-list
) (element ohm-object
)) ¶ohm-collection
) (element ohm-object
)) ¶Replaces the COLLECTION’s elements with NEW-ELEMENTS.
Saves an object into the data store.
ohm-object
)) ¶ohm-object
)) ¶Returns the IDs contained in SET.
Returns the number of elements in the COLLECTION.
Sorts the SET.
Sorts the objects in SET by it’s property KEY.
Union two sets. ARGS are used for FILTER.
ohm-object
) &key) ¶ohm-object
) stream) ¶ohm-class
) (superclass standard-class
)) ¶sb-mop
.
Mapping of which class defined which indices.
Command mappings.
Returns an object if pop-func delivers an id.
Checks for constraints on object properties.
Create indices for attributes with :indexp t.
Loads objects from the data store.
Load one object from the data store.
Makes a list of keys for the given NAMESPACE and IDS.
Creates a sort key for the element type of SET. ATTRIBUTE can either be a keyword, symbol or string.
Generates as list of index keys from ATTRIBUTES.
Creates a list of index key for ATTRIBUTE and VALUE.
Creates a proper plist of the given TUPLE.
Creates a plist of OBJECT’s attributes.
Checks if NUMBER is equal to 1.
Creates an instance of CLASS-NAME with initargs found in plist.
ohm-no-index-found-error
)) ¶ohm-counter
)) ¶automatically generated reader method
key
.
ohm-counter
)) ¶automatically generated reader method
name
.
ohm-slot-definition-mixin
)) ¶ohm-slot-definition-mixin
)) ¶Defines an attribute as counter.
ohm-slot-definition-mixin
)) ¶ohm-slot-definition-mixin
)) ¶Specifies the element type for lists or sets.
ohm-collection
)) ¶automatically generated reader method
ohm-slot-definition-mixin
)) ¶ohm-slot-definition-mixin
)) ¶Creates an index for this slot if indexp is T.
ohm-collection
)) ¶automatically generated reader method
key
.
ohm-slot-definition-mixin
)) ¶ohm-slot-definition-mixin
)) ¶Defines an attribute as list.
ohm-slot-definition-mixin
)) ¶ohm-slot-definition-mixin
)) ¶Defines an attribute as set.
ohm-slot-definition-mixin
)) ¶ohm-slot-definition-mixin
)) ¶Indicates that values stored in this attribute must be unique between all instances.
ohm-unique-constraint-violation
)) ¶standard-class
.
:element-type
This slot is read-only.
ohm-slot-definition-mixin
.
standard-direct-slot-definition
.
ohm-slot-definition-mixin
.
standard-effective-slot-definition
.
Creates an index for this slot if indexp is T.
:indexp
Indicates that values stored in this attribute must be unique between all instances.
:uniquep
Defines an attribute as counter.
:counterp
Defines an attribute as list.
:list-attr-p
Defines an attribute as set.
:set-attr-p
Specifies the element type for lists or sets.
:element-type
Jump to: | (
A C D E F G I K L M N O P R S U V W |
---|
Jump to: | (
A C D E F G I K L M N O P R S U V W |
---|
Jump to: | *
A C E I K L N S U V |
---|
Jump to: | *
A C E I K L N S U V |
---|
Jump to: | C F M O P S U |
---|
Jump to: | C F M O P S U |
---|