This is the orizuru-orm Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:17:06 2024 GMT+0.
orizuru-orm/orizuru-orm.asd
orizuru-orm/src/package.lisp
orizuru-orm/src/constants.lisp
orizuru-orm/src/errors.lisp
orizuru-orm/src/config.lisp
orizuru-orm/src/util.lisp
orizuru-orm/src/query-low-level.lisp
orizuru-orm/src/connect.lisp
orizuru-orm/src/types.lisp
orizuru-orm/src/sql.lisp
orizuru-orm/src/meta.lisp
orizuru-orm/src/query.lisp
orizuru-orm/src/migration.lisp
orizuru-orm/src/table.lisp
orizuru-orm/src/inflate-deflate.lisp
orizuru-orm/src/interface.lisp
orizuru-orm/src/fixture.lisp
orizuru-orm/src/transaction.lisp
orizuru-orm/src/query-set.lisp
orizuru-orm.util
orizuru-orm
orizuru-orm.fixture
orizuru-orm.query-set
orizuru-orm.query
orizuru-orm.meta
orizuru-orm.sql
orizuru-orm.transaction
orizuru-orm.inflate-deflate
orizuru-orm.config
orizuru-orm.interface
orizuru-orm.types
orizuru-orm.connect
orizuru-orm.query.lowlevel
orizuru-orm.constants
orizuru-orm.errors
orizuru-orm.table
orizuru-orm.migration
The main system appears first, followed by any subsystem dependency.
orizuru-orm
An ORM for Common Lisp and PostgreSQL.
cage
Fernando Borretti, cage
GPLv3
0.0.1
alexandria
(system).
closer-mop
(system).
cl-ppcre-unicode
(system).
anaphora
(system).
sxql
(system).
dbi
(system).
iterate
(system).
cl-fad
(system).
clos-fixtures
(system).
uiop
(system).
clunit2
(system).
local-time
(system).
src
(module).
Modules are listed depth-first from the system components tree.
orizuru-orm/src
orizuru-orm
(system).
package.lisp
(file).
constants.lisp
(file).
errors.lisp
(file).
config.lisp
(file).
util.lisp
(file).
query-low-level.lisp
(file).
connect.lisp
(file).
types.lisp
(file).
sql.lisp
(file).
meta.lisp
(file).
query.lisp
(file).
migration.lisp
(file).
table.lisp
(file).
inflate-deflate.lisp
(file).
interface.lisp
(file).
fixture.lisp
(file).
transaction.lisp
(file).
query-set.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
orizuru-orm/orizuru-orm.asd
orizuru-orm/src/package.lisp
orizuru-orm/src/constants.lisp
orizuru-orm/src/errors.lisp
orizuru-orm/src/config.lisp
orizuru-orm/src/util.lisp
orizuru-orm/src/query-low-level.lisp
orizuru-orm/src/connect.lisp
orizuru-orm/src/types.lisp
orizuru-orm/src/sql.lisp
orizuru-orm/src/meta.lisp
orizuru-orm/src/query.lisp
orizuru-orm/src/migration.lisp
orizuru-orm/src/table.lisp
orizuru-orm/src/inflate-deflate.lisp
orizuru-orm/src/interface.lisp
orizuru-orm/src/fixture.lisp
orizuru-orm/src/transaction.lisp
orizuru-orm/src/query-set.lisp
orizuru-orm/src/package.lisp
src
(module).
orizuru-orm.util
.
orizuru-orm
.
orizuru-orm.fixture
.
orizuru-orm.query-set
.
orizuru-orm.query
.
orizuru-orm.meta
.
orizuru-orm.sql
.
orizuru-orm.transaction
.
orizuru-orm.inflate-deflate
.
orizuru-orm.interface
.
orizuru-orm.types
.
orizuru-orm.connect
.
orizuru-orm.query.lowlevel
.
orizuru-orm.constants
.
orizuru-orm.errors
.
orizuru-orm.table
.
orizuru-orm.migration
.
orizuru-orm/src/constants.lisp
package.lisp
(file).
src
(module).
+id-column-name+
(constant).
+postgresql-autoincrement-column-qualifier+
(constant).
orizuru-orm/src/errors.lisp
constants.lisp
(file).
src
(module).
configuration-error
(condition).
empty-table
(condition).
no-configuration-error
(condition).
query-error
(condition).
query-set-error
(condition).
query-set-foreign-reference-error
(condition).
key
(reader method).
orizuru-orm-error
(condition).
text
(reader method).
orizuru-orm/src/config.lisp
errors.lisp
(file).
src
(module).
*after-config-hook*
(special variable).
debugp
(function).
get-config-value
(function).
get-configuration
(function).
setup
(function).
*config*
(special variable).
orizuru-orm/src/util.lisp
config.lisp
(file).
src
(module).
*foreign-slots-class-package*
(special variable).
all-foreign-reference
(function).
all-foreign-slots
(function).
all-slots-name
(function).
clone
(generic function).
diff-plist
(function).
find-class-slot
(function).
find-foreign-reference
(function).
find-slot
(function).
find-slot-name
(function).
foreign-reference-between
(function).
foreign-reference-class
(function).
foreign-reference-slot-name
(function).
get-class-slot
(function).
get-slot
(function).
plist-keys
(function).
strcat
(function).
all-slots
(function).
orizuru-orm/src/query-low-level.lisp
util.lisp
(file).
src
(module).
query-low-level
(function).
orizuru-orm/src/connect.lisp
query-low-level.lisp
(file).
src
(module).
*default-db*
(special variable).
<database>
(class).
connect
(function).
database-connection
(reader method).
(setf database-connection)
(writer method).
database-name
(reader method).
database-type
(reader method).
disconnect
(function).
disconnect-clean
(function).
get-connection
(function).
get-db
(function).
*db*
(special variable).
+db-params+
(constant).
+system-mapping+
(constant).
database-connection-spec
(reader method).
enforce-foreign-keys
(function).
initialize-*db*
(function).
load-driver
(function).
make-connection
(method).
set-proper-quote-character
(function).
validate-all-databases
(function).
validate-connection-spec
(function).
orizuru-orm/src/types.lisp
connect.lisp
(file).
src
(module).
integer
(type).
orizuru-orm/src/sql.lisp
types.lisp
(file).
src
(module).
*timestamp-column-uses-timezone-p*
(special variable).
add-constraint
(function).
alter-constraint
(function).
create-and-sort-constraints
(function).
define-column
(function).
drop-column
(function).
drop-constraint
(function).
make-constraint
(function).
orizuru-orm-type->sql
(generic function).
sqlize
(function).
%text->number
(function).
%text->something
(function).
+referential-actions+
(constant).
alter-column-type
(function).
autoincrement-sql
(function).
constraint-name
(function).
conversion-column-p
(function).
conversion-column-types
(function).
convert-column-type
(generic function).
create-column-constraints
(function).
diff->from-to-params
(function).
foreign
(function).
gen-alias-integer->type
(macro).
gen-alias-type->integer
(macro).
map-ref-action
(function).
set-index
(function).
set-null
(function).
set-primary
(function).
set-unique
(function).
orizuru-orm/src/meta.lisp
sql.lisp
(file).
src
(module).
<table-class>
(class).
abstractp
(reader method).
col-autoincrement-p
(reader method).
col-check
(reader method).
col-foreign
(reader method).
col-index-p
(reader method).
col-null-p
(reader method).
col-primary-p
(reader method).
col-type
(reader method).
(setf col-type)
(writer method).
col-unique-p
(reader method).
compute-effective-slot-definition
(method).
deferredp
(reader method).
diff-digest
(function).
digest
(method).
direct-slot-definition-class
(method).
effective-slot-definition-class
(method).
table-database
(method).
table-name
(method).
validate-superclass
(method).
validate-superclass
(method).
%table-database
(reader method).
diff-slot
(function).
digest-slot
(function).
sort-slot-list
(function).
table-class-direct-slot-definition
(class).
table-class-effective-slot-definition
(class).
table-class-slot-definition-mixin
(class).
orizuru-orm/src/query.lisp
meta.lisp
(file).
src
(module).
do-query
(macro).
meta-query
(macro).
query
(macro).
orizuru-orm/src/migration.lisp
query.lisp
(file).
src
(module).
build
(function).
create-table
(function).
delete-migrations
(function).
get-last-migration
(function).
insert-migration
(function).
migrate
(function).
migration-history-p
(function).
rename-migration-history
(function).
+create-table-format-string+
(constant).
get-migration-dir
(function).
migration-history-pathname
(function).
read-migration-history
(function).
serialize
(function).
serialize-plist
(function).
orizuru-orm/src/table.lisp
migration.lisp
(file).
src
(module).
+slot-mapping+
(constant).
+standard-class-options+
(constant).
add-default-slots
(function).
any-concrete-superclasses
(function).
process-slot
(function).
separate-slots-and-options
(function).
orizuru-orm/src/inflate-deflate.lisp
table.lisp
(file).
src
(module).
defdeflate
(macro).
definflate
(macro).
deflate
(generic function).
inflate
(generic function).
db-nil-p
(function).
orizuru-orm/src/interface.lisp
inflate-deflate.lisp
(file).
src
(module).
create
(macro).
create%
(macro).
create-from-plist
(macro).
del
(method).
deref
(macro).
do-filter
(macro).
drop-table
(method).
drop-table
(method).
exists
(macro).
filter
(macro).
plist->object
(method).
plist->object
(method).
save
(method).
single
(macro).
single!
(macro).
single-or-create
(macro).
clean-tuple
(method).
make-set
(function).
slot-tuple
(method).
orizuru-orm/src/fixture.lisp
interface.lisp
(file).
src
(module).
register-fixture
(method).
orizuru-orm/src/transaction.lisp
fixture.lisp
(file).
src
(module).
begin-transaction
(function).
commit
(function).
rollback
(function).
with-transaction
(macro).
orizuru-orm/src/query-set.lisp
transaction.lisp
(file).
src
(module).
*compile-sxql-tree*
(special variable).
*full-select-table-sxql*
(special variable).
->sxql
(generic function).
add-filter
(generic function).
add-join
(generic function).
add-table
(generic function).
add-union
(generic function).
all-from-set
(generic function).
class-mapped
(reader method).
(setf class-mapped)
(method).
(setf class-mapped)
(writer method).
clone
(method).
clone
(method).
clone
(method).
clone
(method).
clone
(method).
filter-set
(macro).
filtered-query-set
(class).
initialize-instance
(method).
join-query-set
(class).
logical-assoc-query-set
(class).
make-query-set
(macro).
map-to-model
(function).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
query-set
(class).
query-set=
(generic function).
table-query-set
(class).
union-query-set
(class).
with-join-column
(macro).
with-table-package
(macro).
%clone
(method).
%make-query-set
(generic function).
%print-object
(function).
*print-indent-spaces*
(special variable).
+allowed-logical-op+
(constant).
+op-ilike+
(constant).
+op-like+
(constant).
+op-scanner+
(constant).
+op<+
(constant).
+op<=+
(constant).
+op=+
(constant).
+op>+
(constant).
+op>=+
(constant).
+re-op+
(constant).
+table-field-splitter+
(constant).
+table-splitter+
(constant).
+trim-op+
(constant).
append-children
(function).
children
(reader method).
(setf children)
(writer method).
children=
(function).
columns
(reader method).
(setf columns)
(writer method).
dfs
(generic function).
filtered-p-fn
(function).
filtered-set=
(function).
filters-only
(function).
find-child
(function).
find-logical-relation
(function).
find-table-or-join
(function).
gen-test-type
(macro).
increase-indent-space
(function).
join-clause
(reader method).
(setf join-clause)
(writer method).
join-p-fn
(function).
join-type
(reader method).
(setf join-type)
(writer method).
joins-only
(function).
lhs-column
(reader method).
(setf lhs-column)
(writer method).
logical-assoc-p-fn
(function).
logical-ops-only
(function).
make-qset
(macro).
make-query-set-and
(function).
make-table-column
(function).
nadd-filter
(generic function).
nadd-join
(generic function).
nadd-table
(generic function).
nadd-union
(generic function).
non-recursive-collect-child
(function).
operation
(reader method).
(setf operation)
(writer method).
operator
(reader method).
(setf operator)
(writer method).
parent
(reader method).
(setf parent)
(writer method).
print-children
(function).
print-indent-spaces
(function).
print-new-line
(function).
push-child
(function).
remap-filter
(function).
remap-ilike
(function).
remove-child
(function).
rhs-column
(reader method).
(setf rhs-column)
(writer method).
set-all-parents
(function).
set-all-parents*
(function).
signal-error
(function).
signal-if-lhs-and-rhs-null
(function).
split-tables-name
(generic function).
sym->filter
(function).
sym->filter-fields
(function).
sym->filter-p
(function).
sym->join
(function).
sym->join-fields
(function).
sym->join-p
(function).
sym->op
(function).
sym->op-case
(macro).
sym-join-fields-w/explicit-column
(function).
sym-w/explicit-column-p
(function).
sym-w/joins-p
(function).
table
(reader method).
(setf table)
(writer method).
table-p-fn
(function).
tables-only
(function).
tables-unions-only
(function).
union-op
(macro).
union-p-fn
(function).
unions-only
(function).
use-first-table-available
(function).
with-clone
(macro).
with-increased-indent
(macro).
with-print-new-line
(macro).
Packages are listed by definition order.
orizuru-orm.util
orizuru-orm
orizuru-orm.fixture
orizuru-orm.query-set
orizuru-orm.query
orizuru-orm.meta
orizuru-orm.sql
orizuru-orm.transaction
orizuru-orm.inflate-deflate
orizuru-orm.config
orizuru-orm.interface
orizuru-orm.types
orizuru-orm.connect
orizuru-orm.query.lowlevel
orizuru-orm.constants
orizuru-orm.errors
orizuru-orm.table
orizuru-orm.migration
orizuru-orm.util
Various utilities for use in other parts of Orizuru-Orm.
alexandria
.
anaphora
.
common-lisp
.
iterate
.
*foreign-slots-class-package*
(special variable).
all-foreign-reference
(function).
all-foreign-slots
(function).
all-slots-name
(function).
clone
(generic function).
diff-plist
(function).
find-class-slot
(function).
find-foreign-reference
(function).
find-slot
(function).
find-slot-name
(function).
foreign-reference-between
(function).
foreign-reference-class
(function).
foreign-reference-slot-name
(function).
get-class-slot
(function).
get-slot
(function).
plist-keys
(function).
strcat
(function).
all-slots
(function).
orizuru-orm
The global Orizuru-Orm package re-exports symbols from internal modules.
common-lisp
.
orizuru-orm.types
.
orizuru-orm.fixture
Customizes clos-fixtures for use in Orizuru-Orm.
common-lisp
.
orizuru-orm.query-set
Implements query sets.
alexandria
.
cl-ppcre
.
common-lisp
.
orizuru-orm.constants
.
orizuru-orm.errors
.
orizuru-orm.inflate-deflate
.
orizuru-orm.meta
.
orizuru-orm.query
.
orizuru-orm.util
.
sxql
.
*compile-sxql-tree*
(special variable).
*full-select-table-sxql*
(special variable).
->sxql
(generic function).
add-filter
(generic function).
add-join
(generic function).
add-table
(generic function).
add-union
(generic function).
all-from-set
(generic function).
class-mapped
(generic reader).
(setf class-mapped)
(generic function).
filter-set
(macro).
filtered-query-set
(class).
join-query-set
(class).
logical-assoc-query-set
(class).
make-query-set
(macro).
map-to-model
(function).
query-set
(class).
query-set=
(generic function).
table-query-set
(class).
union-query-set
(class).
with-join-column
(macro).
with-table-package
(macro).
%clone
(generic function).
%make-query-set
(generic function).
%print-object
(function).
*print-indent-spaces*
(special variable).
+allowed-logical-op+
(constant).
+op-ilike+
(constant).
+op-like+
(constant).
+op-scanner+
(constant).
+op<+
(constant).
+op<=+
(constant).
+op=+
(constant).
+op>+
(constant).
+op>=+
(constant).
+re-op+
(constant).
+table-field-splitter+
(constant).
+table-splitter+
(constant).
+trim-op+
(constant).
append-children
(function).
children
(generic reader).
(setf children)
(generic writer).
children=
(function).
columns
(generic reader).
(setf columns)
(generic writer).
dfs
(generic function).
filtered-p-fn
(function).
filtered-set=
(function).
filters-only
(function).
find-child
(function).
find-logical-relation
(function).
find-table-or-join
(function).
gen-test-type
(macro).
increase-indent-space
(function).
join-clause
(generic reader).
(setf join-clause)
(generic writer).
join-p-fn
(function).
join-type
(generic reader).
(setf join-type)
(generic writer).
joins-only
(function).
lhs-column
(generic reader).
(setf lhs-column)
(generic writer).
logical-assoc-p-fn
(function).
logical-ops-only
(function).
make-qset
(macro).
make-query-set-and
(function).
make-table-column
(function).
nadd-filter
(generic function).
nadd-join
(generic function).
nadd-table
(generic function).
nadd-union
(generic function).
non-recursive-collect-child
(function).
operation
(generic reader).
(setf operation)
(generic writer).
operator
(generic reader).
(setf operator)
(generic writer).
parent
(generic reader).
(setf parent)
(generic writer).
print-children
(function).
print-indent-spaces
(function).
print-new-line
(function).
push-child
(function).
remap-filter
(function).
remap-ilike
(function).
remove-child
(function).
rhs-column
(generic reader).
(setf rhs-column)
(generic writer).
set-all-parents
(function).
set-all-parents*
(function).
signal-error
(function).
signal-if-lhs-and-rhs-null
(function).
split-tables-name
(generic function).
sym->filter
(function).
sym->filter-fields
(function).
sym->filter-p
(function).
sym->join
(function).
sym->join-fields
(function).
sym->join-p
(function).
sym->op
(function).
sym->op-case
(macro).
sym-join-fields-w/explicit-column
(function).
sym-w/explicit-column-p
(function).
sym-w/joins-p
(function).
table
(generic reader).
(setf table)
(generic writer).
table-p-fn
(function).
tables-only
(function).
tables-unions-only
(function).
union-op
(macro).
union-p-fn
(function).
unions-only
(function).
use-first-table-available
(function).
with-clone
(macro).
with-increased-indent
(macro).
with-print-new-line
(macro).
orizuru-orm.query
Executing cl-dbi queries in the context of Orizuru-Orm.
anaphora
.
common-lisp
.
iterate
.
do-query
(macro).
meta-query
(macro).
query
(macro).
orizuru-orm.meta
This file defines the metaclasses that map CLOS objects to SQL tables, and some basic operations on them.
anaphora
.
common-lisp
.
iterate
.
<table-class>
(class).
abstractp
(generic reader).
col-autoincrement-p
(generic reader).
col-check
(generic reader).
col-foreign
(generic reader).
col-index-p
(generic reader).
col-null-p
(generic reader).
col-primary-p
(generic reader).
col-type
(generic reader).
(setf col-type)
(generic writer).
col-unique-p
(generic reader).
deferredp
(generic reader).
diff-digest
(function).
digest
(generic function).
table-database
(generic function).
table-name
(generic function).
%table-database
(generic reader).
diff-slot
(function).
digest-slot
(function).
sort-slot-list
(function).
table-class-direct-slot-definition
(class).
table-class-effective-slot-definition
(class).
table-class-slot-definition-mixin
(class).
orizuru-orm.sql
This module handles the generation of SQL for table definition and migration.
alexandria
.
anaphora
.
common-lisp
.
iterate
.
orizuru-orm.util
.
*timestamp-column-uses-timezone-p*
(special variable).
add-constraint
(function).
alter-constraint
(function).
create-and-sort-constraints
(function).
define-column
(function).
drop-column
(function).
drop-constraint
(function).
make-constraint
(function).
orizuru-orm-type->sql
(generic function).
sqlize
(function).
%text->number
(function).
%text->something
(function).
+referential-actions+
(constant).
alter-column-type
(function).
autoincrement-sql
(function).
constraint-name
(function).
conversion-column-p
(function).
conversion-column-types
(function).
convert-column-type
(generic function).
create-column-constraints
(function).
diff->from-to-params
(function).
foreign
(function).
gen-alias-integer->type
(macro).
gen-alias-type->integer
(macro).
map-ref-action
(function).
set-index
(function).
set-null
(function).
set-primary
(function).
set-unique
(function).
orizuru-orm.transaction
Implements transactions.
anaphora
.
common-lisp
.
begin-transaction
(function).
commit
(function).
rollback
(function).
with-transaction
(macro).
orizuru-orm.inflate-deflate
Inflation/deflation map SQL string to CLOS
objects. This is unrelated to the ORM, and meant to allow complex
column datatypes to be mapped to CLOS objects. For example, mapping
SQL timestamps to structures that represent time, or mapping other
more complex SQL types to CLOS objects.
anaphora
.
common-lisp
.
orizuru-orm.types
.
defdeflate
(macro).
definflate
(macro).
deflate
(generic function).
inflate
(generic function).
db-nil-p
(function).
orizuru-orm.config
Functions for reading and writing from and to the global configuration.
anaphora
.
common-lisp
.
*after-config-hook*
(special variable).
debugp
(function).
get-config-value
(function).
get-configuration
(function).
setup
(function).
*config*
(special variable).
orizuru-orm.interface
This package contains the methods used to access and alter database records in an object-oriented way.
anaphora
.
common-lisp
.
iterate
.
create
(macro).
create%
(macro).
create-from-plist
(macro).
del
(generic function).
deref
(macro).
do-filter
(macro).
drop-table
(generic function).
exists
(macro).
filter
(macro).
plist->object
(generic function).
save
(generic function).
single
(macro).
single!
(macro).
single-or-create
(macro).
clean-tuple
(generic function).
make-set
(function).
slot-tuple
(generic function).
orizuru-orm.types
Implements the database types.
integer
(type).
orizuru-orm.connect
Handles database connections, connection parameter validation, and various low-level DB-specific modes.
anaphora
.
common-lisp
.
iterate
.
*default-db*
(special variable).
<database>
(class).
connect
(function).
database-connection
(generic reader).
(setf database-connection)
(generic writer).
database-name
(generic reader).
database-type
(generic reader).
disconnect
(function).
disconnect-clean
(function).
get-connection
(function).
get-db
(function).
*db*
(special variable).
+db-params+
(constant).
+system-mapping+
(constant).
database-connection-spec
(generic reader).
enforce-foreign-keys
(function).
initialize-*db*
(function).
load-driver
(function).
make-connection
(generic function).
set-proper-quote-character
(function).
validate-all-databases
(function).
validate-connection-spec
(function).
orizuru-orm.query.lowlevel
Executing cl-dbi queries.
common-lisp
.
query-low-level
(function).
orizuru-orm.constants
Some useful constants
alexandria
.
common-lisp
.
+id-column-name+
(constant).
+postgresql-autoincrement-column-qualifier+
(constant).
orizuru-orm.errors
Definition of Orizuru-Orm errors.
common-lisp
.
configuration-error
(condition).
empty-table
(condition).
no-configuration-error
(condition).
query-error
(condition).
query-set-error
(condition).
query-set-foreign-reference-error
(condition).
key
(generic reader).
orizuru-orm-error
(condition).
text
(generic reader).
orizuru-orm.table
Implements the deftable macro.
alexandria
.
anaphora
.
common-lisp
.
iterate
.
+slot-mapping+
(constant).
+standard-class-options+
(constant).
add-default-slots
(function).
any-concrete-superclasses
(function).
process-slot
(function).
separate-slots-and-options
(function).
orizuru-orm.migration
The first part of this package contains various
simple utilities for manipulating the migration history of a
table. The second part contains code that actually creates tables
and migrates them. The actual generation of table-creating SQL is
handled by orizuru-orm.sql.
alexandria
.
anaphora
.
common-lisp
.
iterate
.
build
(function).
create-table
(function).
delete-migrations
(function).
get-last-migration
(function).
insert-migration
(function).
migrate
(function).
migration-history-p
(function).
rename-migration-history
(function).
+create-table-format-string+
(constant).
get-migration-dir
(function).
migration-history-pathname
(function).
read-migration-history
(function).
serialize
(function).
serialize-plist
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A function that gets executed after setup is called. Takes no arguments, does nothing by default.
The name of the default database
Create an object.
Define a table.
Execute code for each result in the query, without aggregating them all into a list.
Execute an SxQL query on the database ‘database-name‘.
SQL to add a constraint to a table.
return a plist of (class-referring-name . slot-name)
SQL to alter a constraint in a table.
Connect to all the databases specified in the configuration.
A plist of different types of constraints from a table digest.
Determine if Orizuru-Orm is in debug mode.
A column definition from the digest of its slot, name and name of the database it’s table belongs to
Compute the difference between two digests. See DIGEST.
Calculates the difference between two plists, returning the result as a list of ([property] [old value] [new value])
Cut all connections.
Cut all connections and reset *db* hashtable
SQL to drop a column, given the table and column names.
SQL to drop a constraint from a table.
Find a slot by name
Find a slot by name
Find a slot in a class by keyword name
Get the value of ‘key‘ in the configuration.
Return the configuration object, or signal a no-configuration error.
Return the connection handler for a given database.
Return the database matching a specific name
Find slot by keyword name
Insert a new diff to the migration history
A constraint from its type and values, if it can be created (eg :nullp t doesn’t create a constraint, but :nullp nil creates a NOT NULL constraint).
T if the table has a migration history, NIL otherwise.
Return the keys of a plist.
Bypass orizuru-orm and execute sql query with dbi
Set the configuration.
Turn a symbol or a string into its SQL representation. Identical to the behaviour of SxQL.
join-query-set
)) ¶union-query-set
)) ¶filtered-query-set
)) ¶logical-assoc-query-set
)) ¶table-query-set
)) ¶list
)) ¶<table-class>
)) ¶Whether the class corresponds to an SQL table or not.
symbol
) child &key logical-op operation lhs rhs) ¶logical-assoc-query-set
) (child null
) &key logical-op operation lhs rhs) ¶query-set
) (child filtered-query-set
) &key logical-op operation lhs rhs) ¶query-set
) (child table-query-set
) &key logical-op operation lhs rhs) ¶query-set
) (join join-query-set
) &key &allow-other-keys) ¶table-query-set
) (join join-query-set
) &key &allow-other-keys) ¶Add a table as child of this query set
table-query-set
) (table table-query-set
)) ¶query-set
) (table table-query-set
)) ¶union-query-set
) (other union-query-set
)) ¶union-query-set
) (table table-query-set
)) ¶query-set
) (union-set union-query-set
)) ¶null
)) ¶table-query-set
)) ¶automatically generated reader method
table-query-set
)) ¶automatically generated writer method
join-query-set
)) ¶filtered-query-set
)) ¶logical-assoc-query-set
)) ¶table-query-set
)) ¶list
)) ¶table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
table-class-slot-definition-mixin
)) ¶automatically generated writer method
table-class-slot-definition-mixin
)) ¶automatically generated reader method
<database>
)) ¶<database>
)) ¶The underlying connection object.
conn
.
<database>
)) ¶The database name.
name
.
<database>
)) ¶A keyword representing the database type (:postgres only atm).
type
.
<table-class>
)) ¶Whether the class should be built only when explicitly calling build.
Turn a Lisp object into a string for insertion in the database.
<table-class>
)) ¶Serialize a class’s options and slots’ options into a plist
symbol
)) ¶<table-class>
)) ¶Turn a string into a CLOS object.
(eql orizuru-orm.types:timestamp)
)) ¶(eql orizuru-orm.types:datetime)
)) ¶(eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:int)
)) ¶(eql integer)
)) ¶(eql orizuru-orm.types:timestamp)
)) ¶(eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:int)
)) ¶(eql integer)
)) ¶(eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:text)
)) ¶symbol
) tuple) ¶<table-class>
) tuple) ¶Convert a tuple produced by CL-DBI to a CLOS instance.
join-query-set
) (b join-query-set
)) ¶filtered-query-set
) (b filtered-query-set
)) ¶logical-assoc-query-set
) (b logical-assoc-query-set
)) ¶table-query-set
) (b table-query-set
)) ¶<table-class>
)) ¶The database this class belongs to.
<table-class>
)) ¶Return the name of a the class, a symbol.
<table-class>
) slot-name direct-slot-definitions) ¶sb-mop
.
<table-class>
) &rest initargs) ¶sb-mop
.
<table-class>
) &rest initargs) ¶sb-mop
.
logical-assoc-query-set
) stream) ¶table-query-set
) stream) ¶filtered-query-set
) stream) ¶join-query-set
) stream) ¶union-query-set
) stream) ¶standard-class
) (super <table-class>
)) ¶sb-mop
.
<table-class>
) (super standard-class
)) ¶sb-mop
.
An error in the configuration.
key
.
Table has no slots.
Orizuru-Orm was not configured.
Error in a query.
Error in a query set.
Error in a query set related to foreign reference.
A database.
A keyword representing the database type (:postgres only atm).
common-lisp
.
keyword
:type
This slot is read-only.
The database name.
string
:name
This slot is read-only.
The connection specification.
:conn-spec
This slot is read-only.
The underlying connection object.
:connection
A table metaclass.
standard-class
.
Whether the class corresponds to an SQL table or not.
:abstractp
This slot is read-only.
Whether the class should be built only when explicitly calling build.
:deferredp
This slot is read-only.
The database this class belongs to.
:database
This slot is read-only.
The base class of all table classes.
:and
:operator
->sxql
.
add-filter
.
add-filter
.
add-filter
.
add-filter
.
add-filter
.
add-join
.
add-join
.
add-table
.
add-union
.
add-union
.
add-union
.
all-from-set
.
(setf children)
.
children
.
(setf class-mapped)
.
clone
.
(setf columns)
.
columns
.
dfs
.
initialize-instance
.
nadd-table
.
nadd-table
.
(setf parent)
.
parent
.
print-object
.
query-set=
.
:parent
(quote nil)
:children
:*
:columns
This variable holds Orizuru-Orm’s global configuration.
A map from database names to <database> objects.
If the slot doesn’t have :initarg or :accessor slots, add them.
Give constraints Orizuru-Orm-specific names
Compute the difference between two slot digests. See DIGEST.
Load the ASDF system for the specified database module.
Transform an object into a call to the set= function used by SxQL. Deflation happens here.
Return the pathname to the file containing the migration history for the table ‘table-name‘.
Take a plist like (:col-type ’string :col-null-p t) and remove the prefixes on the keys. Turn ’deftable slot properties’ (:type, :nullp, etc.) into ’table-class slot properties’ (:col-type, :col-null-p, etc.)
helper function to add a child to a query set
To minimize the number of parentheses, both slots and table options come in the same list. This function separates them: Normal slot names are plain old symbols, table options are keywords.
Serialize a list of digests.
Toggle INDEX pseudo-constraint.
Toggle NULL constraint.
Toggle PRIMARY KEY constraint.
Toggle UNIQUE constraint.
Immediately after configuration, iterate over the list of defined databases, validating configuration parameters, creating their corresponding <database> instances, and setting the value of *default-db*.
<table-class>
)) ¶The database this class belongs to.
<table-class>
) tuple) ¶Process a plist returned by CL-DBI into a format that can be accepted by make-instance. Inflation happens here.
(eql orizuru-orm.types:numeric)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:double)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:numeric)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:smallint)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:double)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:smallint)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:numeric)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:bigint)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:double)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:bigint)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:smallint)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:bigint)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql integer)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql integer)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql integer)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql integer)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:numeric)
) (new-type (eql orizuru-orm.types:int)
)) ¶(eql orizuru-orm.types:int)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:double)
) (new-type (eql orizuru-orm.types:int)
)) ¶(eql orizuru-orm.types:int)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:smallint)
) (new-type (eql orizuru-orm.types:int)
)) ¶(eql orizuru-orm.types:int)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:bigint)
) (new-type (eql orizuru-orm.types:int)
)) ¶(eql orizuru-orm.types:int)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:numeric)
) (new-type (eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:varchar)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:double)
) (new-type (eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:varchar)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:smallint)
) (new-type (eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:varchar)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:bigint)
) (new-type (eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:varchar)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:int)
) (new-type (eql orizuru-orm.types:varchar)
)) ¶(eql orizuru-orm.types:varchar)
) (new-type (eql orizuru-orm.types:int)
)) ¶(eql orizuru-orm.types:timestamp)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:timestamp)
)) ¶(eql orizuru-orm.types:numeric)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:numeric)
)) ¶(eql orizuru-orm.types:double)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:double)
)) ¶(eql orizuru-orm.types:smallint)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:smallint)
)) ¶(eql orizuru-orm.types:bigint)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:bigint)
)) ¶(eql orizuru-orm.types:int)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:int)
)) ¶(eql orizuru-orm.types:varchar)
) (new-type (eql orizuru-orm.types:text)
)) ¶(eql orizuru-orm.types:text)
) (new-type (eql orizuru-orm.types:varchar)
)) ¶<database>
)) ¶The connection specification.
join-query-set
)) ¶automatically generated reader method
join-query-set
)) ¶automatically generated writer method
join-query-set
)) ¶automatically generated reader method
join-query-set
)) ¶automatically generated writer method
configuration-error
)) ¶key
.
filtered-query-set
)) ¶automatically generated reader method
filtered-query-set
)) ¶automatically generated writer method
<database>
)) ¶Impure version of add-filter
logical-assoc-query-set
) (child null
) &key logical-op operation lhs rhs) ¶table-query-set
) (join join-query-set
) &key &allow-other-keys) ¶Impure version of add-table
query-set
) (child table-query-set
)) ¶union-query-set
) (table table-query-set
)) ¶filtered-query-set
)) ¶automatically generated reader method
filtered-query-set
)) ¶automatically generated writer method
logical-assoc-query-set
)) ¶automatically generated reader method
logical-assoc-query-set
)) ¶automatically generated writer method
filtered-query-set
)) ¶automatically generated reader method
filtered-query-set
)) ¶automatically generated writer method
table-query-set
)) ¶automatically generated reader method
table-query-set
)) ¶automatically generated writer method
orizuru-orm-error
)) ¶text
.
condition
.
text
.
standard-effective-slot-definition
.
table-class-slot-definition-mixin
.
:col-type
:col-null-p
This slot is read-only.
:col-unique-p
This slot is read-only.
:col-primary-p
This slot is read-only.
:col-index-p
This slot is read-only.
:col-foreign
This slot is read-only.
:col-autoincrement-p
This slot is read-only.
Jump to: | %
(
-
A B C D E F G I J K L M N O P Q R S T U V W |
---|
Jump to: | %
(
-
A B C D E F G I J K L M N O P Q R S T U V W |
---|
Jump to: | *
+
A C D J K L N O P R S T |
---|
Jump to: | *
+
A C D J K L N O P R S T |
---|
Jump to: | <
B C D E F I J L M N O P Q S T U V |
---|
Jump to: | <
B C D E F I J L M N O P Q S T U V |
---|