The cl-migrations Reference Manual

Table of Contents

The cl-migrations Reference Manual

This is the cl-migrations Reference Manual, version 0.0.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:02:39 2021 GMT+0.

1 Systems

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

1.1 cl-migrations

Version

0.0.3

Dependency

clsql

Source

cl-migrations.asd (file)

Components

• packages.lisp (file)
• config.lisp (file)
• migrate.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 cl-migrations.asd

Location

cl-migrations.asd

Systems

cl-migrations (system)

Packages

cl-migrations-asd

Exported Definitions

*cl-migrations-version* (special variable)

2.1.2 cl-migrations/packages.lisp

Parent

cl-migrations (system)

Location

packages.lisp

Packages

cl-migrations

2.1.3 cl-migrations/config.lisp

Dependency

packages.lisp (file)

Parent

cl-migrations (system)

Location

config.lisp

Exported Definitions

• *config-pathname* (special variable)
• connect-db (function)
• disconnect-db (function)

Internal Definitions

• *migration-dir* (special variable)
• *schema-table-name* (special variable)
• +all-db-types+ (special variable)
• aodbc-spec (method)
• (setf aodbc-spec) (method)
• conn-specs (class)
• create-schema-table (function)
• db-type-spec (function)
• init-config (function)
• init-connection (function)
• load-necessary-systems (function)
• mysql-spec (method)
• (setf mysql-spec) (method)
• odbc-spec (method)
• (setf odbc-spec) (method)
• oracle-spec (method)
• (setf oracle-spec) (method)
• postgresql-socket-spec (method)
• (setf postgresql-socket-spec) (method)
• postgresql-spec (method)
• (setf postgresql-spec) (method)
• read-specs (function)
• spec-fn (function)
• sqlite-spec (method)
• (setf sqlite-spec) (method)
• sqlite3-spec (method)
• (setf sqlite3-spec) (method)

2.1.4 cl-migrations/migrate.lisp

Dependency

config.lisp (file)

Parent

cl-migrations (system)

Location

migrate.lisp

Exported Definitions

• generate (function)
• migrate (function)

Internal Definitions

• compare-files (function)
• decf-db-version (function)
• exec-migrations (function)
• get-db-version (function)
• get-file-range (function)
• get-latest-migration (function)
• get-migration-files (function)
• get-migration-number (function)
• incf-db-version (function)
• select-migration-files (function)

3 Packages

Packages are listed by definition order.

3.1 cl-migrations-asd

Source

cl-migrations.asd

Use List

• asdf/interface
• common-lisp

Exported Definitions

*cl-migrations-version* (special variable)

3.2 cl-migrations

Database Migrations for Common Lisp

Source

packages.lisp (file)

Use List

• clsql
• common-lisp

Exported Definitions

• *config-pathname* (special variable)
• connect-db (function)
• disconnect-db (function)
• generate (function)
• migrate (function)

Internal Definitions

• *migration-dir* (special variable)
• *schema-table-name* (special variable)
• +all-db-types+ (special variable)
• aodbc-spec (generic function)
• aodbc-spec (method)
• (setf aodbc-spec) (method)
• (setf aodbc-spec) (generic function)
• compare-files (function)
• conn-specs (class)
• create-schema-table (function)
• db-type-spec (function)
• decf-db-version (function)
• exec-migrations (function)
• get-db-version (function)
• get-file-range (function)
• get-latest-migration (function)
• get-migration-files (function)
• get-migration-number (function)
• incf-db-version (function)
• init-config (function)
• init-connection (function)
• load-necessary-systems (function)
• mysql-spec (generic function)
• mysql-spec (method)
• (setf mysql-spec) (method)
• (setf mysql-spec) (generic function)
• odbc-spec (generic function)
• odbc-spec (method)
• (setf odbc-spec) (method)
• (setf odbc-spec) (generic function)
• oracle-spec (generic function)
• oracle-spec (method)
• (setf oracle-spec) (method)
• (setf oracle-spec) (generic function)
• postgresql-socket-spec (generic function)
• postgresql-socket-spec (method)
• (setf postgresql-socket-spec) (method)
• (setf postgresql-socket-spec) (generic function)
• postgresql-spec (generic function)
• postgresql-spec (method)
• (setf postgresql-spec) (method)
• (setf postgresql-spec) (generic function)
• read-specs (function)
• select-migration-files (function)
• spec-fn (function)
• sqlite-spec (generic function)
• sqlite-spec (method)
• (setf sqlite-spec) (method)
• (setf sqlite-spec) (generic function)
• sqlite3-spec (generic function)
• sqlite3-spec (method)
• (setf sqlite3-spec) (method)
• (setf sqlite3-spec) (generic function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *cl-migrations-version*

Package

cl-migrations-asd

Source

cl-migrations.asd

Special Variable: *config-pathname*

Package

cl-migrations

Source

config.lisp (file)

4.1.2 Functions

Function: connect-db ()

Package

cl-migrations

Source

config.lisp (file)

Function: disconnect-db ()

Package

cl-migrations

Source

config.lisp (file)

Function: generate NAME

Generate an empty migration file with an assigned version number.

Package

cl-migrations

Source

migrate.lisp (file)

Function: migrate &key VERSION

Initiate migration procedure.

Package

cl-migrations

Source

migrate.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *migration-dir*

Package

cl-migrations

Source

config.lisp (file)

Special Variable: *schema-table-name*

Package

cl-migrations

Source

config.lisp (file)

Special Variable: +all-db-types+

Package

cl-migrations

Source

config.lisp (file)

4.2.2 Functions

Function: compare-files FILE1 FILE2

Package

cl-migrations

Source

migrate.lisp (file)

Function: create-schema-table ()

Check for schema table and create if it does not exist.

Package

cl-migrations

Source

config.lisp (file)

Function: db-type-spec DB-TYPE SPEC

Package

cl-migrations

Source

config.lisp (file)

Function: decf-db-version ()

Package

cl-migrations

Source

migrate.lisp (file)

Function: exec-migrations DB-VERSION MIG-VERSION

Excute all the migrations within the given range in a transaction.

Package

cl-migrations

Source

migrate.lisp (file)

Function: get-db-version ()

Package

cl-migrations

Source

migrate.lisp (file)

Function: get-file-range FROM TO

Get the migration files within the given range, in ascending order.

Package

cl-migrations

Source

migrate.lisp (file)

Function: get-latest-migration ()

Get the version of latest migration available.

Package

cl-migrations

Source

migrate.lisp (file)

Function: get-migration-files ()

Get all files from the migrations directory, and sort them numerically.

Package

cl-migrations

Source

migrate.lisp (file)

Function: get-migration-number FILE

Package

cl-migrations

Source

migrate.lisp (file)

Function: incf-db-version ()

Package

cl-migrations

Source

migrate.lisp (file)

Function: init-config &optional CLEAN

Load database configuration and create a connection if none exists.

Package

cl-migrations

Source

config.lisp (file)

Function: init-connection DB-TYPE SPEC &optional CLEAN

Connect to the database; Truncate database if clean flag is set.

Package

cl-migrations

Source

config.lisp (file)

Function: load-necessary-systems SPEC &optional CLEAN

Load the matching database type

Package

cl-migrations

Source

config.lisp (file)

Function: read-specs &optional PATH

Read database and migrations directory specs and set respective variables.

Package

cl-migrations

Source

config.lisp (file)

Function: select-migration-files DB-VERSION MIG-VERSION

Return migration files in ascending or descending order based on whether migrating up or down respectively.

Package

cl-migrations

Source

migrate.lisp (file)

Function: spec-fn DB-TYPE

Package

cl-migrations

Source

config.lisp (file)

4.2.3 Generic functions

Generic Function: aodbc-spec OBJECT

Generic Function: (setf aodbc-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: aodbc-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf aodbc-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: mysql-spec OBJECT

Generic Function: (setf mysql-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: mysql-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf mysql-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: odbc-spec OBJECT

Generic Function: (setf odbc-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: odbc-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf odbc-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: oracle-spec OBJECT

Generic Function: (setf oracle-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: oracle-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf oracle-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: postgresql-socket-spec OBJECT

Generic Function: (setf postgresql-socket-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: postgresql-socket-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf postgresql-socket-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: postgresql-spec OBJECT

Generic Function: (setf postgresql-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: postgresql-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf postgresql-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: sqlite-spec OBJECT

Generic Function: (setf sqlite-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: sqlite-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf sqlite-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

Generic Function: sqlite3-spec OBJECT

Generic Function: (setf sqlite3-spec) NEW-VALUE OBJECT

Package

cl-migrations

Methods

Method: sqlite3-spec (CONN-SPECS conn-specs)

automatically generated reader method

Source

config.lisp (file)

Method: (setf sqlite3-spec) NEW-VALUE (CONN-SPECS conn-specs)

automatically generated writer method

Source

config.lisp (file)

4.2.4 Classes

Class: conn-specs ()

Connection specs for CLSQL for different databases

Package

cl-migrations

Source

config.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• oracle-spec (method)
• oracle-spec (method)
• odbc-spec (method)
• odbc-spec (method)
• sqlite3-spec (method)
• sqlite3-spec (method)
• sqlite-spec (method)
• sqlite-spec (method)
• postgresql-socket-spec (method)
• postgresql-socket-spec (method)
• postgresql-spec (method)
• postgresql-spec (method)
• mysql-spec (method)
• mysql-spec (method)
• aodbc-spec (method)
• aodbc-spec (method)

Direct slots

Slot: aodbc

Readers

aodbc-spec (generic function)

Writers

(setf aodbc-spec) (generic function)

Slot: mysql

Readers

mysql-spec (generic function)

Writers

(setf mysql-spec) (generic function)

Slot: postgresql

Readers

postgresql-spec (generic function)

Writers

(setf postgresql-spec) (generic function)

Slot: postgresql-socket

Readers

postgresql-socket-spec (generic function)

Writers

(setf postgresql-socket-spec) (generic function)

Slot: sqlite

Readers

sqlite-spec (generic function)

Writers

(setf sqlite-spec) (generic function)

Slot: sqlite3

Readers

sqlite3-spec (generic function)

Writers

(setf sqlite3-spec) (generic function)

Slot: odbc

Readers

odbc-spec (generic function)

Writers

(setf odbc-spec) (generic function)

Slot: oracle

Readers

oracle-spec (generic function)

Writers

(setf oracle-spec) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types