The mito Reference Manual

4.1.1 mito/mito.asd

Source

mito.asd.

Parent Component

mito (system).

ASDF Systems

mito.

---

4.1.2 mito-core/mito-core.asd

Source

mito-core.asd.

Parent Component

mito-core (system).

ASDF Systems

mito-core.

---

4.1.3 mito-migration/mito-migration.asd

Source

mito-migration.asd.

Parent Component

mito-migration (system).

ASDF Systems

mito-migration.

---

4.1.4 lack-middleware-mito/lack-middleware-mito.asd

Source

lack-middleware-mito.asd.

Parent Component

lack-middleware-mito (system).

ASDF Systems

lack-middleware-mito.

---

4.1.5 mito/src/mito.lisp

Source

mito.asd.

Parent Component

mito (system).

Packages

mito.

---

4.1.6 mito-core/src/core.lisp

Dependency

core-components (module).

Source

mito-core.asd.

Parent Component

mito-core (system).

Packages

mito.core.

---

4.1.7 mito-core/core-components/dao.lisp

Dependency

dao-components (module).

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.dao.

Public Interface

• count-dao (function).
• create-dao (generic function).
• define-simple-accessor (macro).
• deftable (macro).
• delete-by-values (generic function).
• delete-dao (generic function).
• do-select (macro).
• 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

• *want-cursor* (special variable).
• child-columns (function).
• copy-mito-cursor (function).
• expand-op (function).
• fetch-dao-from-cursor (function).
• foreign-value (function).
• make-mito-cursor (function).
• make-set-clause (function).
• mito-cursor (structure).
• mito-cursor-class (reader).
• (setf mito-cursor-class) (writer).
• mito-cursor-cursor (reader).
• (setf mito-cursor-cursor) (writer).
• mito-cursor-fields (reader).
• (setf mito-cursor-fields) (writer).
• mito-cursor-p (function).
• retrieve-foreign-objects (function).
• select-by-sql-as-cursor (function).
• slot-foreign-value (function).
• where-and (function).

---

4.1.8 mito-core/core-components/dao-components/table.lisp

Dependencies

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

Source

mito-core.asd.

Parent Component

dao-components (module).

Packages

mito.dao.table.

Public Interface

• dao-table-class (class).
• depending-table-classes (function).
• direct-slot-definition-class (method).
• ensure-class-using-class (method).
• initialize-instance (method).
• reinitialize-instance (method).
• table-definition (method).

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).

---

4.1.9 mito-core/core-components/dao-components/view.lisp

Dependency

column.lisp (file).

Source

mito-core.asd.

Parent Component

dao-components (module).

Packages

mito.dao.view.

Public Interface

• dao-table-view (class).
• dao-table-view-as-query (reader method).
• direct-slot-definition-class (method).
• table-definition (generic function).
• yield (method).
• yield (method).

Internals

• copy-create-view (function).
• copy-drop-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).
• drop-view (structure).
• drop-view-if-exists (reader).
• (setf drop-view-if-exists) (writer).
• drop-view-name (reader).
• (setf drop-view-name) (writer).
• drop-view-p (function).
• drop-view-view-name (reader).
• (setf drop-view-view-name) (writer).
• make-create-view (function).
• make-drop-view (function).

---

4.1.10 mito-core/core-components/dao-components/mixin.lisp

Dependency

column.lisp (file).

Source

mito-core.asd.

Parent Component

dao-components (module).

Packages

mito.dao.mixin.

Public Interface

• dao-cache (function).
• (setf dao-cache) (function).
• dao-class (class).
• dao-synced (reader method).
• (setf dao-synced) (writer method).
• dao-table-mixin (class).
• define-accessor (macro).
• direct-slot-definition-class (method).
• initialize-instance (method).
• make-dao-instance (generic function).
• object-created-at (reader method).
• (setf object-created-at) (writer method).
• object-id (generic function).
• (setf object-id) (generic function).
• object-updated-at (reader method).
• (setf object-updated-at) (writer method).
• object= (generic function).
• record-timestamps-mixin (class).
• reinitialize-instance (method).
• serial-pk-mixin (class).
• uuid-pk-mixin (class).

Internals

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

---

4.1.11 mito-core/core-components/dao-components/column.lisp

Source

mito-core.asd.

Parent Component

dao-components (module).

Packages

mito.dao.column.

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).
• initialize-instance (method).

Internals

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

---

4.1.12 mito-core/core-components/class.lisp

Dependency

class-components (module).

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.class.

Public Interface

• create-table-sxql (generic function).
• table-column-references-column (method).

---

4.1.13 mito-core/core-components/class-components/table.lisp

Dependency

column.lisp (file).

Source

mito-core.asd.

Parent Component

class-components (module).

Packages

mito.class.table.

Public Interface

• database-column-slots (generic function).
• direct-slot-definition-class (method).
• find-child-columns (function).
• find-parent-column (function).
• find-slot-by-name (function).
• initialize-instance (method).
• reinitialize-instance (method).
• 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).
• validate-superclass (method).

Internals

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

---

4.1.14 mito-core/core-components/class-components/column.lisp

Source

mito-core.asd.

Parent Component

class-components (module).

Packages

mito.class.column.

Public Interface

• ghost-slot-p (reader method).
• (setf ghost-slot-p) (writer method).
• initialize-instance (method).
• primary-key-p (reader method).
• (setf primary-key-p) (writer method).
• 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 (reader method).
• table-column-references-column (generic function).
• table-column-type (generic function).

Internals

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

---

4.1.15 mito-core/core-components/connection.lisp

Dependency

error.lisp (file).

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.connection.

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).

---

4.1.16 mito-core/core-components/type.lisp

Dependency

db.lisp (file).

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.type.

Public Interface

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

Internals

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

---

4.1.17 mito-core/core-components/db.lisp

Dependencies

• db-drivers (module).
• connection.lisp (file).
• class.lisp (file).
• util.lisp (file).

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.db.

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

• *plist-row-lispify* (special variable).
• convert-nulls-to-nils (function).
• ensure-sql (function).
• lispified-fields (function).
• retrieve-from-query (function).
• sxql-to-sql (function).

---

4.1.18 mito-core/core-components/db-drivers/mysql.lisp

Source

mito-core.asd.

Parent Component

db-drivers (module).

Packages

mito.db.mysql.

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).

---

4.1.19 mito-core/core-components/db-drivers/postgres.lisp

Source

mito-core.asd.

Parent Component

db-drivers (module).

Packages

mito.db.postgres.

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).

---

4.1.20 mito-core/core-components/db-drivers/sqlite3.lisp

Source

mito-core.asd.

Parent Component

db-drivers (module).

Packages

mito.db.sqlite3.

Public Interface

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

Internals

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

---

4.1.21 mito-core/core-components/conversion.lisp

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.conversion.

Public Interface

convert-for-driver-type (generic function).

Internals

• *db-date-format* (special variable).
• *db-datetime-format* (special variable).
• *db-datetime-format-without-timezone* (special variable).

---

4.1.22 mito-core/core-components/logger.lisp

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.logger.

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).

---

4.1.23 mito-core/core-components/error.lisp

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.error.

Public Interface

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

---

4.1.24 mito-core/core-components/util.lisp

Source

mito-core.asd.

Parent Component

core-components (module).

Packages

mito.util.

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).

---

4.1.25 mito-migration/src/migration.lisp

Dependency

migration-components (module).

Source

mito-migration.asd.

Parent Component

mito-migration (system).

Packages

mito.migration.

---

4.1.26 mito-migration/migration-components/table.lisp

Dependency

sxql.lisp (file).

Source

mito-migration.asd.

Parent Component

migration-components (module).

Packages

mito.migration.table.

Public Interface

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

Internals

• column-definition-equal-p (function).
• migration-expressions-aux (function).
• migration-expressions-between (function).
• migration-expressions-between-for-sqlite3 (function).
• omit-default (function).
• plist= (function).

---

4.1.27 mito-migration/migration-components/versions.lisp

Dependencies

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

Source

mito-migration.asd.

Parent Component

migration-components (module).

Packages

mito.migration.versions.

Public Interface

• *migration-version-format* (special variable).
• 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-time-version (function).
• generate-version (function).
• initialize-migrations-table (function).
• migration-file-version (function).
• migration-files (function).
• schema-migrations-table-definition (function).
• with-advisory-lock (macro).

---

4.1.28 mito-migration/migration-components/sxql.lisp

Source

mito-migration.asd.

Parent Component

migration-components (module).

Packages

mito.migration.sxql.

Public Interface

• yield (method).
• yield (method).

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).

---

4.1.29 mito-migration/migration-components/sql-parse.lisp

Source

mito-migration.asd.

Parent Component

migration-components (module).

Packages

mito.migration.sql-parse.

Public Interface

parse-statements (function).

---

4.1.30 mito-migration/migration-components/util.lisp

Source

mito-migration.asd.

Parent Component

migration-components (module).

Packages

mito.migration.util.

Public Interface

generate-advisory-lock-id (function).

Internals

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

---

4.1.31 lack-middleware-mito/src/middleware.lisp

Source

lack-middleware-mito.asd.

Parent Component

src (module).

Packages

mito.middleware.

Public Interface

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

---

6.1.1 Special variables

Special Variable: *auto-migration-mode* ¶

Package

mito.migration.table.

Source

table.lisp.

Special Variable: *connection* ¶

Package

mito.connection.

Source

connection.lisp.

Special Variable: *lack-middleware-mito* ¶

Package

mito.middleware.

Source

middleware.lisp.

Special Variable: *migration-keep-temp-tables* ¶

SQLite3 migration creates temporary tables with pre-migration data. If this variable is T they won’t be deleted after migration.

Package

mito.migration.table.

Source

table.lisp.

Special Variable: *migration-version-format* ¶

Package

mito.migration.versions.

Source

versions.lisp.

Special Variable: *mito-logger-stream* ¶

Package

mito.logger.

Source

logger.lisp.

Special Variable: *mito-migration-logger-stream* ¶

Stream to output sql generated during migrations.

Package

mito.logger.

Source

logger.lisp.

Special Variable: *trace-sql-hooks* ¶

Package

mito.logger.

Source

logger.lisp.

Special Variable: *use-prepare-cached* ¶

EXPERIMENTAL FEATURE: If this is T, Mito uses DBI:PREPARE-CACHED
to retrieve/execute SQLs instead of DBI:PREPARE. The default value is NIL. Note that DBI:PREPARE-CACHED is added CL-DBI v0.9.5.

Package

mito.db.

Source

db.lisp.

---

6.1.2 Macros

Macro: define-accessor (name (dao class) &body body) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Macro: define-simple-accessor (name (dao class-name) subclass-name) ¶

Package

mito.dao.

Source

dao.lisp.

Macro: deftable (name direct-superclasses direct-slots &rest options) ¶

Package

mito.dao.

Source

dao.lisp.

Macro: do-select ((dao select &optional index) &body body) ¶

Package

mito.dao.

Source

dao.lisp.

Macro: select-dao (class &body clauses) ¶

Build custom queries with SxQL.

Example:

(select-dao ’tweet
(where (:like :status "%Japan%")))

You can use "includes" to eagerly load another table and prevent the "N+1 query" performance problem.

Example:

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

See the SxQL documentation for the available clauses and operators.

Package

mito.dao.

Source

dao.lisp.

Macro: with-prepared-query (query (conn sql &key use-prepare-cached) &body body) ¶

Package

mito.util.

Source

util.lisp.

Macro: with-quote-char (&body body) ¶

Package

mito.connection.

Source

connection.lisp.

Macro: with-sql-logging (&body body) ¶

Package

mito.logger.

Source

logger.lisp.

Macro: with-trace-sql (&body body) ¶

Package

mito.logger.

Source

logger.lisp.

---

6.1.3 Ordinary functions

Function: acquire-advisory-lock (conn id) ¶

Package

mito.db.mysql.

Source

mysql.lisp.

Function: acquire-advisory-lock (conn id) ¶

Package

mito.db.postgres.

Source

postgres.lisp.

Function: acquire-advisory-lock (conn id) ¶

Package

mito.db.

Source

db.lisp.

Function: all-migration-expressions () ¶

Package

mito.migration.versions.

Source

versions.lisp.

Function: check-connected () ¶

Package

mito.connection.

Source

connection.lisp.

Function: column-definitions (conn table-name) ¶

Package

mito.db.sqlite3.

Source

sqlite3.lisp.

Function: column-definitions (conn table-name) ¶

Package

mito.db.mysql.

Source

mysql.lisp.

Function: column-definitions (conn table-name) ¶

Package

mito.db.postgres.

Source

postgres.lisp.

Function: column-definitions (conn table-name) ¶

Package

mito.db.

Source

db.lisp.

Function: connect-toplevel (driver-name &rest args &key database-name &allow-other-keys) ¶

Package

mito.connection.

Source

connection.lisp.

Function: connected-p () ¶

Package

mito.connection.

Source

connection.lisp.

Function: connection-database-name (&optional conn) ¶

Return the name of the current connection, or the one given as argument.

Package

mito.connection.

Source

connection.lisp.

Function: connection-quote-character (conn) ¶

Package

mito.connection.

Source

connection.lisp.

Function: contains-class-or-subclasses (class target-classes) ¶

Package

mito.util.

Source

util.lisp.

Function: count-dao (class &rest fields-and-values) ¶

Package

mito.dao.

Source

dao.lisp.

Function: current-migration-version () ¶

Package

mito.migration.versions.

Source

versions.lisp.

Function: dao-cache (dao key) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Function: (setf dao-cache) (dao key) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Function: depending-table-classes (class) ¶

Package

mito.dao.table.

Source

table.lisp.

Function: disconnect-toplevel () ¶

Package

mito.connection.

Source

connection.lisp.

Function: driver-type (&optional conn) ¶

Package

mito.connection.

Source

connection.lisp.

Function: ensure-class (class-or-class-name) ¶

Package

mito.util.

Source

util.lisp.

Function: ensure-table-exists (class) ¶

Package

mito.dao.

Source

dao.lisp.

Function: execute-with-retry (query binds) ¶

Same as DBI:EXECUTE except will recreate a prepared statement when getting DBI:DBI-DATABASE-ERROR.

Package

mito.util.

Source

util.lisp.

Function: find-child-columns (table slot) ¶

Package

mito.class.table.

Source

table.lisp.

Function: find-dao (class &rest fields-and-values) ¶

Package

mito.dao.

Source

dao.lisp.

Function: find-parent-column (table slot) ¶

Package

mito.class.table.

Source

table.lisp.

Function: find-slot-by-name (class slot-name &key test) ¶

Package

mito.class.table.

Source

table.lisp.

Function: generate-advisory-lock-id (database-name) ¶

Package

mito.migration.util.

Source

util.lisp.

Function: generate-migrations (directory &key force) ¶

Package

mito.migration.versions.

Source

versions.lisp.

Function: get-column-real-type (conn name) ¶

Package

mito.type.

Source

type.lisp.

Function: group-by-plist (plists &key key test) ¶

Package

mito.util.

Source

util.lisp.

Function: include-foreign-objects (foreign-class records) ¶

Package

mito.dao.

Source

dao.lisp.

Function: last-insert-id (conn table-name) ¶

Package

mito.db.sqlite3.

Source

sqlite3.lisp.

Function: last-insert-id (conn table-name serial-key-name) ¶

Package

mito.db.mysql.

Source

mysql.lisp.

Function: last-insert-id (conn table-name serial-key-name) ¶

Package

mito.db.postgres.

Source

postgres.lisp.

Function: last-insert-id (conn table-name serial-key-name) ¶

Package

mito.db.

Source

db.lisp.

Function: lispify (object) ¶

Package

mito.util.

Source

util.lisp.

Function: list-diff (a b &key sort-key sort-key-a sort-key-b sort-fn key test) ¶

Compute differences two lists.
Note this can be applied for a list of string-designators.

Package

mito.util.

Source

util.lisp.

Function: migrate (directory &key dry-run force) ¶

Package

mito.migration.versions.

Source

versions.lisp.

Function: migration-expressions (class &optional driver-type) ¶

Package

mito.migration.table.

Source

table.lisp.

Function: migration-status (directory) ¶

Package

mito.migration.versions.

Source

versions.lisp.

Function: mito-sql-logger (sql params row-count took-usec prev-stack) ¶

Package

mito.logger.

Source

logger.lisp.

Function: parse-dbtype (dbtype) ¶

Package

mito.type.

Source

type.lisp.

Function: parse-statements (content) ¶

Package

mito.migration.sql-parse.

Source

sql-parse.lisp.

Function: recreate-table (class) ¶

Package

mito.dao.

Source

dao.lisp.

Function: release-advisory-lock (conn id) ¶

Package

mito.db.mysql.

Source

mysql.lisp.

Function: release-advisory-lock (conn id) ¶

Package

mito.db.postgres.

Source

postgres.lisp.

Function: release-advisory-lock (conn id) ¶

Package

mito.db.

Source

db.lisp.

Function: retrieve-dao (class &rest fields-and-values) ¶

Package

mito.dao.

Source

dao.lisp.

Function: select-by-sql (class sql &key binds) ¶

Package

mito.dao.

Source

dao.lisp.

Function: symbol-name-literally (symbol) ¶

Package

mito.util.

Source

util.lisp.

Function: table-column-slots (class) ¶

Package

mito.class.table.

Source

table.lisp.

Function: table-direct-column-slots (class) ¶

Package

mito.class.table.

Source

table.lisp.

Function: table-exists-p (conn table-name) ¶

Package

mito.db.

Source

db.lisp.

Function: table-indices (conn table-name) ¶

Package

mito.db.sqlite3.

Source

sqlite3.lisp.

Function: table-indices (conn table-name) ¶

Package

mito.db.mysql.

Source

mysql.lisp.

Function: table-indices (conn table-name) ¶

Package

mito.db.postgres.

Source

postgres.lisp.

Function: table-indices (conn table-name) ¶

Package

mito.db.

Source

db.lisp.

Function: table-view-query (conn table-name) ¶

Package

mito.db.mysql.

Source

mysql.lisp.

Function: table-view-query (conn table-name) ¶

Package

mito.db.postgres.

Source

postgres.lisp.

Function: table-view-query (conn table-name) ¶

Package

mito.db.

Source

db.lisp.

Function: unlispify (object) ¶

Package

mito.util.

Source

util.lisp.

Function: update-migration-version (version) ¶

Package

mito.migration.versions.

Source

versions.lisp.

---

6.1.4 Generic functions

Generic Function: convert-for-driver-type (driver-type col-type value) ¶

Package

mito.conversion.

Source

conversion.lisp.

Methods

Method: convert-for-driver-type (driver-type col-type value) ¶

Method: convert-for-driver-type (driver-type col-type (value string)) ¶

Method: convert-for-driver-type ((driver-type (eql :mysql)) (col-type (eql :boolean)) value) ¶

Method: convert-for-driver-type ((driver-type (eql :mysql)) (col-type (eql :datetime)) (value timestamp)) ¶

Method: convert-for-driver-type (driver-type (col-type (eql :datetime)) (value timestamp)) ¶

Method: convert-for-driver-type (driver-type (col-type (eql :date)) (value timestamp)) ¶

Method: convert-for-driver-type (driver-type (col-type (eql :timestamp)) value) ¶

Method: convert-for-driver-type (driver-type (col-type (eql :timestamptz)) value) ¶

Method: convert-for-driver-type ((driver-type (eql :sqlite3)) (col-type (eql :boolean)) value) ¶

Method: convert-for-driver-type ((driver-type (eql :postgres)) (col-type (eql :boolean)) value) ¶

Generic Function: create-dao (class &rest initargs) ¶

Create an object of class CLASS with INITARGS and save it into the DB.

Example:

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

same as:

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

(mito:insert-dao me)

Package

mito.dao.

Source

dao.lisp.

Methods

Method: create-dao ((class-name symbol) &rest initargs) ¶

Method: create-dao ((class dao-table-class) &rest initargs) ¶

Generic Function: create-table-sxql (class driver-type &key if-not-exists) ¶

Package

mito.class.

Source

class.lisp.

Methods

Method: create-table-sxql (class driver-type &key if-not-exists) ¶

Generic Reader: dao-synced (object) ¶

Package

mito.dao.mixin.

Methods

Reader Method: dao-synced ((dao-class dao-class)) ¶

automatically generated reader method

Source

mixin.lisp.

Target Slot

synced.

Generic Writer: (setf dao-synced) (object) ¶

Package

mito.dao.mixin.

Methods

Writer Method: (setf dao-synced) ((dao-class dao-class)) ¶

automatically generated writer method

Source

mixin.lisp.

Target Slot

synced.

Generic Function: dao-table-column-deflate (column value) ¶

Package

mito.dao.column.

Source

column.lisp.

Methods

Method: dao-table-column-deflate ((column dao-table-column-class) value) ¶

Generic Function: dao-table-column-inflate (column value) ¶

Package

mito.dao.column.

Source

column.lisp.

Methods

Method: dao-table-column-inflate ((column dao-table-column-class) value) ¶

Generic Reader: dao-table-view-as-query (object) ¶

Package

mito.dao.view.

Methods

Reader Method: dao-table-view-as-query ((dao-table-view dao-table-view)) ¶

automatically generated reader method

Source

view.lisp.

Target Slot

as.

Generic Function: database-column-slots (class) ¶

Package

mito.class.table.

Source

table.lisp.

Methods

Method: database-column-slots ((class table-class)) ¶

Generic Function: deflate-for-col-type (col-type value) ¶

Package

mito.dao.column.

Source

column.lisp.

Methods

Method: deflate-for-col-type (col-type value) ¶

Method: deflate-for-col-type ((col-type cons) value) ¶

Method: deflate-for-col-type ((col-type (eql :datetime)) value) ¶

Method: deflate-for-col-type ((col-type (eql :date)) value) ¶

Method: deflate-for-col-type ((col-type (eql :timestamp)) value) ¶

Method: deflate-for-col-type ((col-type (eql :timestamptz)) value) ¶

Generic Function: delete-by-values (class &rest fields-and-values) ¶

Delete the records of class CLASS matching FIELDS-AND-VALUES from the DB. For example: (mito:delete-by-values ’user :id 1)

Package

mito.dao.

Source

dao.lisp.

Methods

Method: delete-by-values ((class symbol) &rest fields-and-values) ¶

Method: delete-by-values ((class dao-table-class) &rest fields-and-values) ¶

Generic Function: delete-dao (obj) ¶

Delete the object OBJ from the DB.

Package

mito.dao.

Source

dao.lisp.

Methods

Method: delete-dao ((obj dao-class)) ¶

Generic Function: execute-sql (sql &optional binds) ¶

Package

mito.db.

Source

db.lisp.

Methods

Method: execute-sql ((sql string) &optional binds) ¶

Method: execute-sql ((sql sql-statement) &optional binds) ¶

Generic Reader: ghost-slot-p (object) ¶

Generic Writer: (setf ghost-slot-p) (object) ¶

Package

mito.class.column.

Methods

Reader Method: ghost-slot-p ((table-column-class table-column-class)) ¶

Writer Method: (setf ghost-slot-p) ((table-column-class table-column-class)) ¶

Option to specify slots as ghost slots. Ghost slots do not depend on a database.

Source

column.lisp.

Target Slot

ghost.

Generic Function: inflate-for-col-type (col-type value) ¶

Package

mito.dao.column.

Source

column.lisp.

Methods

Method: inflate-for-col-type (col-type value) ¶

Method: inflate-for-col-type ((col-type cons) value) ¶

Method: inflate-for-col-type ((col-type (eql :datetime)) value) ¶

Method: inflate-for-col-type ((col-type (eql :date)) value) ¶

Method: inflate-for-col-type ((col-type (eql :timestamp)) value) ¶

Method: inflate-for-col-type ((col-type (eql :timestamptz)) value) ¶

Method: inflate-for-col-type ((col-type (eql :time)) value) ¶

Method: inflate-for-col-type ((col-type (eql :boolean)) value) ¶

Generic Function: insert-dao (obj) ¶

Insert the object OBJ into the DB.

Package

mito.dao.

Source

dao.lisp.

Methods

Method: insert-dao ((obj dao-class)) ¶

Method: insert-dao :before ((obj record-timestamps-mixin)) ¶

Generic Function: make-dao-instance (class &rest initargs) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Methods

Method: make-dao-instance ((class-name symbol) &rest initargs) ¶

Method: make-dao-instance ((class table-class) &rest initargs) ¶

Generic Function: migrate-table (class) ¶

Package

mito.migration.table.

Source

table.lisp.

Methods

Method: migrate-table ((class symbol)) ¶

Method: migrate-table ((class dao-table-class)) ¶

Generic Reader: object-created-at (object) ¶

Package

mito.dao.mixin.

Methods

Reader Method: object-created-at ((record-timestamps-mixin record-timestamps-mixin)) ¶

automatically generated reader method

Source

mixin.lisp.

Target Slot

created-at.

Generic Writer: (setf object-created-at) (object) ¶

Package

mito.dao.mixin.

Methods

Writer Method: (setf object-created-at) ((record-timestamps-mixin record-timestamps-mixin)) ¶

automatically generated writer method

Source

mixin.lisp.

Target Slot

created-at.

Generic Function: object-id (object) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Methods

Method: object-id ((object serial-pk-mixin)) ¶

Method: object-id ((object uuid-pk-mixin)) ¶

Generic Function: (setf object-id) (object) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Methods

Method: (setf object-id) ((object serial-pk-mixin)) ¶

Method: (setf object-id) ((object uuid-pk-mixin)) ¶

Generic Reader: object-updated-at (object) ¶

Package

mito.dao.mixin.

Methods

Reader Method: object-updated-at ((record-timestamps-mixin record-timestamps-mixin)) ¶

automatically generated reader method

Source

mixin.lisp.

Target Slot

updated-at.

Generic Writer: (setf object-updated-at) (object) ¶

Package

mito.dao.mixin.

Methods

Writer Method: (setf object-updated-at) ((record-timestamps-mixin record-timestamps-mixin)) ¶

automatically generated writer method

Source

mixin.lisp.

Target Slot

updated-at.

Generic Function: object= (object1 object2) ¶

Package

mito.dao.mixin.

Source

mixin.lisp.

Methods

Method: object= (object1 object2) ¶

Generic Reader: primary-key-p (object) ¶

Package

mito.class.column.

Methods

Reader Method: primary-key-p ((table-column-class table-column-class)) ¶

automatically generated reader method

Source

column.lisp.

Target Slot

primary-key.

Generic Writer: (setf primary-key-p) (object) ¶

Package

mito.class.column.

Methods

Writer Method: (setf primary-key-p) ((table-column-class table-column-class)) ¶

automatically generated writer method

Source

column.lisp.

Target Slot

primary-key.

Generic Function: retrieve-by-sql (sql &key binds format lispify &allow-other-keys) ¶

Package

mito.db.

Source

db.lisp.

Methods

Method: retrieve-by-sql ((sql string) &key binds format lispify) ¶

Method: retrieve-by-sql (sql &rest args &key binds &allow-other-keys) ¶

Generic Function: save-dao (obj) ¶

Save the object OBJ into the DB.

Package

mito.dao.

Source

dao.lisp.

Methods

Method: save-dao ((obj dao-class)) ¶

Generic Function: table-column-info (column driver-type) ¶

Package

mito.class.column.

Source

column.lisp.

Methods

Method: table-column-info (column (driver-type (eql :sqlite3))) ¶

Method: table-column-info (column (driver-type (eql :mysql))) ¶

Method: table-column-info (column (driver-type (eql :postgres))) ¶

Method: table-column-info :around (column driver-type) ¶

Generic Function: table-column-info-for-create-table (column driver-type) ¶

Similar to table-column-info except the return value is for sxql:make-create-table.

Package

mito.class.column.

Source

column.lisp.

Methods

Method: table-column-info-for-create-table (column driver-type) ¶

Method: table-column-info-for-create-table :around (column driver-type) ¶

Method: table-column-info-for-create-table (column (driver-type (eql :mysql))) ¶

Method: table-column-info-for-create-table (column (driver-type (eql :sqlite3))) ¶

Method: table-column-info-for-create-table (column (driver-type (eql :postgres))) ¶

Generic Function: table-column-name (column) ¶

Package

mito.class.column.

Source

column.lisp.

Methods

Method: table-column-name ((column table-column-class)) ¶

Generic Function: table-column-not-null-p (column) ¶

Package

mito.class.column.

Source

column.lisp.

Methods

Method: table-column-not-null-p ((column table-column-class)) ¶

Generic Reader: table-column-references (object) ¶

Package

mito.class.column.

Methods

Reader Method: table-column-references ((table-column-class table-column-class)) ¶

automatically generated reader method

Source

column.lisp.

Target Slot

references.

Generic Function: table-column-references-column (column) ¶

Package

mito.class.column.

Source

column.lisp.

Methods

Method: table-column-references-column ((column table-column-class)) ¶

Source

class.lisp.

Generic Function: table-column-type (column) ¶

Package

mito.class.column.

Source

column.lisp.

Methods

Method: table-column-type ((column table-column-class)) ¶

Generic Function: table-definition (class &key if-not-exists or-replace &allow-other-keys) ¶

Package

mito.dao.view.

Source

view.lisp.

Methods

Method: table-definition ((class dao-table-class) &key if-not-exists &allow-other-keys) ¶

Source

table.lisp.

Method: table-definition ((class symbol) &rest args &key if-not-exists or-replace) ¶

Method: table-definition ((class dao-table-view) &key or-replace &allow-other-keys) ¶

Generic Function: table-indices-info (class driver-type) ¶

Package

mito.class.table.

Source

table.lisp.

Methods

Method: table-indices-info (class driver-type) ¶

Generic Function: table-name (class) ¶

Package

mito.class.table.

Source

table.lisp.

Methods

Method: table-name ((class table-class)) ¶

Generic Function: table-primary-key (class) ¶

Package

mito.class.table.

Source

table.lisp.

Methods

Method: table-primary-key ((class table-class)) ¶

Generic Function: table-serial-key (class) ¶

Package

mito.class.table.

Source

table.lisp.

Methods

Method: table-serial-key ((class table-class)) ¶

Generic Function: update-dao (obj &key columns) ¶

Update the object OBJ into the DB.

Package

mito.dao.

Source

dao.lisp.

Methods

Method: update-dao ((obj dao-class) &key columns) ¶

Method: update-dao :before ((obj record-timestamps-mixin) &key columns) ¶

---