The orizuru-orm Reference Manual

Table of Contents

The orizuru-orm Reference Manual

This is the orizuru-orm Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 11:00:50 2019 GMT+0.

1 Introduction

#+OPTIONS: html-postamble:nil html-preamble:nil
#+AUTHOR:
#+TITLE: Orizuru-orm

* Orizuru-Orm

Orizuru-Orm  is an  ORM for  Common Lisp  and postgreSQL,  providing a
simple bridge  between CLOS and  relational databases, and out  of the
box         migrations,         it         is         based         on
[[https://github.com/eudoxia0/crane/][Crane]].

* Usage
** Defining Tables

#+BEGIN_SRC common-lisp
(deftable user ()
  (name :type text :uniquep t)
  (age :type integer :nullp nil :initform 18)
  (friend :type integer :foreign user)))
#+END_SRC

The foreign argument accepts a symbol that represents another table or
a  sexp  of  the  form  ~(table  &key  on-delete  on-update))~,  where
acceptable  values   are  ~:no-action  :restrict   :cascade  :set-null
:set-default~.

*** Column types
|-------------+--------------+----------------------------+-----------------+--------------------+
| orizuru-orm | CL           | SQL                        | inflate/deflate | migration allowed? |
|-------------+--------------+----------------------------+-----------------+--------------------+
| int         | integer      | integer                    | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| bigint      | integer      | bigint                     | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| smallint    | integer      | smallint                   | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| numeric     | ratio        | numeric                    | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| double      | double-float | double precision           | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| text        | string       | text                       | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| varchar     | string       | text                       | yes             | yes                |
|-------------+--------------+----------------------------+-----------------+--------------------+
| timestamp   | string       | timestamp [with time zone] | yes             | yes (see notes)    |
|-------------+--------------+----------------------------+-----------------+--------------------+
| datetime    | string       | TODO                       | TODO            | TODO               |
|-------------+--------------+----------------------------+-----------------+--------------------+

**** Notes
 - for ~timestamp~ columns migration is allowed only from and to ~text~;
 - the timezone for timestamp column is governed by the value of the special variable
   ~orizuru-orm.sql:*timestamp-column-uses-timezone-p*~.

** Migrating

The first rule  is: never use migration in  production before testing!
And, in  any case,  always be sure  to be able  to perform  a rollback
(backup, snapshot, whatever tool you have to recover a database).

#+BEGIN_SRC common-lisp
(deftable user ()
  (name :type integer :uniquep t :nullp nil)
  (age :type integer :nullp t :initform 18)
  (description :type text))
#+END_SRC

Just  make the  changes, and  Orizuru-Orm will  compute the  diffs and
perform all the ~ALTER TABLE~ directives for you.

In the example above the following action will be performed:

- the column ~name~ will change type from ~integer~ to ~text~;
- the column ~age~ will be able to assume a NULL value;
- the column ~friend ~ is *deleted*;
- a column ~description~ is added.

*** About altering column type

This  operation is  allowed but  a  bit tricky.   A limited  automatic
conversion using  common sense  (my common  sense!) is  available (see
[[Column types]]) but,  of course, the conversion i  have chosen could
not be useful or even harmless  for your database, so use this feature
with caution.  For  example a conversion from a column  of type ~text~
with value ~foo~ can not be  converted to ~integer~ and will signal an
error, while a conversion from ~double~ to ~int~ will drop the decimal
part and so on.

And, finally,  be careful that  removing a  slot will remove  a column
(and its values,  and possibly the column of a  referenced table) from
the database.

** Connecting

#+BEGIN_SRC common-lisp
(setup
 :migrations-directory
 (asdf:system-relative-pathname :myapp #p"migrations/")
 :databases
 '(:main
   (:type :postgres
    :name "myapp_db"
    :user "user"
    :pass "user")))

(connect)
#+END_SRC

For configuration management and switching databases in development/production
environments, you might want to use [Envy](https://github.com/fukamachi/envy).

** Creating, Saving, and Deleting Objects

#+BEGIN_SRC common-lisp
(let ((instance (create 'ship :name "Dalliance"
                              :tonnage 77)))
  ;; FIXME: It's back luck to rename a ship
  (setf (name instance) "Serenity")
  ;; Expand the cargo hold
  (incf (tonnage instance) 25)
  ;; Save these changes!
  (save instance)
  ;; Time to retire
  (del instance))
#+END_SRC

** Filtering

#+BEGIN_SRC common-lisp
(filter 'user) ;; Returns everything

(filter 'user :name "John")

(filter 'user (:> :age 21))

;; Returns a single object
(single 'user :name "John")

;; Throws an error if this returns more
;; than one object
(single! 'user (:< age 35))

;; t if a match exists, nil otherwise
(exists 'user :name "John")

;; If this record doesn't exist create it
(get-or-create 'user :name "John" :age 19)
#+END_SRC

*** More complex filtering

*WARNING*: this part is very experimental, the API could change at any
moment probably broken and, moreover, the code is ugly. :)

**** Creating a query set

Assuming a valid database connection and the following tables definition:

#+BEGIN_SRC common-lisp
    (deftable m ()
      (a
       :type integer))
    (deftable x ()
      (dummy
       :type text))
    (deftable y ()
      (to-x
       :type integer
       :foreign (x :restrict :cascade)))
    (deftable z ()
      (to-m
       :type integer
       :foreign (m :restrict :cascade))
      (to-y
       :type integer
       :foreign (y :restrict :cascade)))
#+END_SRC

evaluating this form:

#+BEGIN_SRC common-lisp

  (let ((orizuru-orm.util:*foreign-slots-class-package* :user-package))
    (make-query-set :z->y->x.= 2))

#+END_SRC

create an object that hold a  query like that (some escaping character
removed for readability):

#+BEGIN_SRC sql
  SELECT z.* FROM z
  INNER JOIN y ON (z.to-y = y.id)
  INNER JOIN x ON (y.to-x = x.id)
  WHERE (x.id = 2)
#+END_SRC

as you can  see the sequence ~a->b~ means a  slot/column (foreign key)
from  class/table   ~a~  that   reference  the  ~id~   slot/column  of
class/table ~b~, the  library will figure out the actual  name of said
slot.

It is  possible to filter around  a different slot and  with different
test like that:

#+BEGIN_SRC common-lisp

  (let ((orizuru-orm.util:*foreign-slots-class-package* :user-package))
    (make-query-set :z->y->x_dummy.ilike "%foo"))

#+END_SRC

**** Filtering query set

query can be  "chained" with ~filter-set~, this macro  will not modify
the original object it is applied to:

#+BEGIN_SRC text
  filter-set (&optional qset params logical-op)
#+END_SRC

- qset :: is the query-set object you want to modify (actually a modified copy is returned);
- params :: is a ~list~ of parameters (see examples below);
- logical-op :: a logical operation as keyword '(:or :and :not); default is :and.

Here is some more examples (the following will show the code generated
as sxql):

#+BEGIN_SRC common-lisp
  (let ((q (make-query-set :z.= 2)))
    (->sxql q)))

  ;; =>

  (SELECT (:Z.*)
    (FROM :Z)
    (WHERE (:AND (:= :Z.ID 2))))

  (let ((q (make-query-set :x.= 2)))
    (setf q (filter-set q (:y_id.> 1) :or))
    (setf q (filter-set q (:y_id.<= 5) :and))
    (->sxql q))

  ;; =>

  (SELECT (X.*)
    (FROM X)
    (WHERE (AND (<= Y.ID 5)
                (OR (> Y.ID 1)
                    (AND (= X.ID 2))))))


  (let ((q (make-query-set :z->y->x.= 2)))
    (setf q (filter-set q (:z->m_a.> 9)))
    (->sxql q))

  ;; =>

  (SELECT (Z.*)
    (FROM Z)
    (INNER-JOIN M ON (= Z.TO-M M.ID))
    (INNER-JOIN Y ON (= Z.TO-Y Y.ID))
    (INNER-JOIN X ON (= Y.TO-X X.ID))
    (WHERE (AND (> M.A 9)
                (AND (= X.ID 2)))))

  ;; of course this does not makes sense, it is just to show the API ^^;

  (let ((q (make-query-set :z->y->x.= 2)))
    (setf q (filter-set q (:y_id.> 1)  :not))
    (setf q (filter-set q (:y_id.<= 2) :and))
    (setf q (filter-set q (:z_id.> 0)))
    (setf q (filter-set q (:z->m_a.> 9)))
    (->sxql q))

  ;; =>

  (SELECT (:Z.*)
    (FROM :Z)
    (INNER-JOIN :M :ON (:= :Z.TO-M :M.ID))
    (INNER-JOIN :Y :ON (:= :Z.TO-Y :Y.ID))
    (INNER-JOIN :X :ON (:= :Y.TO-X :X.ID))
    (WHERE (:AND (:> :M.A 9)
                 (:AND (:> :Z.ID 0)
                       (:<= :Y.ID 2)
                       (:AND (:NOT (:> :Y.ID 1))
                             (:AND (:= :X.ID 2)))))))

#+END_SRC

**** Get results from query-set

to  get  the  results  from   query  use  the  method  ~all-from-set~,
specialized on class ~query-set~

#+BEGIN_SRC common-lisp
  all-from-set ((object query-set) &key (as-plist nil))
#+END_SRC

#+BEGIN_SRC common-lisp
  (all-from-set a-query-set :as-plist nil)

  ;; =>

  ;; '(instance-of-class ...) or nil

  (all-from-set a-query-set :as-plist t)

  ;; =>

  ;; '((:slot-1 value :slot-2 value) ... ) or nil
#+END_SRC

**** Changing join column

given this two tables

#+BEGIN_SRC common-lisp
  (deftable foo ()
    (dummy
     :type text))

  (deftable bar ()
    (to-foo
     :type integer
     :foreign (foo :restrict :cascade))
    (to-foo-2
     :type integer
     :foreign (foo :restrict :cascade)))
#+END_SRC

a query set like

#+BEGIN_SRC common-lisp
(let ((q (make-query-set :y->foo.=1))

#+END_SRC

because the join can happen either on column ~to-foo~ or ~to-foo-2~ an
error is  signalled; in  this case  the user  should specify  the join
column using the macro:

#+BEGIN_SRC common-lisp
with-join-column ((column) &body body)
#+END_SRC

example given:

#+BEGIN_SRC common-lisp
  (with-join-column (:to-foo)
    (let ((q (make-query-set :y->foo.=1)))))
#+END_SRC

**** Change mapped table

by  default getting  data  form  a query-set  will  return  a list  of
instances (or  list of plist  see: [[Get results from  query-set]]) of
the first recognized table, for example the values of this form:

#+BEGIN_SRC common-lisp
  (with-join-column (:to-foo)
    (let ((q (make-query-set :y->foo.=1)))
      (all-from-set q)))
#+END_SRC

is a  list of instances  of class ~y~ (or  nil if the  search criteria
does not match  any row of the  table); to get a list  of instances of
~foo~ use the function:

#+BEGIN_SRC text
map-to-model (query-set class-symbol)
#+END_SRC

#+BEGIN_SRC common-lisp
  (with-join-column (:to-foo)
    (let ((q (make-query-set :y->foo.=1)))
      (setf q (map-to-model q :foo))
      (all-from-set q)))

  ;; => '(instance-of-foo-1, instance-of-foo-2 ...)
#+END_SRC

**** Finding slots that are foreign keys

To find the foreign  key of a table user must set  or bind the special
variable   ~orizuru-orm.util:*foreign-slots-class-package*~   to   the
actual   package   where   your    tables   are   defined;   a   macro
~query-set:with-table-package~ makes this task less annoyng:

#+BEGIN_SRC common-lisp
  (with-table-package ((the-package) &body body)
    (with-join-column (:to-foo)
      (let ((q (make-query-set :y->foo.=1)))
        (setf q (map-to-model q :foo))
        (all-from-set q)))
#+END_SRC

**** Notes

Whilst i appreciate that someone would  test this code to improve it i
can not recommend to use it in production (see [[NO WARRANTY]]).

** Beyond ORM

Use [[https://github.com/fukamachi/sxql][sxql]]

** Transactions

#+BEGIN_SRC lisp
;;;; Automatic
(with-transaction ()
  (let ((restaurants (filter 'restaurant ...)))
    (loop for restaurant in restaurants do
          ...
          (save restaurant))))

;;;; Manual
(progn
  (begin-transaction)
  (let ((restaurants (filter 'restaurant ...)))
    (loop for restaurant in restaurants do
          ...
          (save restaurant)))
  (commit))
#+END_SRC

** Fixtures

#+BEGIN_SRC lisp
;;;; initial-data.lisp
(app:user
  (:name "john"
   :groups (:admin :staff))
  (:name "joe"
   :groups (:admin)))
(app:company
  (:name "Initech"
   :city "Denver"))

;;;; myapp.asd
(asdf:defsystem myapp
  :defsystem-depends-on (:clos-fixtures)
  :components ((:module "src"
                :components
                ((:fixture "initial-data")))))
#+END_SRC

** Inflate/Deflate

#+BEGIN_SRC lisp
(definflate (stamp 'timestamp)
  ;; Inflate a timestamp value
  ;; into a timestamp object
  (local-time:universal-to-timestamp stamp))

(defdeflate (stamp local-time:timestamp)
  ;; Deflate a timestamp object
  ;; into a string
  (local-time:format-timestring nil stamp))
#+END_SRC

** Using testing suite

*** Set up Postgres

Assuming there is a working  PostgreSQL server running and configured
use the following:

#+BEGIN_SRC shell
 $ su -
 (root)# su - postgres
 (postgres)$ createdb orizuru_test_db
 (postgres)$ psql -c "CREATE USER orizuru_test_user WITH PASSWORD 'orizuru_test_user'"
 (postgres)$ psql -c "GRANT ALL PRIVILEGES ON DATABASE orizuru_test_db TO orizuru_test_user"
 (postgres)$ ^D
 (root)#     ^D

#+END_SRC

*** Run the test suite

#+BEGIN_SRC lisp
  (ql:quickload :orizuru-orm-test)
  (run-all-tests :use-debugger t)
#+END_SRC

if you  plane to rerun the  test you must delete  the testing database
first (be careful not to delete a valuable database!)

#+BEGIN_SRC shell
 $ su -
 (root)# su - postgres
 (postgres)$ dropdb orizuru_test_db
#+END_SRC

then go to [[Set up Postgres]] and start again.

* BUGS

Bugs or other problems can be reported on the
[[https://notabug.org/cage/orizuru-orm/][issue tracker]].

* Contributing

Help   is    appreciated,   just    point   your   browser    to   the
[[https://notabug.org/cage/orizuru-orm/][repository]]   to   get   the
development          version,          fork          and          then
[[https://notabug.org/cage/orizuru-orm/pulls][send   patches]].  Thank
you in advance!  :)

** Testing

If you add new feature please add  a test to ensure that it works and,
in the future, if a regression occurs, is not missed.

* Acknowledgment

Much of the work for this  library come from "Eudoxia0", the original
author of this code, to whom goes my acknowledgment.

* License

Originally released as  Crane Copyright © 2013  Fernando Borretti under
the MIT license (following).

Permission is hereby granted, free  of charge, to any person obtaining
a  copy  of this  software  and  associated documentation  files  (the
"Software"), to  deal in  the Software without  restriction, including
without limitation  the rights to  use, copy, modify,  merge, publish,
distribute, sublicense,  and/or sell  copies of  the Software,  and to
permit persons to whom the Software  is furnished to do so, subject to
the following conditions:

The  above  copyright  notice  and this  permission  notice  shall  be
included in all copies or substantial portions of the Software.

THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING  FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For this version:

This program  is Copyright ©  2019 Universita' degli Studi  di Palermo
and  released  under GNU  General  Public  license  version 3  of  the
License, or (at your option) any later version.(see COPYING file).

This program  is distributed in the  hope that it will  be useful, but
WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of
MERCHANTABILITY  or FITNESS  FOR  A PARTICULAR  PURPOSE.  See the  GNU
General Public License for more details.

* NO WARRANTY

This library  is distributed in the  hope that it will  be useful, but
WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of
MERCHANTABILITY  or FITNESS  FOR  A PARTICULAR  PURPOSE.  See the  GNU
Lesser General Public License for more details.

2 Systems

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

2.1 orizuru-orm

Maintainer

cage

Author

Fernando Borretti, cage

Home Page

https://notabug.org/cage/orizuru-orm/

Bug Tracker

https://notabug.org/cage/orizuru-orm/issues/

License

GPLv3

Description

An ORM for Common Lisp and PostgreSQL.

Version

0.0.1

Dependencies

• alexandria
• closer-mop
• cl-ppcre-unicode
• anaphora
• sxql
• dbi
• iterate
• cl-fad
• clos-fixtures
• uiop
• clunit2
• local-time

Source

orizuru-orm.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 orizuru-orm/src

Parent

orizuru-orm (system)

Location

src/

Components

• package.lisp (file)
• constants.lisp (file)
• errors.lisp (file)
• config.lisp (file)
• util.lisp (file)
• query-low-level.lisp (file)
• connect.lisp (file)
• types.lisp (file)
• sql.lisp (file)
• meta.lisp (file)
• query.lisp (file)
• migration.lisp (file)
• table.lisp (file)
• inflate-deflate.lisp (file)
• interface.lisp (file)
• fixture.lisp (file)
• transaction.lisp (file)
• query-set.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 orizuru-orm.asd

Location

orizuru-orm.asd

Systems

orizuru-orm (system)

4.1.2 orizuru-orm/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

• orizuru-orm.transaction
• orizuru-orm.errors
• orizuru-orm.connect
• orizuru-orm.sql
• orizuru-orm
• orizuru-orm.query-set
• orizuru-orm.query.lowlevel
• orizuru-orm.query
• orizuru-orm.inflate-deflate
• orizuru-orm.table
• orizuru-orm.types
• orizuru-orm.fixture
• orizuru-orm.constants
• orizuru-orm.migration
• orizuru-orm.util
• orizuru-orm.meta
• orizuru-orm.interface

4.1.3 orizuru-orm/src/constants.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/constants.lisp

Exported Definitions

• +id-column-name+ (constant)
• +postgresql-autoincrement-column-qualifier+ (constant)

4.1.4 orizuru-orm/src/errors.lisp

Dependency

constants.lisp (file)

Parent

src (module)

Location

src/errors.lisp

Exported Definitions

• configuration-error (condition)
• empty-table (condition)
• no-configuration-error (condition)
• query-error (condition)
• query-set-error (condition)
• query-set-foreign-reference-error (condition)

Internal Definitions

• key (method)
• orizuru-orm-error (condition)
• text (method)

4.1.5 orizuru-orm/src/config.lisp

Dependency

errors.lisp (file)

Parent

src (module)

Location

src/config.lisp

Packages

orizuru-orm.config

Exported Definitions

• *after-config-hook* (special variable)
• debugp (function)
• get-config-value (function)
• get-configuration (function)
• setup (function)

Internal Definitions

*config* (special variable)

4.1.6 orizuru-orm/src/util.lisp

Dependency

config.lisp (file)

Parent

src (module)

Location

src/util.lisp

Exported Definitions

• *foreign-slots-class-package* (special variable)
• all-foreign-reference (function)
• all-foreign-slots (function)
• all-slots-name (function)
• clone (generic function)
• clone (method)
• clone (method)
• diff-plist (function)
• find-class-slot (function)
• find-foreign-reference (function)
• find-slot (function)
• find-slot-name (function)
• foreign-reference-between (function)
• foreign-reference-class (function)
• foreign-reference-slot-name (function)
• get-class-slot (function)
• get-slot (function)
• plist-keys (function)
• strcat (function)

Internal Definitions

all-slots (function)

4.1.7 orizuru-orm/src/query-low-level.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/query-low-level.lisp

Exported Definitions

query-low-level (function)

4.1.8 orizuru-orm/src/connect.lisp

Dependency

query-low-level.lisp (file)

Parent

src (module)

Location

src/connect.lisp

Exported Definitions

• *default-db* (special variable)
• <database> (class)
• connect (function)
• database-connection (method)
• (setf database-connection) (method)
• database-name (method)
• database-type (method)
• disconnect (function)
• disconnect-clean (function)
• get-connection (function)
• get-db (function)

Internal Definitions

• *db* (special variable)
• +db-params+ (constant)
• +system-mapping+ (constant)
• database-connection-spec (method)
• enforce-foreign-keys (function)
• initialize-*db* (function)
• load-driver (function)
• make-connection (method)
• set-proper-quote-character (function)
• validate-all-databases (function)
• validate-connection-spec (function)

4.1.9 orizuru-orm/src/types.lisp

Dependency

connect.lisp (file)

Parent

src (module)

Location

src/types.lisp

Exported Definitions

• bigint (type)
• datetime (type)
• double (type)
• int (type)
• numeric (type)
• smallint (type)
• text (type)
• timestamp (type)
• varchar (type)

Internal Definitions

integer (type)

4.1.10 orizuru-orm/src/sql.lisp

Dependency

types.lisp (file)

Parent

src (module)

Location

src/sql.lisp

Exported Definitions

• *timestamp-column-uses-timezone-p* (special variable)
• add-constraint (function)
• alter-constraint (function)
• create-and-sort-constraints (function)
• define-column (function)
• drop-column (function)
• drop-constraint (function)
• make-constraint (function)
• orizuru-orm-type->sql (generic function)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• sqlize (function)

Internal Definitions

• %text->number (function)
• %text->something (function)
• +referential-actions+ (constant)
• alter-column-type (function)
• autoincrement-sql (function)
• constraint-name (function)
• conversion-column-p (function)
• conversion-column-types (function)
• convert-column-type (generic function)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• create-column-constraints (function)
• diff->from-to-params (function)
• foreign (function)
• gen-alias-integer->type (macro)
• gen-alias-type->integer (macro)
• map-ref-action (function)
• set-index (function)
• set-null (function)
• set-primary (function)
• set-unique (function)

4.1.11 orizuru-orm/src/meta.lisp

Dependency

sql.lisp (file)

Parent

src (module)

Location

src/meta.lisp

Exported Definitions

• <table-class> (class)
• abstractp (method)
• col-autoincrement-p (method)
• col-check (method)
• col-foreign (method)
• col-index-p (method)
• col-null-p (method)
• col-primary-p (method)
• col-type (method)
• (setf col-type) (method)
• col-unique-p (method)
• deferredp (method)
• diff-digest (function)
• digest (method)
• table-database (method)
• table-name (method)

Internal Definitions

• %table-database (method)
• diff-slot (function)
• digest-slot (function)
• sort-slot-list (function)
• table-class-direct-slot-definition (class)
• table-class-effective-slot-definition (class)
• table-class-slot-definition-mixin (class)

4.1.12 orizuru-orm/src/query.lisp

Dependency

meta.lisp (file)

Parent

src (module)

Location

src/query.lisp

Exported Definitions

• do-query (macro)
• meta-query (macro)
• query (macro)

4.1.13 orizuru-orm/src/migration.lisp

Dependency

query.lisp (file)

Parent

src (module)

Location

src/migration.lisp

Exported Definitions

• build (function)
• create-table (function)
• delete-migrations (function)
• get-last-migration (function)
• insert-migration (function)
• migrate (function)
• migration-history-p (function)
• rename-migration-history (function)

Internal Definitions

• +create-table-format-string+ (constant)
• get-migration-dir (function)
• migration-history-pathname (function)
• read-migration-history (function)
• serialize (function)
• serialize-plist (function)

4.1.14 orizuru-orm/src/table.lisp

Dependency

migration.lisp (file)

Parent

src (module)

Location

src/table.lisp

Exported Definitions

• <table> (class)
• deftable (macro)

Internal Definitions

• +slot-mapping+ (constant)
• +standard-class-options+ (constant)
• add-default-slots (function)
• any-concrete-superclasses (function)
• process-slot (function)
• separate-slots-and-options (function)

4.1.15 orizuru-orm/src/inflate-deflate.lisp

Dependency

table.lisp (file)

Parent

src (module)

Location

src/inflate-deflate.lisp

Exported Definitions

• defdeflate (macro)
• definflate (macro)
• deflate (generic function)
• deflate (method)
• deflate (method)
• deflate (method)
• deflate (method)
• inflate (generic function)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)

Internal Definitions

db-nil-p (function)

4.1.16 orizuru-orm/src/interface.lisp

Dependency

inflate-deflate.lisp (file)

Parent

src (module)

Location

src/interface.lisp

Exported Definitions

• create (macro)
• create% (macro)
• create-from-plist (macro)
• del (method)
• deref (macro)
• do-filter (macro)
• drop-table (method)
• drop-table (method)
• exists (macro)
• filter (macro)
• plist->object (method)
• plist->object (method)
• save (method)
• single (macro)
• single! (macro)
• single-or-create (macro)

Internal Definitions

• clean-tuple (method)
• make-set (function)
• slot-tuple (method)

4.1.17 orizuru-orm/src/fixture.lisp

Dependency

interface.lisp (file)

Parent

src (module)

Location

src/fixture.lisp

4.1.18 orizuru-orm/src/transaction.lisp

Dependency

fixture.lisp (file)

Parent

src (module)

Location

src/transaction.lisp

Exported Definitions

• begin-transaction (function)
• commit (function)
• rollback (function)
• with-transaction (macro)

4.1.19 orizuru-orm/src/query-set.lisp

Dependency

transaction.lisp (file)

Parent

src (module)

Location

src/query-set.lisp

Exported Definitions

• *compile-sxql-tree* (special variable)
• *full-select-table-sxql* (special variable)
• ->sxql (generic function)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• add-filter (generic function)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-join (generic function)
• add-join (method)
• add-join (method)
• add-join (method)
• add-table (generic function)
• add-table (method)
• add-union (generic function)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• all-from-set (generic function)
• all-from-set (method)
• class-mapped (method)
• (setf class-mapped) (method)
• (setf class-mapped) (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• filter-set (macro)
• filtered-query-set (class)
• join-query-set (class)
• logical-assoc-query-set (class)
• make-query-set (macro)
• map-to-model (function)
• query-set (class)
• query-set= (generic function)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• table-query-set (class)
• union-query-set (class)
• with-join-column (macro)
• with-table-package (macro)

Internal Definitions

• %clone (method)
• %make-query-set (generic function)
• %make-query-set (method)
• %make-query-set (method)
• %print-object (function)
• *print-indent-spaces* (special variable)
• +allowed-logical-op+ (constant)
• +op-ilike+ (constant)
• +op-like+ (constant)
• +op-scanner+ (constant)
• +op<+ (constant)
• +op<=+ (constant)
• +op=+ (constant)
• +op>+ (constant)
• +op>=+ (constant)
• +re-op+ (constant)
• +table-field-splitter+ (constant)
• +table-splitter+ (constant)
• +trim-op+ (constant)
• append-children (function)
• children (method)
• (setf children) (method)
• children= (function)
• columns (method)
• (setf columns) (method)
• dfs (generic function)
• dfs (method)
• filtered-p-fn (function)
• filtered-set= (function)
• filters-only (function)
• find-child (function)
• find-logical-relation (function)
• find-table-or-join (function)
• gen-test-type (macro)
• increase-indent-space (function)
• join-clause (method)
• (setf join-clause) (method)
• join-p-fn (function)
• join-type (method)
• (setf join-type) (method)
• joins-only (function)
• lhs-column (method)
• (setf lhs-column) (method)
• logical-assoc-p-fn (function)
• logical-ops-only (function)
• make-qset (macro)
• make-query-set-and (function)
• make-table-column (function)
• nadd-filter (generic function)
• nadd-filter (method)
• nadd-join (generic function)
• nadd-join (method)
• nadd-table (generic function)
• nadd-table (method)
• nadd-table (method)
• nadd-union (generic function)
• nadd-union (method)
• non-recursive-collect-child (function)
• operation (method)
• (setf operation) (method)
• operator (method)
• (setf operator) (method)
• parent (method)
• (setf parent) (method)
• print-children (function)
• print-indent-spaces (function)
• print-new-line (function)
• push-child (function)
• remap-filter (function)
• remap-ilike (function)
• remove-child (function)
• rhs-column (method)
• (setf rhs-column) (method)
• set-all-parents (function)
• set-all-parents* (function)
• signal-error (function)
• signal-if-lhs-and-rhs-null (function)
• split-tables-name (generic function)
• split-tables-name (method)
• split-tables-name (method)
• sym->filter (function)
• sym->filter-fields (function)
• sym->filter-p (function)
• sym->join (function)
• sym->join-fields (function)
• sym->join-p (function)
• sym->op (function)
• sym->op-case (macro)
• sym-join-fields-w/explicit-column (function)
• sym-w/explicit-column-p (function)
• sym-w/joins-p (function)
• table (method)
• (setf table) (method)
• table-p-fn (function)
• tables-only (function)
• tables-unions-only (function)
• union-op (macro)
• union-p-fn (function)
• unions-only (function)
• use-first-table-available (function)
• with-clone (macro)
• with-increased-indent (macro)
• with-print-new-line (macro)

5 Packages

Packages are listed by definition order.

5.1 orizuru-orm.transaction

Implements transactions.

Source

package.lisp (file)

Use List

• anaphora
• common-lisp

Exported Definitions

• begin-transaction (function)
• commit (function)
• rollback (function)
• with-transaction (macro)

5.2 orizuru-orm.errors

Definition of Orizuru-Orm errors.

Source

package.lisp (file)

Use List

common-lisp

Used By List

orizuru-orm.query-set

Exported Definitions

• configuration-error (condition)
• empty-table (condition)
• no-configuration-error (condition)
• query-error (condition)
• query-set-error (condition)
• query-set-foreign-reference-error (condition)

Internal Definitions

• key (generic function)
• key (method)
• orizuru-orm-error (condition)
• text (generic function)
• text (method)

5.3 orizuru-orm.connect

Handles database connections, connection parameter validation, and various low-level DB-specific modes.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• common-lisp

Exported Definitions

• *default-db* (special variable)
• <database> (class)
• connect (function)
• database-connection (generic function)
• database-connection (method)
• (setf database-connection) (method)
• (setf database-connection) (generic function)
• database-name (generic function)
• database-name (method)
• database-type (generic function)
• database-type (method)
• disconnect (function)
• disconnect-clean (function)
• get-connection (function)
• get-db (function)

Internal Definitions

• *db* (special variable)
• +db-params+ (constant)
• +system-mapping+ (constant)
• database-connection-spec (generic function)
• database-connection-spec (method)
• enforce-foreign-keys (function)
• initialize-*db* (function)
• load-driver (function)
• make-connection (generic function)
• make-connection (method)
• set-proper-quote-character (function)
• validate-all-databases (function)
• validate-connection-spec (function)

5.4 orizuru-orm.sql

This module handles the generation of SQL for table definition and migration.

Source

package.lisp (file)

Use List

• orizuru-orm.util
• iterate
• anaphora
• alexandria.1.0.0
• common-lisp

Exported Definitions

• *timestamp-column-uses-timezone-p* (special variable)
• add-constraint (function)
• alter-constraint (function)
• create-and-sort-constraints (function)
• define-column (function)
• drop-column (function)
• drop-constraint (function)
• make-constraint (function)
• orizuru-orm-type->sql (generic function)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• orizuru-orm-type->sql (method)
• sqlize (function)

Internal Definitions

• %text->number (function)
• %text->something (function)
• +referential-actions+ (constant)
• alter-column-type (function)
• autoincrement-sql (function)
• constraint-name (function)
• conversion-column-p (function)
• conversion-column-types (function)
• convert-column-type (generic function)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• convert-column-type (method)
• create-column-constraints (function)
• diff->from-to-params (function)
• foreign (function)
• gen-alias-integer->type (macro)
• gen-alias-type->integer (macro)
• map-ref-action (function)
• set-index (function)
• set-null (function)
• set-primary (function)
• set-unique (function)

5.5 orizuru-orm

The global Orizuru-Orm package re-exports symbols from internal modules.

Source

package.lisp (file)

Use List

• orizuru-orm.types
• common-lisp

5.6 orizuru-orm.query-set

Implements query sets.

Source

package.lisp (file)

Use List

• orizuru-orm.inflate-deflate
• orizuru-orm.query
• orizuru-orm.meta
• orizuru-orm.util
• orizuru-orm.errors
• orizuru-orm.constants
• sxql
• cl-ppcre
• alexandria.1.0.0
• common-lisp

Exported Definitions

• *compile-sxql-tree* (special variable)
• *full-select-table-sxql* (special variable)
• ->sxql (generic function)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• ->sxql (method)
• add-filter (generic function)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-filter (method)
• add-join (generic function)
• add-join (method)
• add-join (method)
• add-join (method)
• add-table (generic function)
• add-table (method)
• add-union (generic function)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• add-union (method)
• all-from-set (generic function)
• all-from-set (method)
• class-mapped (generic function)
• class-mapped (method)
• (setf class-mapped) (method)
• (setf class-mapped) (generic function)
• (setf class-mapped) (method)
• filter-set (macro)
• filtered-query-set (class)
• join-query-set (class)
• logical-assoc-query-set (class)
• make-query-set (macro)
• map-to-model (function)
• query-set (class)
• query-set= (generic function)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• query-set= (method)
• table-query-set (class)
• union-query-set (class)
• with-join-column (macro)
• with-table-package (macro)

Internal Definitions

• %clone (generic function)
• %clone (method)
• %make-query-set (generic function)
• %make-query-set (method)
• %make-query-set (method)
• %print-object (function)
• *print-indent-spaces* (special variable)
• +allowed-logical-op+ (constant)
• +op-ilike+ (constant)
• +op-like+ (constant)
• +op-scanner+ (constant)
• +op<+ (constant)
• +op<=+ (constant)
• +op=+ (constant)
• +op>+ (constant)
• +op>=+ (constant)
• +re-op+ (constant)
• +table-field-splitter+ (constant)
• +table-splitter+ (constant)
• +trim-op+ (constant)
• append-children (function)
• children (generic function)
• children (method)
• (setf children) (method)
• (setf children) (generic function)
• children= (function)
• columns (generic function)
• columns (method)
• (setf columns) (method)
• (setf columns) (generic function)
• dfs (generic function)
• dfs (method)
• filtered-p-fn (function)
• filtered-set= (function)
• filters-only (function)
• find-child (function)
• find-logical-relation (function)
• find-table-or-join (function)
• gen-test-type (macro)
• increase-indent-space (function)
• join-clause (generic function)
• join-clause (method)
• (setf join-clause) (method)
• (setf join-clause) (generic function)
• join-p-fn (function)
• join-type (generic function)
• join-type (method)
• (setf join-type) (method)
• (setf join-type) (generic function)
• joins-only (function)
• lhs-column (generic function)
• lhs-column (method)
• (setf lhs-column) (method)
• (setf lhs-column) (generic function)
• logical-assoc-p-fn (function)
• logical-ops-only (function)
• make-qset (macro)
• make-query-set-and (function)
• make-table-column (function)
• nadd-filter (generic function)
• nadd-filter (method)
• nadd-join (generic function)
• nadd-join (method)
• nadd-table (generic function)
• nadd-table (method)
• nadd-table (method)
• nadd-union (generic function)
• nadd-union (method)
• non-recursive-collect-child (function)
• operation (generic function)
• operation (method)
• (setf operation) (method)
• (setf operation) (generic function)
• operator (generic function)
• operator (method)
• (setf operator) (method)
• (setf operator) (generic function)
• parent (generic function)
• parent (method)
• (setf parent) (method)
• (setf parent) (generic function)
• print-children (function)
• print-indent-spaces (function)
• print-new-line (function)
• push-child (function)
• remap-filter (function)
• remap-ilike (function)
• remove-child (function)
• rhs-column (generic function)
• rhs-column (method)
• (setf rhs-column) (method)
• (setf rhs-column) (generic function)
• set-all-parents (function)
• set-all-parents* (function)
• signal-error (function)
• signal-if-lhs-and-rhs-null (function)
• split-tables-name (generic function)
• split-tables-name (method)
• split-tables-name (method)
• sym->filter (function)
• sym->filter-fields (function)
• sym->filter-p (function)
• sym->join (function)
• sym->join-fields (function)
• sym->join-p (function)
• sym->op (function)
• sym->op-case (macro)
• sym-join-fields-w/explicit-column (function)
• sym-w/explicit-column-p (function)
• sym-w/joins-p (function)
• table (generic function)
• table (method)
• (setf table) (method)
• (setf table) (generic function)
• table-p-fn (function)
• tables-only (function)
• tables-unions-only (function)
• union-op (macro)
• union-p-fn (function)
• unions-only (function)
• use-first-table-available (function)
• with-clone (macro)
• with-increased-indent (macro)
• with-print-new-line (macro)

5.7 orizuru-orm.query.lowlevel

Executing cl-dbi queries.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

query-low-level (function)

5.8 orizuru-orm.query

Executing cl-dbi queries in the context of Orizuru-Orm.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• common-lisp

Used By List

orizuru-orm.query-set

Exported Definitions

• do-query (macro)
• meta-query (macro)
• query (macro)

5.9 orizuru-orm.inflate-deflate

Inflation/deflation map SQL string to CLOS
objects. This is unrelated to the ORM, and meant to allow complex column datatypes to be mapped to CLOS objects. For example, mapping SQL timestamps to structures that represent time, or mapping other more complex SQL types to CLOS objects.

Source

package.lisp (file)

Use List

• orizuru-orm.types
• anaphora
• common-lisp

Used By List

orizuru-orm.query-set

Exported Definitions

• defdeflate (macro)
• definflate (macro)
• deflate (generic function)
• deflate (method)
• deflate (method)
• deflate (method)
• deflate (method)
• inflate (generic function)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)
• inflate (method)

Internal Definitions

db-nil-p (function)

5.10 orizuru-orm.table

Implements the deftable macro.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• alexandria.1.0.0
• common-lisp

Exported Definitions

• <table> (class)
• deftable (macro)

Internal Definitions

• +slot-mapping+ (constant)
• +standard-class-options+ (constant)
• add-default-slots (function)
• any-concrete-superclasses (function)
• process-slot (function)
• separate-slots-and-options (function)

5.11 orizuru-orm.types

Implements the database types.

Source

package.lisp (file)

Used By List

• orizuru-orm
• orizuru-orm.inflate-deflate

Exported Definitions

• bigint (type)
• datetime (type)
• double (type)
• int (type)
• numeric (type)
• smallint (type)
• text (type)
• timestamp (type)
• varchar (type)

Internal Definitions

integer (type)

5.12 orizuru-orm.fixture

Customizes clos-fixtures for use in Orizuru-Orm.

Source

package.lisp (file)

Use List

common-lisp

5.13 orizuru-orm.constants

Some useful constants

Source

package.lisp (file)

Use List

• alexandria.1.0.0
• common-lisp

Used By List

orizuru-orm.query-set

Exported Definitions

• +id-column-name+ (constant)
• +postgresql-autoincrement-column-qualifier+ (constant)

5.14 orizuru-orm.migration

The first part of this package contains various
simple utilities for manipulating the migration history of a table. The second part contains code that actually creates tables and migrates them. The actual generation of table-creating SQL is handled by orizuru-orm.sql.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• alexandria.1.0.0
• common-lisp

Exported Definitions

• build (function)
• create-table (function)
• delete-migrations (function)
• get-last-migration (function)
• insert-migration (function)
• migrate (function)
• migration-history-p (function)
• rename-migration-history (function)

Internal Definitions

• +create-table-format-string+ (constant)
• get-migration-dir (function)
• migration-history-pathname (function)
• read-migration-history (function)
• serialize (function)
• serialize-plist (function)

5.15 orizuru-orm.util

Various utilities for use in other parts of Orizuru-Orm.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• common-lisp
• alexandria.1.0.0

Used By List

• orizuru-orm.query-set
• orizuru-orm.sql

Exported Definitions

• *foreign-slots-class-package* (special variable)
• all-foreign-reference (function)
• all-foreign-slots (function)
• all-slots-name (function)
• clone (generic function)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• diff-plist (function)
• find-class-slot (function)
• find-foreign-reference (function)
• find-slot (function)
• find-slot-name (function)
• foreign-reference-between (function)
• foreign-reference-class (function)
• foreign-reference-slot-name (function)
• get-class-slot (function)
• get-slot (function)
• plist-keys (function)
• strcat (function)

Internal Definitions

all-slots (function)

5.16 orizuru-orm.meta

This file defines the metaclasses that map CLOS objects to SQL tables, and some basic operations on them.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• common-lisp

Used By List

orizuru-orm.query-set

Exported Definitions

• <table-class> (class)
• abstractp (generic function)
• abstractp (method)
• col-autoincrement-p (generic function)
• col-autoincrement-p (method)
• col-check (generic function)
• col-check (method)
• col-foreign (generic function)
• col-foreign (method)
• col-index-p (generic function)
• col-index-p (method)
• col-null-p (generic function)
• col-null-p (method)
• col-primary-p (generic function)
• col-primary-p (method)
• col-type (generic function)
• col-type (method)
• (setf col-type) (method)
• (setf col-type) (generic function)
• col-unique-p (generic function)
• col-unique-p (method)
• deferredp (generic function)
• deferredp (method)
• diff-digest (function)
• digest (generic function)
• digest (method)
• table-database (generic function)
• table-database (method)
• table-name (generic function)
• table-name (method)

Internal Definitions

• %table-database (generic function)
• %table-database (method)
• diff-slot (function)
• digest-slot (function)
• sort-slot-list (function)
• table-class-direct-slot-definition (class)
• table-class-effective-slot-definition (class)
• table-class-slot-definition-mixin (class)

5.17 orizuru-orm.interface

This package contains the methods used to access and alter database records in an object-oriented way.

Source

package.lisp (file)

Use List

• iterate
• anaphora
• common-lisp

Exported Definitions

• create (macro)
• create% (macro)
• create-from-plist (macro)
• del (generic function)
• del (method)
• deref (macro)
• do-filter (macro)
• drop-table (generic function)
• drop-table (method)
• drop-table (method)
• exists (macro)
• filter (macro)
• plist->object (generic function)
• plist->object (method)
• plist->object (method)
• save (generic function)
• save (method)
• single (macro)
• single! (macro)
• single-or-create (macro)

Internal Definitions

• clean-tuple (generic function)
• clean-tuple (method)
• make-set (function)
• slot-tuple (generic function)
• slot-tuple (method)

5.18 orizuru-orm.config

Functions for reading and writing from and to the global configuration.

Source

config.lisp (file)

Use List

• anaphora
• common-lisp

Exported Definitions

• *after-config-hook* (special variable)
• debugp (function)
• get-config-value (function)
• get-configuration (function)
• setup (function)

Internal Definitions

*config* (special variable)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +id-column-name+

Package

orizuru-orm.constants

Source

constants.lisp (file)

Constant: +postgresql-autoincrement-column-qualifier+

Package

orizuru-orm.constants

Source

constants.lisp (file)

6.1.2 Special variables

Special Variable: *after-config-hook*

A function that gets executed after setup is called. Takes no arguments, does nothing by default.

Package

orizuru-orm.config

Source

config.lisp (file)

Special Variable: *compile-sxql-tree*

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Special Variable: *default-db*

The name of the default database

Package

orizuru-orm.connect

Source

connect.lisp (file)

Special Variable: *foreign-slots-class-package*

Package

orizuru-orm.util

Source

util.lisp (file)

Special Variable: *full-select-table-sxql*

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Special Variable: *timestamp-column-uses-timezone-p*

Package

orizuru-orm.sql

Source

sql.lisp (file)

6.1.3 Macros

Macro: create CLASS-NAME &rest ARGS

Create an object.

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: create% OBJ

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: create-from-plist CLASS PLIST

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: defdeflate (OBJ-NAME OBJ-TYPE) &rest BODY

Package

orizuru-orm.inflate-deflate

Source

inflate-deflate.lisp (file)

Macro: definflate (OBJ-NAME OBJ-TYPE-NAME) &rest BODY

Package

orizuru-orm.inflate-deflate

Source

inflate-deflate.lisp (file)

Macro: deftable NAME (&rest SUPERCLASSES) &body SLOTS-AND-OPTIONS

Define a table.

Package

orizuru-orm.table

Source

table.lisp (file)

Macro: deref OBJ FIELD

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: do-filter (RESULT-NAME CLASS &rest PARAMS) &rest BODY

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: do-query (RESULT-NAME QUERY &optional DATABASE-NAME) &rest BODY

Execute code for each result in the query, without aggregating them all into a list.

Package

orizuru-orm.query

Source

query.lisp (file)

Macro: exists CLASS &rest PARAMS

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: filter CLASS &rest PARAMS

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: filter-set &optional QSET PARAMS LOGICAL-OP

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Macro: make-query-set &optional FROM PARAM

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Macro: meta-query QUERY DATABASE-NAME BODY

Package

orizuru-orm.query

Source

query.lisp (file)

Macro: query QUERY &optional DATABASE-NAME

Execute an SxQL query on the database ‘database-name‘.

Package

orizuru-orm.query

Source

query.lisp (file)

Macro: single CLASS &rest PARAMS

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: single! CLASS &rest PARAMS

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: single-or-create CLASS &rest PARAMS

Package

orizuru-orm.interface

Source

interface.lisp (file)

Macro: with-join-column (COLUMN) &body BODY

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Macro: with-table-package (THE-PACKAGE) &body BODY

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Macro: with-transaction (&optional DB) &rest BODY

Package

orizuru-orm.transaction

Source

transaction.lisp (file)

6.1.4 Functions

Function: add-constraint TABLE-NAME BODY

SQL to add a constraint to a table.

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: all-foreign-reference CLASS

return a plist of (class-referring-name . slot-name)

Package

orizuru-orm.util

Source

util.lisp (file)

Function: all-foreign-slots CLASS

Package

orizuru-orm.util

Source

util.lisp (file)

Function: all-slots-name CLASS

Package

orizuru-orm.util

Source

util.lisp (file)

Function: alter-constraint TABLE-NAME COLUMN-NAME TYPE VALUE DIFF

SQL to alter a constraint in a table.

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: begin-transaction &optional DB

Package

orizuru-orm.transaction

Source

transaction.lisp (file)

Function: build TABLE-NAME

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: commit &optional DB

Package

orizuru-orm.transaction

Source

transaction.lisp (file)

Function: connect ()

Connect to all the databases specified in the configuration.

Package

orizuru-orm.connect

Source

connect.lisp (file)

Function: create-and-sort-constraints TABLE-NAME DIGEST DATABASE-NAME

A plist of different types of constraints from a table digest.

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: create-table TABLE-NAME DIGEST

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: debugp ()

Determine if Orizuru-Orm is in debug mode.

Package

orizuru-orm.config

Source

config.lisp (file)

Function: define-column TABLE-NAME COLUMN DATABASE-NAME

A column definition from the digest of its slot, name and name of the database it’s table belongs to

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: delete-migrations &optional FORCE

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: diff-digest DIGEST-A DIGEST-B

Compute the difference between two digests. See DIGEST.

Package

orizuru-orm.meta

Source

meta.lisp (file)

Function: diff-plist PLIST-A PLIST-B &key TEST

Calculates the difference between two plists, returning the result as a list of ([property] [old value] [new value])

Package

orizuru-orm.util

Source

util.lisp (file)

Function: disconnect ()

Cut all connections.

Package

orizuru-orm.connect

Source

connect.lisp (file)

Function: disconnect-clean ()

Cut all connections and reset *db* hashtable

Package

orizuru-orm.connect

Source

connect.lisp (file)

Function: drop-column TABLE-NAME COLUMN-NAME

SQL to drop a column, given the table and column names.

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: drop-constraint TABLE-NAME COLUMN-NAME TYPE

SQL to drop a constraint from a table.

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: find-class-slot CLASS NAME

Find a slot by name

Package

orizuru-orm.util

Source

util.lisp (file)

Function: find-foreign-reference CLASS-FROM CLASS-TO

Package

orizuru-orm.util

Source

util.lisp (file)

Function: find-slot OBJ NAME

Find a slot by name

Package

orizuru-orm.util

Source

util.lisp (file)

Function: find-slot-name CLASS SLOT-SYMBOL

Package

orizuru-orm.util

Source

util.lisp (file)

Function: foreign-reference-between CLASS-FROM CLASS-TO

Package

orizuru-orm.util

Source

util.lisp (file)

Function: foreign-reference-class A

Package

orizuru-orm.util

Source

util.lisp (file)

Function: foreign-reference-slot-name A

Package

orizuru-orm.util

Source

util.lisp (file)

Function: get-class-slot CLASS NAME

Find a slot in a class by keyword name

Package

orizuru-orm.util

Source

util.lisp (file)

Function: get-config-value KEY

Get the value of ‘key‘ in the configuration.

Package

orizuru-orm.config

Source

config.lisp (file)

Function: get-configuration ()

Return the configuration object, or signal a no-configuration error.

Package

orizuru-orm.config

Source

config.lisp (file)

Function: get-connection &optional DATABASE-NAME

Return the connection handler for a given database.

Package

orizuru-orm.connect

Source

connect.lisp (file)

Function: get-db &optional DATABASE-NAME

Return the database matching a specific name

Package

orizuru-orm.connect

Source

connect.lisp (file)

Function: get-last-migration TABLE-NAME

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: get-slot OBJ NAME

Find slot by keyword name

Package

orizuru-orm.util

Source

util.lisp (file)

Function: insert-migration TABLE-NAME DIGEST

Insert a new diff to the migration history

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: make-constraint TABLE-NAME COLUMN-NAME TYPE VALUE

A constraint from its type and values, if it can be created (eg :nullp t doesn’t create a constraint, but :nullp nil creates a NOT NULL constraint).

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: map-to-model QUERY-SET CLASS-SYMBOL

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Function: migrate TABLE-CLASS DIFF

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: migration-history-p TABLE-NAME

T if the table has a migration history, NIL otherwise.

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: plist-keys PLIST

Return the keys of a plist.

Package

orizuru-orm.util

Source

util.lisp (file)

Function: query-low-level SQL CONNECTION

Bypass orizuru-orm and execute sql query with dbi

Package

orizuru-orm.query.lowlevel

Source

query-low-level.lisp (file)

Function: rename-migration-history TABLE-NAME NEW-NAME

Package

orizuru-orm.migration

Source

migration.lisp (file)

Function: rollback &optional DB

Package

orizuru-orm.transaction

Source

transaction.lisp (file)

Function: setup &key MIGRATIONS-DIRECTORY DATABASES DEBUG

Set the configuration.

Package

orizuru-orm.config

Source

config.lisp (file)

Function: sqlize OBJ

Turn a symbol or a string into its SQL representation. Identical to the behaviour of SxQL.

Package

orizuru-orm.sql

Source

sql.lisp (file)

Function: strcat &rest STRINGS

Package

orizuru-orm.util

Source

util.lisp (file)

6.1.5 Generic functions

Generic Function: ->sxql OBJECT

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: ->sxql (OBJECT join-query-set)

Method: ->sxql (OBJECT union-query-set)

Method: ->sxql (OBJECT filtered-query-set)

Method: ->sxql (OBJECT logical-assoc-query-set)

Method: ->sxql (OBJECT table-query-set)

Method: ->sxql (OBJECT query-set)

Method: ->sxql OBJECT

Method: ->sxql (OBJECT list)

Generic Function: abstractp OBJECT

Package

orizuru-orm.meta

Methods

Method: abstractp (<TABLE-CLASS> <table-class>)

Whether the class corresponds to an SQL table or not.

Source

meta.lisp (file)

Generic Function: add-filter OBJECT CHILD &key LOGICAL-OP OPERATION LHS RHS

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: add-filter (OBJECT symbol) CHILD &key LOGICAL-OP OPERATION LHS RHS

Method: add-filter (OBJECT query-set) (CHILD null) &key LOGICAL-OP OPERATION LHS RHS

Method: add-filter (OBJECT query-set) (CHILD list) &key LOGICAL-OP OPERATION LHS RHS

Method: add-filter (OBJECT logical-assoc-query-set) (CHILD null) &key LOGICAL-OP OPERATION LHS RHS

Method: add-filter (OBJECT query-set) (CHILD filtered-query-set) &key LOGICAL-OP OPERATION LHS RHS

Method: add-filter (OBJECT query-set) (CHILD symbol) &key LOGICAL-OP OPERATION LHS RHS

Method: add-filter (OBJECT query-set) (CHILD table-query-set) &key LOGICAL-OP OPERATION LHS RHS

Generic Function: add-join OBJECT JOIN &key &allow-other-keys

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: add-join (OBJECT query-set) (JOIN list) &key &allow-other-keys

Method: add-join (OBJECT query-set) (JOIN join-query-set) &key &allow-other-keys

Method: add-join (OBJECT table-query-set) (JOIN join-query-set) &key &allow-other-keys

Generic Function: add-table OBJECT CHILD

Add a table as child of this query set

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: add-table (OBJECT query-set) CHILD

Generic Function: add-union OBJECT TABLE

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: add-union (OBJECT table-query-set) (TABLE table-query-set)

Method: add-union (OBJECT query-set) (TABLE table-query-set)

Method: add-union (OBJECT union-query-set) (OTHER union-query-set)

Method: add-union (OBJECT union-query-set) (TABLE table-query-set)

Method: add-union (OBJECT query-set) (UNION-SET union-query-set)

Method: add-union (OBJECT query-set) (OTHER-QUERY-SET query-set)

Method: add-union OBJECT (TABLE null)

Generic Function: all-from-set OBJECT &key AS-PLIST

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: all-from-set (OBJECT query-set) &key AS-PLIST

Generic Function: class-mapped OBJECT

Generic Function: (setf class-mapped) NEW-VALUE OBJECT

Package

orizuru-orm.query-set

Methods

Method: class-mapped (TABLE-QUERY-SET table-query-set)

automatically generated reader method

Source

query-set.lisp (file)

Method: (setf class-mapped) NEW-VALUE (TABLE-QUERY-SET table-query-set)

automatically generated writer method

Source

query-set.lisp (file)

Method: (setf class-mapped) VALUE (OBJECT query-set)

Source

query-set.lisp (file)

Generic Function: clone OBJECT

Package

orizuru-orm.util

Source

util.lisp (file)

Methods

Method: clone (OBJECT join-query-set)

Source

query-set.lisp (file)

Method: clone (OBJECT filtered-query-set)

Source

query-set.lisp (file)

Method: clone (OBJECT logical-assoc-query-set)

Source

query-set.lisp (file)

Method: clone (OBJECT table-query-set)

Source

query-set.lisp (file)

Method: clone (OBJECT query-set)

Source

query-set.lisp (file)

Method: clone (OBJECT list)

Method: clone OBJECT

Generic Function: col-autoincrement-p OBJECT

Package

orizuru-orm.meta

Methods

Method: col-autoincrement-p (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: col-check OBJECT

Package

orizuru-orm.meta

Methods

Method: col-check (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: col-foreign OBJECT

Package

orizuru-orm.meta

Methods

Method: col-foreign (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: col-index-p OBJECT

Package

orizuru-orm.meta

Methods

Method: col-index-p (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: col-null-p OBJECT

Package

orizuru-orm.meta

Methods

Method: col-null-p (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: col-primary-p OBJECT

Package

orizuru-orm.meta

Methods

Method: col-primary-p (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: col-type OBJECT

Generic Function: (setf col-type) NEW-VALUE OBJECT

Package

orizuru-orm.meta

Methods

Method: col-type (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Method: (setf col-type) NEW-VALUE (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated writer method

Source

meta.lisp (file)

Generic Function: col-unique-p OBJECT

Package

orizuru-orm.meta

Methods

Method: col-unique-p (TABLE-CLASS-SLOT-DEFINITION-MIXIN table-class-slot-definition-mixin)

automatically generated reader method

Source

meta.lisp (file)

Generic Function: database-connection OBJECT

Generic Function: (setf database-connection) NEW-VALUE OBJECT

Package

orizuru-orm.connect

Methods

Method: database-connection (<DATABASE> <database>)

Method: (setf database-connection) NEW-VALUE (<DATABASE> <database>)

The underlying connection object.

Source

connect.lisp (file)

Generic Function: database-name OBJECT

Package

orizuru-orm.connect

Methods

Method: database-name (<DATABASE> <database>)

The database name.

Source

connect.lisp (file)

Generic Function: database-type OBJECT

Package

orizuru-orm.connect

Methods

Method: database-type (<DATABASE> <database>)

A keyword representing the database type (:postgres only atm).

Source

connect.lisp (file)

Generic Function: deferredp OBJECT

Package

orizuru-orm.meta

Methods

Method: deferredp (<TABLE-CLASS> <table-class>)

Whether the class should be built only when explicitly calling build.

Source

meta.lisp (file)

Generic Function: deflate OBJ

Turn a Lisp object into a string for insertion in the database.

Package

orizuru-orm.inflate-deflate

Source

inflate-deflate.lisp (file)

Methods

Method: deflate (STAMP timestamp)

Method: deflate OBJ

Method: deflate (NUM number)

Method: deflate (STR string)

Generic Function: del OBJ

Package

orizuru-orm.interface

Methods

Method: del (OBJ <table>)

Delete an object from the database.

Source

interface.lisp (file)

Generic Function: digest CLASS

Package

orizuru-orm.meta

Methods

Method: digest (CLASS <table-class>)

Serialize a class’s options and slots’ options into a plist

Source

meta.lisp (file)

Generic Function: drop-table TABLE

Package

orizuru-orm.interface

Methods

Method: drop-table (TABLE-NAME symbol)

Source

interface.lisp (file)

Method: drop-table (TABLE <table-class>)

Source

interface.lisp (file)

Generic Function: inflate OBJ TYPE-NAME

Turn a string into a CLOS object.

Package

orizuru-orm.inflate-deflate

Source

inflate-deflate.lisp (file)

Methods

Method: inflate STAMP (TYPE (eql timestamp))

Method: inflate OBJ (TYPE (eql datetime))

Method: inflate OBJ (TYPE (eql varchar))

Method: inflate OBJ (TYPE (eql text))

Method: inflate OBJ (TYPE (eql double))

Method: inflate OBJ (TYPE (eql numeric))

Method: inflate OBJ (TYPE (eql smallint))

Method: inflate OBJ (TYPE (eql bigint))

Method: inflate OBJ (TYPE (eql int))

Method: inflate OBJ (TYPE (eql integer))

Generic Function: orizuru-orm-type->sql SYM

Package

orizuru-orm.sql

Source

sql.lisp (file)

Methods

Method: orizuru-orm-type->sql (SYM (eql timestamp))

Method: orizuru-orm-type->sql (SYM (eql numeric))

Method: orizuru-orm-type->sql (SYM (eql double))

Method: orizuru-orm-type->sql (SYM (eql smallint))

Method: orizuru-orm-type->sql (SYM (eql bigint))

Method: orizuru-orm-type->sql (SYM (eql int))

Method: orizuru-orm-type->sql (SYM (eql integer))

Method: orizuru-orm-type->sql (SYM (eql varchar))

Method: orizuru-orm-type->sql (SYM (eql text))

Generic Function: plist->object TABLE TUPLE

Package

orizuru-orm.interface

Methods

Method: plist->object (TABLE-NAME symbol) TUPLE

Source

interface.lisp (file)

Method: plist->object (TABLE <table-class>) TUPLE

Convert a tuple produced by CL-DBI to a CLOS instance.

Source

interface.lisp (file)

Generic Function: query-set= A B

Package

orizuru-orm.query-set

Source

query-set.lisp (file)

Methods

Method: query-set= (A join-query-set) (B join-query-set)

Method: query-set= (A filtered-query-set) (B filtered-query-set)

Method: query-set= (A logical-assoc-query-set) (B logical-assoc-query-set)

Method: query-set= (A table-query-set) (B table-query-set)

Method: query-set= (A query-set) (B query-set)

Method: query-set= A B