The orizuru-orm Reference Manual

4.1.1 orizuru-orm/orizuru-orm.asd

Source

orizuru-orm.asd.

Parent Component

orizuru-orm (system).

ASDF Systems

orizuru-orm.

---

4.1.2 orizuru-orm/src/package.lisp

Source

orizuru-orm.asd.

Parent Component

src (module).

Packages

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

---

4.1.3 orizuru-orm/src/constants.lisp

Dependency

package.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

---

4.1.4 orizuru-orm/src/errors.lisp

Dependency

constants.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.5 orizuru-orm/src/config.lisp

Dependency

errors.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Packages

orizuru-orm.config.

Public Interface

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

Internals

*config* (special variable).

---

4.1.6 orizuru-orm/src/util.lisp

Dependency

config.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

• *foreign-slots-class-package* (special variable).
• all-foreign-reference (function).
• all-foreign-slots (function).
• all-slots-name (function).
• clone (generic function).
• 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).

Internals

all-slots (function).

---

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

Dependency

util.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

query-low-level (function).

---

4.1.8 orizuru-orm/src/connect.lisp

Dependency

query-low-level.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

• *db* (special variable).
• +db-params+ (constant).
• +system-mapping+ (constant).
• database-connection-spec (reader 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).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

integer (type).

---

4.1.10 orizuru-orm/src/sql.lisp

Dependency

types.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

• *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).
• sqlize (function).

Internals

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

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

• <table-class> (class).
• abstractp (reader method).
• col-autoincrement-p (reader method).
• col-check (reader method).
• col-foreign (reader method).
• col-index-p (reader method).
• col-null-p (reader method).
• col-primary-p (reader method).
• col-type (reader method).
• (setf col-type) (writer method).
• col-unique-p (reader method).
• compute-effective-slot-definition (method).
• deferredp (reader method).
• diff-digest (function).
• digest (method).
• direct-slot-definition-class (method).
• effective-slot-definition-class (method).
• table-database (method).
• table-name (method).
• validate-superclass (method).
• validate-superclass (method).

Internals

• %table-database (reader 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).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

---

4.1.13 orizuru-orm/src/migration.lisp

Dependency

query.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

db-nil-p (function).

---

4.1.16 orizuru-orm/src/interface.lisp

Dependency

inflate-deflate.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.17 orizuru-orm/src/fixture.lisp

Dependency

interface.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

register-fixture (method).

---

4.1.18 orizuru-orm/src/transaction.lisp

Dependency

fixture.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

---

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

Dependency

transaction.lisp (file).

Source

orizuru-orm.asd.

Parent Component

src (module).

Public Interface

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

Internals

• %clone (method).
• %make-query-set (generic function).
• %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 (reader method).
• (setf children) (writer method).
• children= (function).
• columns (reader method).
• (setf columns) (writer method).
• dfs (generic function).
• 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 (reader method).
• (setf join-clause) (writer method).
• join-p-fn (function).
• join-type (reader method).
• (setf join-type) (writer method).
• joins-only (function).
• lhs-column (reader method).
• (setf lhs-column) (writer 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-join (generic function).
• nadd-table (generic function).
• nadd-union (generic function).
• non-recursive-collect-child (function).
• operation (reader method).
• (setf operation) (writer method).
• operator (reader method).
• (setf operator) (writer method).
• parent (reader method).
• (setf parent) (writer 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 (reader method).
• (setf rhs-column) (writer method).
• set-all-parents (function).
• set-all-parents* (function).
• signal-error (function).
• signal-if-lhs-and-rhs-null (function).
• split-tables-name (generic function).
• 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 (reader method).
• (setf table) (writer 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).

---

6.1.1 Constants

Constant: +id-column-name+ ¶

Package

orizuru-orm.constants.

Source

constants.lisp.

Constant: +postgresql-autoincrement-column-qualifier+ ¶

Package

orizuru-orm.constants.

Source

constants.lisp.

---

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.

Special Variable: *compile-sxql-tree* ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

Special Variable: *default-db* ¶

The name of the default database

Package

orizuru-orm.connect.

Source

connect.lisp.

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

Package

orizuru-orm.util.

Source

util.lisp.

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

Package

orizuru-orm.query-set.

Source

query-set.lisp.

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

Package

orizuru-orm.sql.

Source

sql.lisp.

---

6.1.3 Macros

Macro: create (class-name &rest args) ¶

Create an object.

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: create% (obj) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: create-from-plist (class plist) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: defdeflate ((obj-name obj-type) &rest body) ¶

Package

orizuru-orm.inflate-deflate.

Source

inflate-deflate.lisp.

Macro: definflate ((obj-name obj-type-name) &rest body) ¶

Package

orizuru-orm.inflate-deflate.

Source

inflate-deflate.lisp.

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

Define a table.

Package

orizuru-orm.table.

Source

table.lisp.

Macro: deref (obj field) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: do-filter ((result-name class &rest params) &rest body) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

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.

Macro: exists (class &rest params) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: filter (class &rest params) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: filter-set (&optional qset params logical-op) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

Macro: make-query-set (&optional from param) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

Macro: meta-query (query database-name body) ¶

Package

orizuru-orm.query.

Source

query.lisp.

Macro: query (query &optional database-name) ¶

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

Package

orizuru-orm.query.

Source

query.lisp.

Macro: single (class &rest params) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: single! (class &rest params) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: single-or-create (class &rest params) ¶

Package

orizuru-orm.interface.

Source

interface.lisp.

Macro: with-join-column ((column) &body body) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

Macro: with-table-package ((the-package) &body body) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

Macro: with-transaction ((&optional db) &rest body) ¶

Package

orizuru-orm.transaction.

Source

transaction.lisp.

---

6.1.4 Ordinary functions

Function: add-constraint (table-name body) ¶

SQL to add a constraint to a table.

Package

orizuru-orm.sql.

Source

sql.lisp.

Function: all-foreign-reference (class) ¶

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

Package

orizuru-orm.util.

Source

util.lisp.

Function: all-foreign-slots (class) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Function: all-slots-name (class) ¶

Package

orizuru-orm.util.

Source

util.lisp.

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.

Function: begin-transaction (&optional db) ¶

Package

orizuru-orm.transaction.

Source

transaction.lisp.

Function: build (table-name) ¶

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: commit (&optional db) ¶

Package

orizuru-orm.transaction.

Source

transaction.lisp.

Function: connect () ¶

Connect to all the databases specified in the configuration.

Package

orizuru-orm.connect.

Source

connect.lisp.

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.

Function: create-table (table-name digest) ¶

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: debugp () ¶

Determine if Orizuru-Orm is in debug mode.

Package

orizuru-orm.config.

Source

config.lisp.

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.

Function: delete-migrations (&optional force) ¶

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: diff-digest (digest-a digest-b) ¶

Compute the difference between two digests. See DIGEST.

Package

orizuru-orm.meta.

Source

meta.lisp.

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.

Function: disconnect () ¶

Cut all connections.

Package

orizuru-orm.connect.

Source

connect.lisp.

Function: disconnect-clean () ¶

Cut all connections and reset *db* hashtable

Package

orizuru-orm.connect.

Source

connect.lisp.

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.

Function: drop-constraint (table-name column-name type) ¶

SQL to drop a constraint from a table.

Package

orizuru-orm.sql.

Source

sql.lisp.

Function: find-class-slot (class name) ¶

Find a slot by name

Package

orizuru-orm.util.

Source

util.lisp.

Function: find-foreign-reference (class-from class-to) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Function: find-slot (obj name) ¶

Find a slot by name

Package

orizuru-orm.util.

Source

util.lisp.

Function: find-slot-name (class slot-symbol) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Function: foreign-reference-between (class-from class-to) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Function: foreign-reference-class (a) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Function: foreign-reference-slot-name (a) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Function: get-class-slot (class name) ¶

Find a slot in a class by keyword name

Package

orizuru-orm.util.

Source

util.lisp.

Function: get-config-value (key) ¶

Get the value of ‘key‘ in the configuration.

Package

orizuru-orm.config.

Source

config.lisp.

Function: get-configuration () ¶

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

Package

orizuru-orm.config.

Source

config.lisp.

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

Return the connection handler for a given database.

Package

orizuru-orm.connect.

Source

connect.lisp.

Function: get-db (&optional database-name) ¶

Return the database matching a specific name

Package

orizuru-orm.connect.

Source

connect.lisp.

Function: get-last-migration (table-name) ¶

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: get-slot (obj name) ¶

Find slot by keyword name

Package

orizuru-orm.util.

Source

util.lisp.

Function: insert-migration (table-name digest) ¶

Insert a new diff to the migration history

Package

orizuru-orm.migration.

Source

migration.lisp.

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.

Function: map-to-model (query-set class-symbol) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

Function: migrate (table-class diff) ¶

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: migration-history-p (table-name) ¶

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

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: plist-keys (plist) ¶

Return the keys of a plist.

Package

orizuru-orm.util.

Source

util.lisp.

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.

Function: rename-migration-history (table-name new-name) ¶

Package

orizuru-orm.migration.

Source

migration.lisp.

Function: rollback (&optional db) ¶

Package

orizuru-orm.transaction.

Source

transaction.lisp.

Function: setup (&key migrations-directory databases debug) ¶

Set the configuration.

Package

orizuru-orm.config.

Source

config.lisp.

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.

Function: strcat (&rest strings) ¶

Package

orizuru-orm.util.

Source

util.lisp.

---

6.1.5 Generic functions

Generic Function: ->sxql (object) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

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 Reader: abstractp (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: abstractp ((<table-class> <table-class>)) ¶

Whether the class corresponds to an SQL table or not.

Source

meta.lisp.

Target Slot

abstractp.

Generic Function: add-filter (object child &key logical-op operation lhs rhs) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

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.

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.

Methods

Method: add-table ((object query-set) child) ¶

Generic Function: add-union (object table) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

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.

Methods

Method: all-from-set ((object query-set) &key as-plist) ¶

Generic Reader: class-mapped (object) ¶

Package

orizuru-orm.query-set.

Methods

Reader Method: class-mapped ((table-query-set table-query-set)) ¶

automatically generated reader method

Source

query-set.lisp.

Target Slot

class-mapped.

Generic Function: (setf class-mapped) (object) ¶

Package

orizuru-orm.query-set.

Methods

Method: (setf class-mapped) ((object query-set)) ¶

Source

query-set.lisp.

Writer Method: (setf class-mapped) ((table-query-set table-query-set)) ¶

automatically generated writer method

Source

query-set.lisp.

Target Slot

class-mapped.

Generic Function: clone (object) ¶

Package

orizuru-orm.util.

Source

util.lisp.

Methods

Method: clone ((object join-query-set)) ¶

Source

query-set.lisp.

Method: clone ((object filtered-query-set)) ¶

Source

query-set.lisp.

Method: clone ((object logical-assoc-query-set)) ¶

Source

query-set.lisp.

Method: clone ((object table-query-set)) ¶

Source

query-set.lisp.

Method: clone ((object query-set)) ¶

Source

query-set.lisp.

Method: clone ((object list)) ¶

Method: clone (object) ¶

Generic Reader: col-autoincrement-p (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-autoincrement-p ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-autoincrement-p.

Generic Reader: col-check (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-check ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-check.

Generic Reader: col-foreign (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-foreign ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-foreign.

Generic Reader: col-index-p (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-index-p ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-index-p.

Generic Reader: col-null-p (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-null-p ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-null-p.

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

Package

orizuru-orm.meta.

Methods

Reader Method: col-primary-p ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-primary-p.

Generic Reader: col-type (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-type ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-type.

Generic Writer: (setf col-type) (object) ¶

Package

orizuru-orm.meta.

Methods

Writer Method: (setf col-type) ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated writer method

Source

meta.lisp.

Target Slot

col-type.

Generic Reader: col-unique-p (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: col-unique-p ((table-class-slot-definition-mixin table-class-slot-definition-mixin)) ¶

automatically generated reader method

Source

meta.lisp.

Target Slot

col-unique-p.

Generic Reader: database-connection (object) ¶

Generic Writer: (setf database-connection) (object) ¶

Package

orizuru-orm.connect.

Methods

Reader Method: database-connection ((<database> <database>)) ¶

Writer Method: (setf database-connection) ((<database> <database>)) ¶

The underlying connection object.

Source

connect.lisp.

Target Slot

conn.

Generic Reader: database-name (object) ¶

Package

orizuru-orm.connect.

Methods

Reader Method: database-name ((<database> <database>)) ¶

The database name.

Source

connect.lisp.

Target Slot

name.

Generic Reader: database-type (object) ¶

Package

orizuru-orm.connect.

Methods

Reader Method: database-type ((<database> <database>)) ¶

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

Source

connect.lisp.

Target Slot

type.

Generic Reader: deferredp (object) ¶

Package

orizuru-orm.meta.

Methods

Reader Method: deferredp ((<table-class> <table-class>)) ¶

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

Source

meta.lisp.

Target Slot

deferredp.

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.

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.

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.

Generic Function: drop-table (table) ¶

Package

orizuru-orm.interface.

Methods

Method: drop-table ((table-name symbol)) ¶

Source

interface.lisp.

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

Source

interface.lisp.

Generic Function: inflate (obj type-name) ¶

Turn a string into a CLOS object.

Package

orizuru-orm.inflate-deflate.

Source

inflate-deflate.lisp.

Methods

Method: inflate (stamp (type (eql orizuru-orm.types:timestamp))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:datetime))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:varchar))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:text))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:double))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:numeric))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:smallint))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:bigint))) ¶

Method: inflate (obj (type (eql orizuru-orm.types:int))) ¶

Method: inflate (obj (type (eql integer))) ¶

Generic Function: orizuru-orm-type->sql (sym) ¶

Package

orizuru-orm.sql.

Source

sql.lisp.

Methods

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:timestamp))) ¶

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:numeric))) ¶

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:double))) ¶

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:smallint))) ¶

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:bigint))) ¶

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:int))) ¶

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

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:varchar))) ¶

Method: orizuru-orm-type->sql ((sym (eql orizuru-orm.types:text))) ¶

Generic Function: plist->object (table tuple) ¶

Package

orizuru-orm.interface.

Methods

Method: plist->object ((table-name symbol) tuple) ¶

Source

interface.lisp.

Method: plist->object ((table <table-class>) tuple) ¶

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

Source

interface.lisp.

Generic Function: query-set= (a b) ¶

Package

orizuru-orm.query-set.

Source

query-set.lisp.

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

Generic Function: save (obj) ¶

Package

orizuru-orm.interface.

Methods

Method: save ((obj <table>)) ¶

Write an instance object to the database.

Source

interface.lisp.

Generic Function: table-database (class) ¶

Package

orizuru-orm.meta.

Methods

Method: table-database ((class <table-class>)) ¶

The database this class belongs to.

Source

meta.lisp.

Generic Function: table-name (class) ¶

Package

orizuru-orm.meta.

Methods

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

Return the name of a the class, a symbol.

Source

meta.lisp.

---

6.1.6 Standalone methods

Method: compute-effective-slot-definition ((class <table-class>) slot-name direct-slot-definitions) ¶

Package

sb-mop.

Source

meta.lisp.

Method: direct-slot-definition-class ((class <table-class>) &rest initargs) ¶

Package

sb-mop.

Source

meta.lisp.

Method: effective-slot-definition-class ((class <table-class>) &rest initargs) ¶

Package

sb-mop.

Source

meta.lisp.

Method: initialize-instance :after ((object query-set) &key &allow-other-keys) ¶

Source

query-set.lisp.

Method: print-object ((object logical-assoc-query-set) stream) ¶

Source

query-set.lisp.

Method: print-object ((object filtered-query-set) stream) ¶

Source

query-set.lisp.

Method: print-object ((object union-query-set) stream) ¶

Source

query-set.lisp.

Method: print-object ((object table-query-set) stream) ¶

Source

query-set.lisp.

Method: print-object ((object join-query-set) stream) ¶

Source

query-set.lisp.

Method: print-object ((object query-set) stream) ¶

Source

query-set.lisp.

Method: register-fixture ((instance <table>)) ¶

Package

clos-fixtures.

Source

fixture.lisp.

Method: validate-superclass ((class standard-class) (super <table-class>)) ¶

Package

sb-mop.

Source

meta.lisp.

Method: validate-superclass ((class <table-class>) (super standard-class)) ¶

Package

sb-mop.

Source

meta.lisp.

---