The submarine Reference Manual

Table of Contents

The submarine Reference Manual

This is the submarine Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:54:30 2021 GMT+0.

1 Systems

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

1.1 submarine

Dependencies

• postmodern
• iterate
• mop-utils

Source

submarine.asd (file)

Components

• package.lisp (file)
• conditions.lisp (file)
• utilities.lisp (file)
• mop.lisp (file)
• db.lisp (file)
• dao.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 submarine.asd

Location

submarine.asd

Systems

submarine (system)

Packages

submarine-system

2.1.2 submarine/package.lisp

Parent

submarine (system)

Location

package.lisp

Packages

submarine

2.1.3 submarine/conditions.lisp

Dependency

package.lisp (file)

Parent

submarine (system)

Location

conditions.lisp

Exported Definitions

• dao-error (condition)
• dao-nonexistent-id (condition)
• unresolved-foreign-key (condition)

Internal Definitions

• id (method)
• table-name (method)

2.1.4 submarine/utilities.lisp

Dependency

conditions.lisp (file)

Parent

submarine (system)

Location

utilities.lisp

Exported Definitions

• with-class-connection (macro)
• with-connection (macro)
• with-object-connection (macro)

Internal Definitions

• class-db-slots (function)
• db-slots-of (function)
• non-db-slot (function)
• with-class-connection-fun (function)
• with-connection-fun (function)
• with-object-connection-fun (function)

2.1.5 submarine/mop.lisp

Dependency

utilities.lisp (file)

Parent

submarine (system)

Location

mop.lisp

Exported Definitions

• db-class (class)
• defdao (macro)
• foreign-type-p (method)
• (setf foreign-type-p) (method)

Internal Definitions

• collect-constraints (method)
• db-class-connection-spec (method)
• db-class-direct-slot-definition (class)
• db-class-effective-slot-definition (class)
• db-class-foreign-keys (method)
• (setf db-class-foreign-keys) (method)
• db-class-indices (method)
• db-class-slot-definition (class)
• db-class-unfinished-classes (method)
• (setf db-class-unfinished-classes) (method)
• db-class-unique (method)
• db-class-unique-keys (method)
• (setf db-class-unique-keys) (method)
• delayed-constraint (method)
• (setf delayed-constraint) (method)
• not-null-p (method)
• (setf not-null-p) (method)
• on-delete (method)
• (setf on-delete) (method)
• remove-finished-classes (generic function)
• remove-finished-classes (method)
• transient-p (method)
• (setf transient-p) (method)
• try-delayed-constraints (generic function)
• try-delayed-constraints (method)
• unique (method)
• (setf unique) (method)

2.1.6 submarine/db.lisp

Dependency

mop.lisp (file)

Parent

submarine (system)

Location

db.lisp

Internal Definitions

• actual-type (method)
• add-constraint (generic function)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• apply-foreign-key-constraints (method)
• apply-unique-constraints (method)
• column-name (method)
• column-name (method)
• column-type (method)
• create-table (generic function)
• create-table (method)
• create-table (method)
• database-consistent-with-specification (generic function)
• database-consistent-with-specification (method)
• needed-type (method)
• sql-column-does-not-exist (condition)
• sql-column-error (condition)
• table-name (method)

2.1.7 submarine/dao.lisp

Dependency

db.lisp (file)

Parent

submarine (system)

Location

dao.lisp

Exported Definitions

• dao (class)
• dao-exists-p (generic function)
• dao-exists-p (method)
• dao= (generic function)
• dao= (method)
• dao= (method)
• def-many-to-many (macro)
• delete-dao (generic function)
• delete-dao (method)
• get-all (generic function)
• get-all (method)
• get-dao (function)
• get-id (method)
• (setf get-id) (method)
• insert-dao (generic function)
• insert-dao (method)
• make-and-save (macro)
• make-dao (function)
• query-dao (macro)
• query-dao-fun (function)
• relate (function)
• relatedp (function)
• save-dao (generic function)
• save-dao (method)
• select-dao (macro)
• select-dao-fun (function)
• slot-value-or-id-if-foreign (function)
• unrelate (function)
• update-dao (generic function)
• update-dao (method)

Internal Definitions

• id-seq-name (function)
• relate-method (generic function)
• relatedp-method (generic function)
• set-fields (function)
• unrelate-method (generic function)

3 Packages

Packages are listed by definition order.

3.1 submarine-system

Source

submarine.asd

Use List

• asdf/interface
• common-lisp

3.2 submarine

A very simple quasi-object persistency system built on top of Postmodern.

Source

package.lisp (file)

Use List

• mop-utils
• iterate
• sb-mop
• cl-postgres
• s-sql
• common-lisp

Exported Definitions

• dao (class)
• dao-error (condition)
• dao-exists-p (generic function)
• dao-exists-p (method)
• dao-nonexistent-id (condition)
• dao= (generic function)
• dao= (method)
• dao= (method)
• db-class (class)
• def-many-to-many (macro)
• defdao (macro)
• delete-dao (generic function)
• delete-dao (method)
• foreign-type-p (generic function)
• foreign-type-p (method)
• (setf foreign-type-p) (method)
• (setf foreign-type-p) (generic function)
• get-all (generic function)
• get-all (method)
• get-dao (function)
• get-id (generic function)
• get-id (method)
• (setf get-id) (method)
• (setf get-id) (generic function)
• insert-dao (generic function)
• insert-dao (method)
• make-and-save (macro)
• make-dao (function)
• query-dao (macro)
• query-dao-fun (function)
• relate (function)
• relatedp (function)
• save-dao (generic function)
• save-dao (method)
• select-dao (macro)
• select-dao-fun (function)
• slot-value-or-id-if-foreign (function)
• unrelate (function)
• unresolved-foreign-key (condition)
• update-dao (generic function)
• update-dao (method)
• with-class-connection (macro)
• with-connection (macro)
• with-object-connection (macro)

Internal Definitions

• actual-type (generic function)
• actual-type (method)
• add-constraint (generic function)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• apply-foreign-key-constraints (generic function)
• apply-foreign-key-constraints (method)
• apply-unique-constraints (generic function)
• apply-unique-constraints (method)
• class-db-slots (function)
• collect-constraints (generic function)
• collect-constraints (method)
• column-name (generic function)
• column-name (method)
• column-name (method)
• column-type (generic function)
• column-type (method)
• create-table (generic function)
• create-table (method)
• create-table (method)
• database-consistent-with-specification (generic function)
• database-consistent-with-specification (method)
• db-class-connection-spec (generic function)
• db-class-connection-spec (method)
• db-class-direct-slot-definition (class)
• db-class-effective-slot-definition (class)
• db-class-foreign-keys (generic function)
• db-class-foreign-keys (method)
• (setf db-class-foreign-keys) (method)
• (setf db-class-foreign-keys) (generic function)
• db-class-indices (generic function)
• db-class-indices (method)
• db-class-slot-definition (class)
• db-class-unfinished-classes (generic function)
• db-class-unfinished-classes (method)
• (setf db-class-unfinished-classes) (method)
• (setf db-class-unfinished-classes) (generic function)
• db-class-unique (generic function)
• db-class-unique (method)
• db-class-unique-keys (generic function)
• db-class-unique-keys (method)
• (setf db-class-unique-keys) (method)
• (setf db-class-unique-keys) (generic function)
• db-slots-of (function)
• delayed-constraint (generic function)
• delayed-constraint (method)
• (setf delayed-constraint) (method)
• (setf delayed-constraint) (generic function)
• id (generic function)
• id (method)
• id-seq-name (function)
• needed-type (generic function)
• needed-type (method)
• non-db-slot (function)
• not-null-p (generic function)
• not-null-p (method)
• (setf not-null-p) (method)
• (setf not-null-p) (generic function)
• on-delete (generic function)
• on-delete (method)
• (setf on-delete) (method)
• (setf on-delete) (generic function)
• relate-method (generic function)
• relatedp-method (generic function)
• remove-finished-classes (generic function)
• remove-finished-classes (method)
• set-fields (function)
• sql-column-does-not-exist (condition)
• sql-column-error (condition)
• table-name (generic function)
• table-name (method)
• table-name (method)
• transient-p (generic function)
• transient-p (method)
• (setf transient-p) (method)
• (setf transient-p) (generic function)
• try-delayed-constraints (generic function)
• try-delayed-constraints (method)
• unique (generic function)
• unique (method)
• (setf unique) (method)
• (setf unique) (generic function)
• unrelate-method (generic function)
• with-class-connection-fun (function)
• with-connection-fun (function)
• with-object-connection-fun (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: def-many-to-many CLASS1-NAME CLASS2-NAME &key CONNECTION-SPEC NAME

Defines a possibly named many-to-many mapping between two persistent classes. There can be only one unnamed mapping between any two classes, and any number of named mappings. CLASS*-NAME should be an (unquoted) symbol with class name.

Defines additional mapping persistent class ‘NAME’ (if ‘NAME’ is not provided, ‘CLASS1-NAME-CLASS2-NAME’ is used), and for each of classes, a method that retrieves list of instances of second class (named like that class or, if the relation is named, CLASS-NAME-IN-NAME. Mapping class has three slots, ‘CLASS1-NAME’ and ‘CLASS2-NAME’ that hold instances of first and second class, and ‘WEIGHT’ that holds an integer representing the strength of the relationship. The following functions are available:

* A predicate ‘RELATEDP’, taking a keyword argument ‘RELATION’, which tells whether two objects are in a relation (if ‘RELATION’ is not provided, the unnamed relation is assumed). It returns a ‘NAME’ or ‘CLASS1-NAME-CLASS2-NAME’ object. It has an accessor ‘WEIGHT’.

* A function ‘RELATE’ (‘RELATE-IN-NAME’) that establishes a relationship between its two arguments. It takes a key-argument, ‘WEIGHT’, by default 1. The order in which the object arguments are provided is irrelevant. ‘CONNECTION-SPEC’ specifies the connection to be used to create the link table.

Package

submarine

Source

dao.lisp (file)

Macro: defdao NAME SUPERS &body BODY

Wrapper macro for defining a class inheriting from DAO and with the metaclass set to DB-CLASS.

Package

submarine

Source

mop.lisp (file)

Macro: make-and-save TYPE &rest REST

Make a DAO and immediately save it. Takes the same arguments as (make-instance ((dao dao))).

Package

submarine

Source

dao.lisp (file)

Macro: query-dao TYPE QUERY

Execute the given ‘QUERY’ (which can be either a string or a S-SQL expression, which won’t be evaluated) and return the result as daos of the given ‘TYPE’. The names of the fields returned by the query must match the slots of the dao.

Package

submarine

Source

dao.lisp (file)

Macro: select-dao TYPE &optional TEST

Select daos of TYPE for the rows in its table for which the given TEST holds.

Package

submarine

Source

dao.lisp (file)

Macro: with-class-connection (CLASS) &body BODY

Run BODY in an environment with an always pooled connection to the database specified by the DB-CLASS-CONNECTION-SPEC of CLASS.

Package

submarine

Source

utilities.lisp (file)

Macro: with-connection (DATABASE USER PASSWORD HOST &key PORT POOLED-P) &body BODY

Binds *database* to a new connection and runs body in that scope.

Package

submarine

Source

utilities.lisp (file)

Macro: with-object-connection (OBJECT) &body BODY

Run BODY in an environment with a connection to the database specified by the DB-CLASS-CONNECTION-SPEC of the class of OBJECT.

Package

submarine

Source

utilities.lisp (file)

4.1.2 Functions

Function: get-dao TYPE ID

Get the dao corresponding to the given primary key, or return nil if it does not exist.

Package

submarine

Source

dao.lisp (file)

Function: make-dao TYPE INITARGS

Create a DAO of the given ‘TYPE’ and initialize it according to the values of the alist ‘INITARGS’. ‘Initargs’ may contain additional values, not used in the initialization proccess.

Package

submarine

Source

dao.lisp (file)

Function: query-dao-fun TYPE QUERY

Execute the given ‘QUERY’ (which can be either a string or a S-SQL expression, which will be evaluated) and return the result as daos of the given ‘TYPE’. The names of the fields returned by the query must match the slots of the dao. This is a functional interface for ‘QUERY-DAO’.

Package

submarine

Source

dao.lisp (file)

Function: relate OBJECT1 OBJECT2 &key RELATION WEIGHT

Make OBJECT1 and OBJECT2 enter into the many-to-many relation ‘RELATION’. If ‘RELATION’ is not provided, the unnamed relation is assumed.

Package

submarine

Source

dao.lisp (file)

Function: relatedp OBJECT1 OBJECT2 &key RELATION

Tell whether ‘OBJECT1’ and ‘OBJECT2’ are in the many-to-many relation ‘RELATION’ (or the unnamed relation if ‘RELATION’ is not provided).

Package

submarine

Source

dao.lisp (file)

Function: select-dao-fun TYPE TEST

Functional interface for SELECT-DAO.

Package

submarine

Source

dao.lisp (file)

Function: slot-value-or-id-if-foreign OBJECT SLOT

SLOT-VALUE if SLOT in OBJECT is not foreign, the ID of the object in the slot otherwise. If the object is not saved, save it.

Package

submarine

Source

dao.lisp (file)

Function: unrelate OBJECT1 OBJECT2 &key RELATION

‘OBJECT1’ stops being with ‘OBJECT2’ in ‘RELATION’.

Package

submarine

Source

dao.lisp (file)

4.1.3 Generic functions

Generic Function: dao-exists-p DAO

Return a boolean indicating whether the given DAO exists in the database.

Package

submarine

Source

dao.lisp (file)

Methods

Method: dao-exists-p (DAO dao)

Generic Function: dao= LEFT RIGHT &key TEST

T if all the slot-values of ‘LEFT’ and ‘RIGHT’
are the same. If the compared values are not DAO’s, they are compared using ‘TEST’ (which defaults to ‘EQL’). Otherwise, they are ‘DAO=’ed, with the same ‘TEST’ argument as specified in the topmost call of ‘DAO=’. If neither ‘LEFT’ nor ‘RIGHT’ are DAOs, ‘TEST’ is called.

Package

submarine

Source

dao.lisp (file)

Methods

Method: dao= (LEFT dao) (RIGHT dao) &key TEST

Method: dao= LEFT RIGHT &key TEST

Generic Function: delete-dao DAO

Delete the given dao from the database.

Package

submarine

Source

dao.lisp (file)

Methods

Method: delete-dao (DAO dao)

Generic Function: foreign-type-p OBJECT

Generic Function: (setf foreign-type-p) NEW-VALUE OBJECT

Package

submarine

Methods

Method: foreign-type-p (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf foreign-type-p) NEW-VALUE (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

automatically generated writer method

Source

mop.lisp (file)

Generic Function: get-all TYPE OBJECT

Get all objects of TYPE that stand in a many-to-one relation with OBJECT.

Package

submarine

Source

dao.lisp (file)

Methods

Method: get-all TYPE OBJECT

Generic Function: get-id OBJECT

Generic Function: (setf get-id) NEW-VALUE OBJECT

Package

submarine

Methods

Method: get-id (DAO dao)

automatically generated reader method

Source

dao.lisp (file)

Method: (setf get-id) NEW-VALUE (DAO dao)

automatically generated writer method

Source

dao.lisp (file)

Generic Function: insert-dao DAO

Insert the given DAO into the database.

Package

submarine

Source

dao.lisp (file)

Methods

Method: insert-dao (DAO dao)

Generic Function: save-dao OBJECT

Save a dao: update it when it already exists, insert it otherwise.

Package

submarine

Source

dao.lisp (file)

Methods

Method: save-dao (DAO dao)

Generic Function: update-dao DAO

Update the DAO’s representation in the database with the values in the given object and return it.

Package

submarine

Source

dao.lisp (file)

Methods

Method: update-dao (DAO dao)

4.1.4 Conditions

Condition: dao-error ()

Base class for DAO related errors.

Package

submarine

Source

conditions.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

• dao-nonexistent-id (condition)
• unresolved-foreign-key (condition)

Direct methods

table-name (method)

Direct slots

Slot: type

Initargs

:type

Readers

table-name (generic function)

Condition: dao-nonexistent-id ()

Condition signaling the attempt to initialize a dao with a non-existant ID.

Package

submarine

Source

conditions.lisp (file)

Direct superclasses

dao-error (condition)

Direct methods

id (method)

Direct slots

Slot: id

Initargs

:id

Readers

id (generic function)

Condition: unresolved-foreign-key ()

Condition signaling that a class with a foreign-key reference to a non-defined class has been tried to be used.

Package

submarine

Source

conditions.lisp (file)

Direct superclasses

dao-error (condition)

4.1.5 Classes

Class: dao ()

Base class for any PostgreSQL aware classes.

Package

submarine

Source

dao.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• delete-dao (method)
• dao= (method)
• shared-initialize (method)
• shared-initialize (method)
• update-dao (method)
• insert-dao (method)
• dao-exists-p (method)
• save-dao (method)
• get-id (method)
• get-id (method)

Direct slots

Slot: id

Type

integer

Initargs

:id

Readers

get-id (generic function)

Writers

(setf get-id) (generic function)

Class: db-class ()

Metaclass for PostgreSQL aware classes. It takes
two additional arguments in DEFTABLE: :INDICES (which slots are used as indices) and :CONNECTION-SPEC, which specifies how the class should connect to the database (its format is the same as in POSTMODERN:CONNECT-TOPLEVEL). If :CONNECTION-SPEC is not provided, SUBMARINE assumes it is a class created just for the sake of inheritance and does not create any tables for it.

Package

submarine

Source

mop.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• database-consistent-with-specification (method)
• apply-unique-constraints (method)
• apply-foreign-key-constraints (method)
• create-table (method)
• try-delayed-constraints (method)
• remove-finished-classes (method)
• collect-constraints (method)
• shared-initialize (method)
• compute-effective-slot-definition (method)
• validate-superclass (method)
• effective-slot-definition-class (method)
• direct-slot-definition-class (method)
• db-class-unique-keys (method)
• db-class-unique-keys (method)
• db-class-foreign-keys (method)
• db-class-foreign-keys (method)
• db-class-unfinished-classes (method)
• db-class-unfinished-classes (method)
• db-class-connection-spec (method)
• db-class-unique (method)
• db-class-indices (method)

Direct slots

Slot: indices

Initargs

:indices

Readers

db-class-indices (generic function)

Slot: unique

Initargs

:unique

Readers

db-class-unique (generic function)

Slot: connection-spec

Initargs

:connection-spec

Readers

db-class-connection-spec (generic function)

Slot: unfinished-classes

A class allocated slot
containing classes for whom not all the constraints could be applied.

Allocation

:class

Readers

db-class-unfinished-classes (generic function)

Writers

(setf db-class-unfinished-classes) (generic function)

Slot: foreign-keys

List of foreign-key slots.

Readers

db-class-foreign-keys (generic function)

Writers

(setf db-class-foreign-keys) (generic function)

Slot: unique-keys

List of slots whose value should be unique.

Readers

db-class-unique-keys (generic function)

Writers

(setf db-class-unique-keys) (generic function)

4.2 Internal definitions

4.2.1 Functions

Function: class-db-slots CLASS

Return the list of non-transient, instance allocated slots of a class.

Package

submarine

Source

utilities.lisp (file)

Function: db-slots-of OBJECT

List of non-transient, instance allocated slots of OBJECT

Package

submarine

Source

utilities.lisp (file)

Function: id-seq-name CLASS

Package

submarine

Source

dao.lisp (file)

Function: non-db-slot SLOT

Slot is transient or its allocation is :CLASS.

Package

submarine

Source

utilities.lisp (file)

Function: set-fields OBJECT

Package

submarine

Source

dao.lisp (file)

Function: with-class-connection-fun CLASS WHAT-TO-DO

Functional interface to the macro WITH-CLASS-CONNECTION. the connection will be pooled.

Package

submarine

Source

utilities.lisp (file)

Function: with-connection-fun CONNECTION-SPEC WHAT-TO-DO

Functional interface to the macro WITH-CONNECTION.

Package

submarine

Source

utilities.lisp (file)

Function: with-object-connection-fun OBJECT WHAT-TO-DO

Functional interface to the macro WITH-OBJECT-CONNECTION.

Package

submarine

Source

utilities.lisp (file)

4.2.2 Generic functions

Generic Function: actual-type CONDITION

Package

submarine

Methods

Method: actual-type (CONDITION sql-column-error)

Source

db.lisp (file)

Generic Function: add-constraint SLOT CONSTRAINT

Add a constraint to this slot’s class’ table.

Package

submarine

Source

db.lisp (file)

Methods

Method: add-constraint (LIST list) (CONSTRAINT (eql unique))

Method: add-constraint (SLOT db-class-slot-definition) (CONSTRAINT (eql unique))

Method: add-constraint (SLOT db-class-slot-definition) (CONSTRAINT (eql foreign-key))

Method: add-constraint (SLOT db-class-slot-definition) CONSTRAINT around

Generic Function: apply-foreign-key-constraints CLASS

Package

submarine

Methods

Method: apply-foreign-key-constraints (CLASS db-class)

Source

db.lisp (file)

Generic Function: apply-unique-constraints CLASS

Package

submarine

Methods

Method: apply-unique-constraints (CLASS db-class)

Source

db.lisp (file)

Generic Function: collect-constraints CLASS

Package

submarine

Methods

Method: collect-constraints (CLASS db-class)

Source

mop.lisp (file)

Generic Function: column-name CONDITION

Package

submarine

Methods

Method: column-name (CONDITION sql-column-does-not-exist)

Source

db.lisp (file)

Method: column-name (CONDITION sql-column-error)

Source

db.lisp (file)

Generic Function: column-type CONDITION

Package

submarine

Methods

Method: column-type (CONDITION sql-column-does-not-exist)

Source

db.lisp (file)

Generic Function: create-table CLASS

Create a table whose columns match the fields of
CLASS in the connected database. If CLASS is a symbol, the class it names is used.

Package

submarine

Source

db.lisp (file)

Methods

Method: create-table (NAME symbol)

Method: create-table (CLASS db-class)

Generic Function: database-consistent-with-specification CLASS

Return nothing if TABLE in the connected-p database
meets its specification. Otherwise, throw an appropriate error. There must exist a connection to the DATABASE in order to run this function.

Package

submarine

Source

db.lisp (file)

Methods

Method: database-consistent-with-specification (CLASS db-class)

Generic Function: db-class-connection-spec OBJECT

Package

submarine

Methods

Method: db-class-connection-spec (DB-CLASS db-class)

automatically generated reader method

Source

mop.lisp (file)

Generic Function: db-class-foreign-keys OBJECT

Generic Function: (setf db-class-foreign-keys) NEW-VALUE OBJECT

Package

submarine

Methods

Method: db-class-foreign-keys (DB-CLASS db-class)

Method: (setf db-class-foreign-keys) NEW-VALUE (DB-CLASS db-class)

List of foreign-key slots.

Source

mop.lisp (file)

Generic Function: db-class-indices OBJECT

Package

submarine

Methods

Method: db-class-indices (DB-CLASS db-class)

automatically generated reader method

Source

mop.lisp (file)

Generic Function: db-class-unfinished-classes OBJECT

Generic Function: (setf db-class-unfinished-classes) NEW-VALUE OBJECT

Package

submarine

Methods

Method: db-class-unfinished-classes (DB-CLASS db-class)

Method: (setf db-class-unfinished-classes) NEW-VALUE (DB-CLASS db-class)

A class allocated slot
containing classes for whom not all the constraints could be applied.

Source

mop.lisp (file)

Generic Function: db-class-unique OBJECT

Package

submarine

Methods

Method: db-class-unique (DB-CLASS db-class)

automatically generated reader method

Source

mop.lisp (file)

Generic Function: db-class-unique-keys OBJECT

Generic Function: (setf db-class-unique-keys) NEW-VALUE OBJECT

Package

submarine

Methods

Method: db-class-unique-keys (DB-CLASS db-class)

Method: (setf db-class-unique-keys) NEW-VALUE (DB-CLASS db-class)

List of slots whose value should be unique.

Source

mop.lisp (file)

Generic Function: delayed-constraint OBJECT

Generic Function: (setf delayed-constraint) NEW-VALUE OBJECT

Package

submarine

Methods

Method: delayed-constraint (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

Method: (setf delayed-constraint) NEW-VALUE (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

Closures adding constraints
that, for some reason, could not be executed. If there’s a slot with this attribute not-NIL in a class definition, then there’s something wrong with its SQL counterpart.

Source

mop.lisp (file)

Generic Function: id CONDITION

Package

submarine

Methods

Method: id (CONDITION dao-nonexistent-id)

Source

conditions.lisp (file)

Generic Function: needed-type CONDITION

Package

submarine

Methods

Method: needed-type (CONDITION sql-column-error)

Source

db.lisp (file)

Generic Function: not-null-p OBJECT

Generic Function: (setf not-null-p) NEW-VALUE OBJECT

Package

submarine

Methods

Method: not-null-p (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

Method: (setf not-null-p) NEW-VALUE (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

If non-NIL, a NON NULL database constrained will be introduced.

Source

mop.lisp (file)

Generic Function: on-delete OBJECT

Generic Function: (setf on-delete) NEW-VALUE OBJECT

Package

submarine

Methods

Method: on-delete (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

Method: (setf on-delete) NEW-VALUE (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

Action to be performed for this slot
when the refering row in the database ceases to exist. Possible values: :CASCADE, :RESTRICT, :SET-NULL, :SET-DEFAULT. If this slot is not a foreign key, it does nothing.

Source

mop.lisp (file)

Generic Function: relate-method OBJECT1 OBJECT2 RELATION WEIGHT

Relate ‘OBJECT1’ with ‘OBJECT2’ in ‘RELATION’.

Package

submarine

Source

dao.lisp (file)

Generic Function: relatedp-method OBJECT1 OBJECT2 RELATION

Tell if ‘OBJECT1’ is related to ‘OBJECT2’ in ‘RELATION’.

Package

submarine

Source

dao.lisp (file)

Generic Function: remove-finished-classes CLASS

Remove classes that are already finished from UNFINISHED-CLASSES of CLASS.

Package

submarine

Source

mop.lisp (file)

Methods

Method: remove-finished-classes (CLASS db-class)

Generic Function: table-name CONDITION

Package

submarine

Methods

Method: table-name (CONDITION sql-error)

Source

db.lisp (file)

Method: table-name (CONDITION dao-error)

Source

conditions.lisp (file)

Generic Function: transient-p OBJECT

Generic Function: (setf transient-p) NEW-VALUE OBJECT

Package

submarine

Methods

Method: transient-p (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

Method: (setf transient-p) NEW-VALUE (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

If non-NIL, this slot should be treated as transient and ignored in all database related operations.

Source

mop.lisp (file)

Generic Function: try-delayed-constraints CLASS

Try to call all the delayed constraints present.

Package

submarine

Source

mop.lisp (file)

Methods

Method: try-delayed-constraints (CLASS db-class)

Generic Function: unique OBJECT

Generic Function: (setf unique) NEW-VALUE OBJECT

Package

submarine

Methods

Method: unique (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf unique) NEW-VALUE (DB-CLASS-SLOT-DEFINITION db-class-slot-definition)

automatically generated writer method

Source

mop.lisp (file)

Generic Function: unrelate-method OBJECT1 OBJECT2 RELATION

‘OBJECT1’ stops being with ‘OBJECT2’ in ‘RELATION’.

Package

submarine

Source

dao.lisp (file)

4.2.3 Conditions

Condition: sql-column-does-not-exist ()

Condition signaling a missing column in an existing table.

Package

submarine

Source

db.lisp (file)

Direct superclasses

sql-error (condition)

Direct methods

• column-type (method)
• column-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

column-name (generic function)

Slot: type

Initargs

:type

Readers

column-type (generic function)

Condition: sql-column-error ()

An error symbolizing that there is a column of the right name in the table, but its type is wrong

Package

submarine

Source

db.lisp (file)

Direct superclasses

sql-error (condition)

Direct methods

• actual-type (method)
• needed-type (method)
• column-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

column-name (generic function)

Slot: needed-type

Initargs

:needed

Readers

needed-type (generic function)

Slot: actual-type

Initargs

:actual

Readers

actual-type (generic function)

4.2.4 Classes

Class: db-class-direct-slot-definition ()

Package

submarine

Source

mop.lisp (file)

Direct superclasses

• db-class-slot-definition (class)
• standard-direct-slot-definition (class)

Class: db-class-effective-slot-definition ()

Package

submarine

Source

mop.lisp (file)

Direct superclasses

• db-class-slot-definition (class)
• standard-effective-slot-definition (class)

Class: db-class-slot-definition ()

Package

submarine

Source

mop.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• db-class-direct-slot-definition (class)
• db-class-effective-slot-definition (class)

Direct methods

• add-constraint (method)
• add-constraint (method)
• add-constraint (method)
• delayed-constraint (method)
• delayed-constraint (method)
• on-delete (method)
• on-delete (method)
• unique (method)
• unique (method)
• foreign-type-p (method)
• foreign-type-p (method)
• not-null-p (method)
• not-null-p (method)
• transient-p (method)
• transient-p (method)

Direct slots

Slot: transient

If non-NIL, this slot should be treated as transient and ignored in all database related operations.

Initargs

:transient

Readers

transient-p (generic function)

Writers

(setf transient-p) (generic function)

Slot: not-null

If non-NIL, a NON NULL database constrained will be introduced.

Initargs

:not-null

Readers

not-null-p (generic function)

Writers

(setf not-null-p) (generic function)

Slot: foreign

Initargs

:foreign

Readers

foreign-type-p (generic function)

Writers

(setf foreign-type-p) (generic function)

Slot: unique

Initargs

:unique

Readers

unique (generic function)

Writers

(setf unique) (generic function)

Slot: on-delete

Action to be performed for this slot
when the refering row in the database ceases to exist. Possible values: :CASCADE, :RESTRICT, :SET-NULL, :SET-DEFAULT. If this slot is not a foreign key, it does nothing.

Initargs

:on-delete

Initform

:cascade

Readers

on-delete (generic function)

Writers

(setf on-delete) (generic function)

Slot: delayed-constraint

Closures adding constraints
that, for some reason, could not be executed. If there’s a slot with this attribute not-NIL in a class definition, then there’s something wrong with its SQL counterpart.

Readers

delayed-constraint (generic function)

Writers

(setf delayed-constraint) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types