2.1 mito

Abstraction layer for DB schema

Author

Eitaro Fukamachi

License

LLGPL

Long Description

# Mito

[](https://github.com/fukamachi/mito/actions?query=workflow%3ACI)
[](http://quickdocs.org/mito/)

Mito is yet another object relational mapper, and it aims to be a successor of [Integral](https://github.com/fukamachi/integral).

* Supports MySQL, PostgreSQL and SQLite3
* Adds ‘id‘ (serial/uuid primary key), ‘created_at‘ and ‘updated_at‘ by default like Ruby’s ActiveRecord
* Migrations
* DB schema versioning

## Warning

This software is still ALPHA quality. The APIs likely change.

This software should work fine with MySQL, PostgreSQL and SQLite3 on SBCL/Clozure CL.

## Usage

“‘common-lisp
(mito:connect-toplevel :mysql :database-name "myapp" :username "fukamachi" :password "c0mon-1isp")
;=> #<DBD.MYSQL:<DBD-MYSQL-CONNECTION> {100691BFF3}>

(mito:deftable user ()
((name :col-type (:varchar 64))
(email :col-type (or (:varchar 128) :null))))
;=> #<MITO.DAO.TABLE:DAO-TABLE-CLASS COMMON-LISP-USER::USER>

(mito:table-definition ’user)
;=> (#<SXQL-STATEMENT: CREATE TABLE user (id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, name VARCHAR(64) NOT NULL, email VARCHAR(128))>)

(mito:deftable tweet ()
((status :col-type :text)
(user :col-type user)))
;=> #<MITO.DAO.TABLE:DAO-TABLE-CLASS COMMON-LISP-USER::TWEET>

(mito:table-definition ’tweet)
;=> (#<SXQL-STATEMENT: CREATE TABLE tweet (id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, status TEXT NOT NULL, user_id BIGINT UNSIGNED NOT NULL, created_at TIMESTAMP, updated_at TIMESTAMP)>)
“‘

### Connecting to DB

Mito provides the functions ‘connect-toplevel‘ and ‘disconnect-toplevel‘ to establish and sever a connection to RDBMS.

‘connect-toplevel‘ takes the same arguments as ‘dbi:connect‘: typically the driver-type, the database name to connect, user name and password.

“‘common-lisp
(mito:connect-toplevel :mysql :database-name "myapp" :username "fukamachi" :password "c0mon-1isp")
“‘

‘connect-toplevel‘ sets ‘*connection*‘ to a new connection and returns it.

To use a connection lexically, just bind it:

“‘common-lisp
(let ((mito:*connection* (dbi:connect :sqlite3 :database-name #P"/tmp/myapp.db")))
(unwind-protect (progn ...)
;; Ensure that the connection is closed.
(dbi:disconnect mito:*connection*)))
“‘

In most cases ‘dbi:connect-cached‘ is a better option, since it reuses a connection for multiple threads.

“‘common-lisp
(let ((mito:*connection* (dbi:connect-cached :sqlite3 :database-name #P"/tmp/myapp.db")))
(unwind-protect (progn ...)
;; Ensure that the connection is closed.
))
“‘

Use ‘connection-database-name‘ to get the name of the current connection, or of one named via parameter.

### deftable macro

As Mito’s dao table class is defined as a CLOS metaclass, a table class can be defined like this:

“‘common-lisp
(defclass user ()
((name :col-type (:varchar 64)
:accessor user-name)
(email :col-type (or (:varchar 128) :null)
:accessor user-email))
(:metaclass mito:dao-table-class))
“‘

‘deftable‘’s syntax is the same as that of ‘cl:defclass‘. However, the definition is a little bit redundant.

‘mito:deftable‘ is a thin macro, to allow definion of a table class with less typing.

For example, the above example can be rewritten, using ‘deftable‘ as follows.

“‘common-lisp
(mito:deftable user ()
((name :col-type (:varchar 64))
(email :col-type (or (:varchar 128) :null))))
“‘

It adds ‘:metaclass mito:dao-table-class‘, and adds default accessors that start with ‘<class-name>-‘ by default, like ‘defstruct‘ does.

The prefix for accessors can be changed with the ‘:conc-name‘ class option:

“‘common-lisp
(mito:deftable user ()
((name :col-type (:varchar 64))
(email :col-type (or (:varchar 128) :null)))
(:conc-name my-))

(my-name (make-instance ’user :name "fukamachi"))
;=> "fukamachi"
“‘

If ‘:conc-name‘ is NIL, default accessors will NOT be defined.

### Class Definitions

In Mito, a class corresponding to a database table is defined by specifying ‘(:metaclass mito:dao-table-class)‘.

“‘common-lisp
(defclass user ()
((name :col-type (:varchar 64)
:accessor user-name)
(email :col-type (or (:varchar 128) :null)
:accessor user-email))
(:metaclass mito:dao-table-class))
“‘

The above defines a Common Lisp normal class, except that it allows additional options.

“‘
(defclass {class-name} ()
({column-definition}*)
(:metaclass mito:dao-table-class)
[[class-option]])

column-definition ::= (slot-name [[column-option]])
column-option ::= {:col-type col-type} |
{:primary-key boolean} |
{:inflate inflation-function} |
{:deflate deflation-function} |
{:references {class-name | (class-name slot-name)}} |
{:ghost boolean}
col-type ::= { keyword |
(keyword . args) |
(or keyword :null) |
(or :null keyword) }
class-option ::= {:primary-key symbol*} |
{:unique-keys {symbol | (symbol*)}*} |
{:keys {symbol | (symbol*)}*} |
{:table-name table-name} |
{:auto-pk auto-pk-mixin-class-name} |
{:record-timestamps boolean} |
{:conc-name conc-name}
auto-pk-mixin-class-name ::= {:serial | :uuid}
conc-name ::= {null | string-designator}
“‘

Note: the class automatically adds some slots – a primary key named ‘id‘ if there is no primary key, ‘created_at‘ and ‘updated_at‘ for recording timestamps. To disable these behaviors, specify ‘:auto-pk nil‘ or ‘:record-timestamps nil‘ to defclass forms.

“‘common-lisp
(mito.class:table-column-slots (find-class ’user))
;=> (#<MITO.DAO.COLUMN:DAO-TABLE-COLUMN-CLASS MITO.DAO.MIXIN::ID>
; #<MITO.DAO.COLUMN:DAO-TABLE-COLUMN-CLASS COMMON-LISP-USER::NAME>
; #<MITO.DAO.COLUMN:DAO-TABLE-COLUMN-CLASS COMMON-LISP-USER::EMAIL>
; #<MITO.DAO.COLUMN:DAO-TABLE-COLUMN-CLASS MITO.DAO.MIXIN::CREATED-AT>
; #<MITO.DAO.COLUMN:DAO-TABLE-COLUMN-CLASS MITO.DAO.MIXIN::UPDATED-AT>)
“‘

This class inherits ‘mito:dao-class‘ implicitly.

“‘common-lisp
(find-class ’user)
;=> #<MITO.DAO.TABLE:DAO-TABLE-CLASS COMMON-LISP-USER::USER>

(c2mop:class-direct-superclasses *)
;=> (#<STANDARD-CLASS MITO.DAO.TABLE:DAO-CLASS>)
“‘

This may be useful to define methods that can be applied for many or all table classes.

#### :col-type Options

The following are valid keywords for :col-type in the ‘deftable‘ definition above.

“‘common-lisp
:serial
:bigserial
:timestamptz
:integer
:bytea
:timestamp
:bigint
:unsigned
:int
:binary
:datetime
“‘

Besides the above keywords, there are other keywords that are valid, however they are dependent on the RDS and its version.

An example of this is that ‘:json‘ and ‘:jsonb‘ work for PostgreSQL but don’t work on an old version of MySQL which doesn’t support those types.

A complete list of valid ‘:col-type‘ options is dependent on the database system. Here’s a link for the current Data Types for:
- [PostgreSQL Data Types](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links)
- [MySQL Data Types](https://dev.mysql.com/doc/refman/8.0/en/data-types.html)
- [SQLite3 Data Types](https://www.sqlite.org/datatype3.html)

The symbols are not defined directly in the system, rather they are the symbol equivalent of the string which is the name for the data type. Therefore, for any data type name, just preprend a colon to the name ‘:data-type‘ in order to use it as a ‘col-type‘.

### Generating Table Definitions

“‘common-lisp
(mito:table-definition ’user)
;=> (#<SXQL-STATEMENT: CREATE TABLE user (id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, name VARCHAR(64) NOT NULL, email VARCHAR(128), created_at TIMESTAMP, updated_at TIMESTAMP)>)

(sxql:yield *)
;=> "CREATE TABLE user (id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, name VARCHAR(64) NOT NULL, email VARCHAR(128), created_at TIMESTAMP, updated_at TIMESTAMP)"
; NIL
“‘

### Creating DB tables

“‘common-lisp
(mapc #’mito:execute-sql (mito:table-definition ’user))

(mito:ensure-table-exists ’user)
“‘

### CRUD

“‘common-lisp
(defvar me
(make-instance ’user :name "Eitaro Fukamachi" :email "e.arrows@gmail.com"))
;=> USER

(mito:insert-dao me)
;-> ;; INSERT INTO ‘user‘ (‘name‘, ‘email‘, ‘created_at‘, ‘updated_at‘) VALUES (?, ?, ?, ?) ("Eitaro Fukamachi", "e.arrows@gmail.com", "2016-02-04T19:55:16.365543Z", "2016-02-04T19:55:16.365543Z") [0 rows] | MITO.DAO:INSERT-DAO
;=> #<USER {10053C4453}>

;; Same as above
(mito:create-dao ’user :name "Eitaro Fukamachi" :email "e.arrows@gmail.com")

;; Getting the primary key value
(mito:object-id me)
;=> 1

;; Retrieving from the DB
(mito:find-dao ’user :id 1)
;-> ;; SELECT * FROM ‘user‘ WHERE (‘id‘ = ?) LIMIT 1 (1) [1 row] | MITO.DB:RETRIEVE-BY-SQL
;=> #<USER {10077C6073}>

(mito:retrieve-dao ’user)
;=> (#<USER {10077C6073}>)

;; Updating
(setf (slot-value me ’name) "nitro_idiot")
;=> "nitro_idiot"

(mito:save-dao me)
;-> ;; UPDATE ‘user‘ SET ‘id‘ = ?, ‘name‘ = ?, ‘email‘ = ?, ‘created_at‘ = ?, ‘updated_at‘ = ? WHERE (‘id‘ = ?) (2, "nitro_idiot", "e.arrows@gmail.com", "2016-02-04T19:56:11.408927Z", "2016-02-04T19:56:19.006020Z", 2) [0 rows] | MITO.DAO:UPDATE-DAO

;; Deleting
(mito:delete-dao me)
;-> ;; DELETE FROM ‘user‘ WHERE (‘id‘ = ?) (1) [0 rows] | MITO.DAO:DELETE-DAO
(mito:delete-by-values ’user :id 1)
;-> ;; DELETE FROM ‘user‘ WHERE (‘id‘ = ?) (1) [0 rows] | MITO.DAO:DELETE-DAO

;; Counting
(mito:count-dao ’user)
;-> 1
“‘

Use ‘select-dao‘ to build custom queries with sxql (examples below).

### Relationship

To define a relationship, use ‘:references‘ on the slot:

“‘common-lisp
(mito:deftable user ()
((id :col-type (:varchar 36)
:primary-key t)
(name :col-type (:varchar 64))
(email :col-type (or (:varchar 128) :null))))

(mito:deftable tweet ()
((status :col-type :text)
;; This slot refers to USER class
(user-id :references (user id))))

;; The :col-type of USER-ID column is retrieved from the foreign class.
(mito:table-definition (find-class ’tweet))
;=> (#<SXQL-STATEMENT: CREATE TABLE tweet (
; id BIGSERIAL NOT NULL PRIMARY KEY,
; status TEXT NOT NULL,
; user_id VARCHAR(36) NOT NULL,
; created_at TIMESTAMPTZ,
; updated_at TIMESTAMPTZ
; )>)
“‘

You can also specify another foreign class at ‘:col-type‘ to define a relationship:

“‘common-lisp
(mito:deftable tweet ()
((status :col-type :text)
;; This slot refers to USER class
(user :col-type user)))

(mito:table-definition (find-class ’tweet))
;=> (#<SXQL-STATEMENT: CREATE TABLE tweet (
; id BIGSERIAL NOT NULL PRIMARY KEY,
; status TEXT NOT NULL,
; user_id VARCHAR(36) NOT NULL,
; created_at TIMESTAMP,
; updated_at TIMESTAMP
; )>)

;; You can specify :USER arg, instead of :USER-ID.
(defvar *user* (mito:create-dao ’user :name "Eitaro Fukamachi"))
(mito:create-dao ’tweet :user *user*)

(mito:find-dao ’tweet :user *user*)
“‘

The latter example allows you to create/retrieve ‘TWEET‘ by a ‘USER‘ object, not a ‘USER-ID‘.

Mito doesn’t add foreign key constraints for referring tables, since I’m not sure it’s still handful while using with ORMs.

### Inflation/Deflation

Inflation/Deflation is a function to convert values between Mito and RDBMS.

“‘common-lisp
(mito:deftable user-report ()
((title :col-type (:varchar 100))
(body :col-type :text
:initform "")
(reported-at :col-type :timestamp
:initform (local-time:now)
:inflate #’local-time:universal-to-timestamp
:deflate #’local-time:timestamp-to-universal))
(:conc-name report-))
“‘

### Eager loading

One of the pains in the neck to use ORMs is the "N+1 query" problem.

“‘common-lisp
;; BAD EXAMPLE

(use-package ’(:mito :sxql))

(defvar *tweets-contain-japan*
(select-dao ’tweet
(where (:like :status "%Japan%"))))

;; Getting names of tweeted users.
(mapcar (lambda (tweet)
(user-name (tweet-user tweet)))
*tweets-contain-japan*)
“‘

This example sends a query to retrieve a user, like "SELECT * FROM user WHERE id = ?" for each iteration.

To prevent this performance issue, add ‘includes‘ to the above query, which sends only a single WHERE IN query instead of N queries:

“‘common-lisp
;; GOOD EXAMPLE with eager loading

(use-package ’(:mito :sxql))

(defvar *tweets-contain-japan*
(select-dao ’tweet
(includes ’user)
(where (:like :status "%Japan%"))))
;-> ;; SELECT * FROM ‘tweet‘ WHERE (‘status‘ LIKE ?) ("%Japan%") [3 row] | MITO.DB:RETRIEVE-BY-SQL
;-> ;; SELECT * FROM ‘user‘ WHERE (‘id‘ IN (?, ?, ?)) (1, 3, 12) [3 row] | MITO.DB:RETRIEVE-BY-SQL
;=> (#<TWEET {1003513EC3}> #<TWEET {1007BABEF3}> #<TWEET {1007BB9D63}>)

;; No additional SQLs will be executed.
(tweet-user (first *))
;=> #<USER {100361E813}>
“‘

### Migrations

“‘common-lisp
(ensure-table-exists ’user)
;-> ;; CREATE TABLE IF NOT EXISTS "user" (
; "id" BIGSERIAL NOT NULL PRIMARY KEY,
; "name" VARCHAR(64) NOT NULL,
; "email" VARCHAR(128),
; "created_at" TIMESTAMP,
; "updated_at" TIMESTAMP
; ) () [0 rows] | MITO.DAO:ENSURE-TABLE-EXISTS

;; No changes
(mito:migration-expressions ’user)
;=> NIL

(mito:deftable user ()
((name :col-type (:varchar 64))
(email :col-type (:varchar 128)))
(:unique-keys email))

(mito:migration-expressions ’user)
;=> (#<SXQL-STATEMENT: ALTER TABLE user ALTER COLUMN email TYPE character varying(128), ALTER COLUMN email SET NOT NULL>
; #<SXQL-STATEMENT: CREATE UNIQUE INDEX unique_user_email ON user (email)>)

(mito:migrate-table ’user)
;-> ;; ALTER TABLE "user" ALTER COLUMN "email" TYPE character varying(128), ALTER COLUMN "email" SET NOT NULL () [0 rows] | MITO.MIGRATION.TABLE:MIGRATE-TABLE
; ;; CREATE UNIQUE INDEX "unique_user_email" ON "user" ("email") () [0 rows] | MITO.MIGRATION.TABLE:MIGRATE-TABLE
;-> (#<SXQL-STATEMENT: ALTER TABLE user ALTER COLUMN email TYPE character varying(128), ALTER COLUMN email SET NOT NULL>
; #<SXQL-STATEMENT: CREATE UNIQUE INDEX unique_user_email ON user (email)>)
“‘

SQLite3 migration creates temporary tables with pre-migration data. To delete them after migration is complete set
‘mito:*migration-keep-temp-tables*‘ to ‘nil‘. It has no effect on other drivers.

#### Auto migrations

If ‘mito:*auto-migration-mode*‘ is set to ‘t‘, and you are connected to a database, Mito will run migrations after
each change to model definitions.

### Schema versioning

“‘
$ ros install mito
$ mito
Usage: mito command [option...]

Commands:
generate-migrations
migrate
migration-status

Options:
-t, –type DRIVER-TYPE DBI driver type (one of "mysql", "postgres" or "sqlite3")
-d, –database DATABASE-NAME Database name to use
-u, –username USERNAME Username for RDBMS
-p, –password PASSWORD Password for RDBMS
-s, –system SYSTEM ASDF system to load (several -s’s allowed)
-D, –directory DIRECTORY Directory path to keep migration SQL files (default: "/Users/nitro_idiot/Programs/lib/mito/db/")
–dry-run List SQL expressions to migrate
-f, –force Create a new empty migration file even when it’s unnecessary.
“‘

#### Example

“‘
mito –database postgres –username fukamachi –pasword c0mmon-l1sp
“‘

### Inheritance and Mixin

A subclass of DAO-CLASS is allowed to be inherited. This may be useful when you need classes that have similar columns:

“‘common-lisp
(mito:deftable user ()
((name :col-type (:varchar 64))
(email :col-type (:varchar 128)))
(:unique-keys email))

(mito:deftable temporary-user (user)
((registered-at :col-type :timestamp)))

(mito:table-definition ’temporary-user)
;=> (#<SXQL-STATEMENT: CREATE TABLE temporary_user (
; id BIGSERIAL NOT NULL PRIMARY KEY,
; name VARCHAR(64) NOT NULL,
; email VARCHAR(128) NOT NULL,
; registered_at TIMESTAMP NOT NULL,
; created_at TIMESTAMP,
; updated_at TIMESTAMP,
; UNIQUE (email)
; )>)
“‘

If you need a ’template’ for tables, not related to any specific database table, you can use ‘DAO-TABLE-MIXIN‘:

“‘common-lisp
(defclass has-email ()
((email :col-type (:varchar 128)
:accessor object-email))
(:metaclass mito:dao-table-mixin)
(:unique-keys email))
;=> #<MITO.DAO.MIXIN:DAO-TABLE-MIXIN COMMON-LISP-USER::HAS-EMAIL>

(mito:deftable user (has-email)
((name :col-type (:varchar 64))))
;=> #<MITO.DAO.TABLE:DAO-TABLE-CLASS COMMON-LISP-USER::USER>

(mito:table-definition ’user)
;=> (#<SXQL-STATEMENT: CREATE TABLE user (
; id BIGSERIAL NOT NULL PRIMARY KEY,
; name VARCHAR(64) NOT NULL,
; email VARCHAR(128) NOT NULL,
; created_at TIMESTAMP,
; updated_at TIMESTAMP,
; UNIQUE (email)
; )>)
“‘

* [mito-attachment](https://github.com/fukamachi/mito-attachment)
* [mito-auth](https://github.com/fukamachi/mito-auth)

### Triggers

Since ‘insert-dao‘, ‘update-dao‘ and ‘delete-dao‘ are defined as generic functions, you can define ‘:before‘, ‘:after‘ or ‘:around‘ methods on those.

“‘common-lisp
(defmethod mito:insert-dao :before ((object user))
(format t "~&Adding ~S...~%" (user-name object)))

(mito:create-dao ’user :name "Eitaro Fukamachi" :email "e.arrows@gmail.com")
;-> Adding "Eitaro Fukamachi"...
; ;; INSERT INTO "user" ("name", "email", "created_at", "updated_at") VALUES (?, ?, ?, ?) ("Eitaro Fukamachi", "e.arrows@gmail.com", "2016-02-16 21:13:47", "2016-02-16 21:13:47") [0 rows] | MITO.DAO:INSERT-DAO
;=> #<USER {100835FB33}>
“‘

## Installation

“‘common-lisp
(ql:quickload :mito)
“‘

Or, with Roswell:

“‘
ros install mito
“‘

## See Also

* [CL-DBI](https://github.com/fukamachi/cl-dbi)
* [SxQL](https://github.com/fukamachi/sxql)

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the LLGPL License.

Version

0.1

Dependencies

• mito-core (system).
• mito-migration (system).
• lack-middleware-mito (system).
• cl-reexport (system).

Source

mito.asd.

Child Component

src/mito.lisp (file).

2.2 mito-core

Author

Eitaro Fukamachi

License

LLGPL

Version

0.1

Dependencies

• dbi (system)., at least version "0.9.5"
• sxql (system).
• cl-ppcre (system).
• closer-mop (system).
• dissect (system).
• trivia (system).
• cl-reexport (system).
• local-time (system).
• uuid (system).
• alexandria (system).

Source

mito-core.asd.

Child Components

• src/core.lisp (file).
• core-components (module).

2.3 mito-migration

Author

Eitaro Fukamachi

License

LLGPL

Version

0.1

Dependencies

• mito-core (system).
• sxql (system).
• dbi (system).
• closer-mop (system).
• cl-reexport (system).
• esrap (system).
• alexandria (system).
• uiop (system).
• chipz (system).

Source

mito-migration.asd.

Child Components

• src/migration.lisp (file).
• migration-components (module).

2.4 lack-middleware-mito

Author

Eitaro Fukamachi

License

LLGPL

Version

0.1

Dependencies

• mito-core (system).
• dbi (system).

Source

lack-middleware-mito.asd.

Child Component

src (module).

3.1 mito-core/core-components

Source

mito-core.asd.

Parent Component

mito-core (system).

Child Components

• dao.lisp (file).
• dao-components (module).
• class.lisp (file).
• class-components (module).
• connection.lisp (file).
• type.lisp (file).
• db.lisp (file).
• db-drivers (module).
• logger.lisp (file).
• error.lisp (file).
• util.lisp (file).

3.2 mito-core/core-components/dao-components

Dependencies

• connection.lisp (file).
• class.lisp (file).
• db.lisp (file).
• logger.lisp (file).
• util.lisp (file).

Source

mito-core.asd.

Parent Component

core-components (module).

Child Components

• table.lisp (file).
• view.lisp (file).
• mixin.lisp (file).
• column.lisp (file).

3.3 mito-core/core-components/class-components

Dependencies

• error.lisp (file).
• util.lisp (file).

Source

mito-core.asd.

Parent Component

core-components (module).

Child Components

• table.lisp (file).
• column.lisp (file).

3.4 mito-core/core-components/db-drivers

Dependencies

• logger.lisp (file).
• util.lisp (file).

Source

mito-core.asd.

Parent Component

core-components (module).

Child Components

• mysql.lisp (file).
• postgres.lisp (file).
• sqlite3.lisp (file).

3.5 mito-migration/migration-components

Source

mito-migration.asd.

Parent Component

mito-migration (system).

Child Components

• table.lisp (file).
• versions.lisp (file).
• sxql.lisp (file).
• sql-parse.lisp (file).
• util.lisp (file).

3.6 lack-middleware-mito/src

Source

lack-middleware-mito.asd.

Parent Component

lack-middleware-mito (system).

Child Component

middleware.lisp (file).

4.1 Lisp

• mito/mito.asd
• mito-core/mito-core.asd
• mito-migration/mito-migration.asd
• lack-middleware-mito/lack-middleware-mito.asd
• mito/src/mito.lisp
• mito-core/src/core.lisp
• mito-core/core-components/dao.lisp
• mito-core/core-components/dao-components/table.lisp
• mito-core/core-components/dao-components/view.lisp
• mito-core/core-components/dao-components/mixin.lisp
• mito-core/core-components/dao-components/column.lisp
• mito-core/core-components/class.lisp
• mito-core/core-components/class-components/table.lisp
• mito-core/core-components/class-components/column.lisp
• mito-core/core-components/connection.lisp
• mito-core/core-components/type.lisp
• mito-core/core-components/db.lisp
• mito-core/core-components/db-drivers/mysql.lisp
• mito-core/core-components/db-drivers/postgres.lisp
• mito-core/core-components/db-drivers/sqlite3.lisp
• mito-core/core-components/logger.lisp
• mito-core/core-components/error.lisp
• mito-core/core-components/util.lisp
• mito-migration/src/migration.lisp
• mito-migration/migration-components/table.lisp
• mito-migration/migration-components/versions.lisp
• mito-migration/migration-components/sxql.lisp
• mito-migration/migration-components/sql-parse.lisp
• mito-migration/migration-components/util.lisp
• lack-middleware-mito/src/middleware.lisp

5.1 mito.middleware

Source

middleware.lisp.

Nickname

lack.middleware.mito

Use List

common-lisp.

Public Interface

*lack-middleware-mito* (special variable).

5.2 mito.class.table

Source

table.lisp.

Use List

• common-lisp.
• mito.util.

Used By List

mito.class.

Public Interface

• database-column-slots (generic function).
• find-child-columns (function).
• find-parent-column (function).
• find-slot-by-name (function).
• table-class (class).
• table-column-slots (function).
• table-direct-column-slots (function).
• table-indices-info (generic function).
• table-name (generic function).
• table-primary-key (generic function).
• table-serial-key (generic function).

Internals

• add-referencing-slots (function).
• expand-relational-keys (function).
• map-all-superclasses (function).
• rel-column-name (function).

5.3 mito.connection

Source

connection.lisp.

Use List

• common-lisp.
• mito.error.

Public Interface

• *connection* (special variable).
• check-connected (function).
• connect-toplevel (function).
• connected-p (function).
• connection-database-name (function).
• connection-quote-character (function).
• disconnect-toplevel (function).
• driver-type (function).
• with-quote-char (macro).

5.4 mito.dao.view

Source

view.lisp.

Use List

common-lisp.

Public Interface

• dao-table-view (class).
• dao-table-view-as-query (generic reader).
• table-definition (generic function).

Internals

• copy-create-view (function).
• create-view (structure).
• create-view-as (reader).
• (setf create-view-as) (writer).
• create-view-name (reader).
• (setf create-view-name) (writer).
• create-view-or-replace (reader).
• (setf create-view-or-replace) (writer).
• create-view-p (function).
• create-view-view-name (reader).
• (setf create-view-view-name) (writer).
• make-create-view (function).

5.5 mito.error

Source

error.lisp.

Use List

common-lisp.

Used By List

• mito.class.column.
• mito.connection.
• mito.dao.table.

Public Interface

• col-type-required (condition).
• connection-not-established (condition).
• invalid-definition (condition).
• mito-error (condition).
• no-primary-keys (condition).

5.6 mito.db

Source

db.lisp.

Use List

common-lisp.

Public Interface

• *use-prepare-cached* (special variable).
• acquire-advisory-lock (function).
• column-definitions (function).
• execute-sql (generic function).
• last-insert-id (function).
• release-advisory-lock (function).
• retrieve-by-sql (generic function).
• table-exists-p (function).
• table-indices (function).
• table-view-query (function).

Internals

• array-convert-nulls-to-nils (function).
• list-convert-nulls-to-nils (function).

5.7 mito.migration.table

Source

table.lisp.

Use List

• common-lisp.
• sxql.

Public Interface

• *auto-migration-mode* (special variable).
• *migration-keep-temp-tables* (special variable).
• migrate-table (generic function).
• migration-expressions (function).

Internals

• migration-expressions-for-others (function).
• migration-expressions-for-sqlite3 (function).
• slot-defaults (function).

5.8 mito.class.column

Source

column.lisp.

Use List

• common-lisp.
• mito.error.
• mito.util.

Used By List

mito.class.

Public Interface

• ghost-slot-p (generic reader).
• (setf ghost-slot-p) (generic writer).
• primary-key-p (generic reader).
• (setf primary-key-p) (generic writer).
• table-column-class (class).
• table-column-info (generic function).
• table-column-info-for-create-table (generic function).
• table-column-name (generic function).
• table-column-not-null-p (generic function).
• table-column-references (generic reader).
• table-column-references-column (generic function).
• table-column-type (generic function).

Internals

• %table-column-type (generic reader).
• (setf %table-column-type) (generic writer).
• parse-col-type (function).
• references (type).

5.9 mito.db.postgres

Source

postgres.lisp.

Use List

• common-lisp.
• mito.util.
• sxql.

Public Interface

• acquire-advisory-lock (function).
• column-definitions (function).
• last-insert-id (function).
• release-advisory-lock (function).
• table-indices (function).
• table-view-query (function).

Internals

get-serial-keys (function).

5.10 mito.core

Source

src/core.lisp.

Use List

common-lisp.

5.11 mito.class

Source

class.lisp.

Use List

• common-lisp.
• mito.class.column.
• mito.class.table.

Used By List

mito.dao.

Public Interface

create-table-sxql (generic function).

5.12 mito-migration-asd

Source

mito-migration.asd.

Use List

• asdf/interface.
• common-lisp.

5.13 mito.dao.column

Source

column.lisp.

Use List

• common-lisp.
• mito.util.

Public Interface

• dao-table-column-class (class).
• dao-table-column-deflate (generic function).
• dao-table-column-inflate (generic function).
• deflate-for-col-type (generic function).
• inflate-for-col-type (generic function).

Internals

• *conc-name* (special variable).
• *db-date-format* (special variable).
• *db-datetime-format* (special variable).
• *db-datetime-format-with-out-timezone* (special variable).

5.14 mito.dao

Source

dao.lisp.

Use List

• common-lisp.
• mito.class.
• sxql.

Public Interface

• convert-for-driver-type (generic function).
• count-dao (function).
• create-dao (generic function).
• deftable (macro).
• delete-by-values (generic function).
• delete-dao (generic function).
• ensure-table-exists (function).
• find-dao (function).
• include-foreign-objects (function).
• insert-dao (generic function).
• recreate-table (function).
• retrieve-dao (function).
• save-dao (generic function).
• select-by-sql (function).
• select-dao (macro).
• update-dao (generic function).

Internals

• *db-date-format* (special variable).
• *db-datetime-format* (special variable).
• *db-datetime-format-without-timezone* (special variable).
• child-columns (function).
• expand-op (function).
• foreign-value (function).
• make-set-clause (function).
• slot-foreign-value (function).
• where-and (function).

5.15 mito.type

Source

type.lisp.

Use List

common-lisp.

Public Interface

• get-column-real-type (function).
• parse-dbtype (function).

Internals

• *real-type-cache* (special variable).
• parse-type-vars (function).

5.16 mito.migration.sql-parse

Source

sql-parse.lisp.

Use List

• common-lisp.
• esrap.

Public Interface

parse-statements (function).

5.17 mito.dao.mixin

Source

mixin.lisp.

Use List

• common-lisp.
• mito.util.

Public Interface

• dao-class (class).
• dao-synced (generic reader).
• (setf dao-synced) (generic writer).
• dao-table-mixin (class).
• make-dao-instance (generic function).
• object-created-at (generic reader).
• (setf object-created-at) (generic writer).
• object-id (generic function).
• (setf object-id) (generic function).
• object-updated-at (generic reader).
• (setf object-updated-at) (generic writer).
• object= (generic function).
• record-timestamps-mixin (class).
• serial-pk-mixin (class).
• uuid-pk-mixin (class).

Internals

• %object-id (generic reader).
• (setf %object-id) (generic writer).
• %object-uuid (generic reader).
• (setf %object-uuid) (generic writer).
• add-relational-readers (function).
• generate-uuid (function).
• make-relational-reader-method (function).

5.18 mito.migration

Source

src/migration.lisp.

Use List

common-lisp.

5.19 mito-asd

Source

mito.asd.

Use List

• asdf/interface.
• common-lisp.

5.20 mito.util

Source

util.lisp.

Use List

common-lisp.

Used By List

• mito.class.column.
• mito.class.table.
• mito.dao.column.
• mito.dao.mixin.
• mito.dao.table.
• mito.db.mysql.
• mito.db.postgres.
• mito.db.sqlite3.

Public Interface

• contains-class-or-subclasses (function).
• ensure-class (function).
• execute-with-retry (function).
• group-by-plist (function).
• lispify (function).
• list-diff (function).
• symbol-name-literally (function).
• unlispify (function).
• with-prepared-query (macro).

Internals

• %list-diff (function).
• call-with-prepared-query (function).
• escaped-symbol-p (function).
• obsolete-prepared-statement-p (function).

5.21 mito.db.mysql

Source

mysql.lisp.

Use List

• common-lisp.
• mito.util.
• sxql.

Public Interface

• acquire-advisory-lock (function).
• column-definitions (function).
• last-insert-id (function).
• release-advisory-lock (function).
• table-indices (function).
• table-view-query (function).

Internals

ensure-string (function).

5.22 mito.migration.util

Source

util.lisp.

Use List

common-lisp.

Public Interface

generate-advisory-lock-id (function).

Internals

• +migrator-salt+ (special variable).
• ascii-string-to-octets (function).
• crc32 (function).

5.23 mito.migration.versions

Source

versions.lisp.

Use List

• common-lisp.
• sxql.

Public Interface

• all-migration-expressions (function).
• current-migration-version (function).
• generate-migrations (function).
• migrate (function).
• migration-status (function).
• update-migration-version (function).

Internals

• %migration-status (function).
• *advisory-lock-drivers* (special variable).
• all-dao-classes (function).
• generate-version (function).
• initialize-migrations-table (function).
• migration-file-version (function).
• migration-files (function).
• schema-migrations-table-definition (function).
• with-advisory-lock (macro).

5.24 mito.logger

Source

logger.lisp.

Use List

common-lisp.

Public Interface

• *mito-logger-stream* (special variable).
• *mito-migration-logger-stream* (special variable).
• *trace-sql-hooks* (special variable).
• mito-sql-logger (function).
• with-sql-logging (macro).
• with-trace-sql (macro).

Internals

• get-prev-stack (function).
• trace-sql (function).

5.25 mito.dao.table

Source

table.lisp.

Use List

• common-lisp.
• mito.error.
• mito.util.

Public Interface

• dao-table-class (class).
• depending-table-classes (function).

Internals

• append-auto-pk-class-to-direct-superclasses-if-needed (function).
• append-record-timestamp-mixin-to-direct-superclasses-if-needed (function).
• initargs-contains-primary-key (function).
• initargs-enables-auto-pk (function).
• initargs-enables-record-timestamps (function).

5.26 mito.db.sqlite3

Source

sqlite3.lisp.

Use List

• common-lisp.
• mito.util.
• sxql.

Public Interface

• column-definitions (function).
• last-insert-id (function).
• table-indices (function).

Internals

• table-info (function).
• table-primary-keys (function).

5.27 mito.migration.sxql

Extansions of SxQL for Mito.Migration

Source

sxql.lisp.

Use List

common-lisp.

Internals

• copy-create-sequence (function).
• copy-drop-sequence (function).
• copy-set-default (function).
• create-sequence (structure).
• create-sequence-name (reader).
• (setf create-sequence-name) (writer).
• create-sequence-p (function).
• create-sequence-sequence-name (reader).
• (setf create-sequence-sequence-name) (writer).
• drop-sequence (structure).
• drop-sequence-if-exists (reader).
• (setf drop-sequence-if-exists) (writer).
• drop-sequence-name (reader).
• (setf drop-sequence-name) (writer).
• drop-sequence-p (function).
• drop-sequence-sequence-name (reader).
• (setf drop-sequence-sequence-name) (writer).
• make-create-sequence (function).
• make-drop-sequence (function).
• make-set-default (function).
• set-default (structure).
• set-default-expression (function).
• (setf set-default-expression) (function).
• set-default-name (reader).
• (setf set-default-name) (writer).
• set-default-p (function).

5.28 mito

Source

src/mito.lisp.

Use List

common-lisp.

6.1 Public Interface

• Special variables
• Macros
• Ordinary functions
• Generic functions
• Standalone methods
• Conditions
• Classes