The clsql-helper Reference Manual

Table of Contents

The clsql-helper Reference Manual

This is the clsql-helper Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:48:34 2020 GMT+0.

1 Introduction

CLSQL-Helper

A library providing a clutch of utilities to make working with clsql easier

• single interface functions that make a best effort to read/write a date in (m)any formats
• convert-to-clsql-date(time) and
• simplified sql-expression interface
• clsql-or(s), clsql-and(s) and clsql-exp which make building where expressions easier
• clsql-mop help, find the primary keys of an object and query / test equality with these
• A basic sql pretty printer, so that the code printed from log-database-query , which uses the clsql printer and allows easily recording queries executing on a given connection
• coersion to/from clsql data types an value

db-object - class

Web Thread Safety - through dynamic connection binding

If you def-view-classes inherit from clsql-helper:db-object then they will never use stored database connections (from view-database slot) and instead will prefer the dynamic default-database.

Using with-database/with-a-database then become useful ways to interact with clsql in a multithreaded web environment.

Automatic Primary Key filling

While there is code in clsql to handle filling primary keys, I have never quite wrapped my head around it. Instead if you inherit from mssql-db-object or pg-db-object the db-objects will autofill single primary keys (from IDENTITY / SERIAL) Primary Key columns.

This is somewhat specific to how we design databases (most all tables have a single IDENTITY / SERIAL PK) and might not be applicable to all situations

Future

• My company Acceleration.net is a significant contributer to clsql so I hope that some of these changes can be moved upstream eventually

Authors

• Acceleration.net - Donate
• Russ Tyndall
• Nathan Bird
• Ryan Davis

;; Copyright (c) 2011 Russ Tyndall , Acceleration.net http://www.acceleration.net
;; All rights reserved.
;;
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
;;
;;  - Redistributions of source code must retain the above copyright
;;    notice, this list of conditions and the following disclaimer.
;;
;;  - Redistributions in binary form must reproduce the above copyright
;;    notice, this list of conditions and the following disclaimer in the
;;    documentation and/or other materials provided with the distribution.
;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;; A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 Systems

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

2.1 clsql-helper

License

BSD

Description

A library providing a clutch of utilities to make working with clsql easier

Version

0.1

Dependencies

• iterate
• clsql
• closer-mop
• cl-ppcre
• cl-interpol
• symbol-munger
• alexandria
• md5
• access
• collectors

Source

clsql-helper.asd (file)

Components

• package.lisp (file)
• utils.lisp (file)
• iterate-clauses.lisp (file)
• connections.lisp (file)
• date.lisp (file)
• clsql.lisp (file)
• db-object.lisp (file)
• dirty.lisp (file)
• migrations.lisp (file)
• merge.lisp (file)
• recency.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 clsql-helper.asd

Location

clsql-helper.asd

Systems

clsql-helper (system)

Packages

clsql-helper.system

3.1.2 clsql-helper/package.lisp

Parent

clsql-helper (system)

Location

package.lisp

Packages

clsql-helper

3.1.3 clsql-helper/utils.lisp

Dependency

package.lisp (file)

Parent

clsql-helper (system)

Location

utils.lisp

Exported Definitions

• *command-log-stream* (special variable)
• *connection-settings* (special variable)
• +a-day+ (special variable)
• +a-minute+ (special variable)
• +a-month+ (special variable)
• +a-negative-day+ (special variable)
• +a-negative-hour+ (special variable)
• +a-negative-minute+ (special variable)
• +a-negative-month+ (special variable)
• +a-negative-second+ (special variable)
• +a-negative-year+ (special variable)
• +a-second+ (special variable)
• +a-year+ (special variable)
• +an-hour+ (special variable)

Internal Definitions

• *clsql-codebase-loaded* (special variable)
• *default-log-fn* (special variable)
• *record-this-dirty-slot* (special variable)
• +common-white-space-trimbag+ (special variable)
• relaxed-parse-float (generic function)
• relaxed-parse-float (method)
• trim-and-nullify (function)
• trim-whitespace (function)

3.1.4 clsql-helper/iterate-clauses.lisp

Dependency

utils.lisp (file)

Parent

clsql-helper (system)

Location

iterate-clauses.lisp

Internal Definitions

• %coerce-to-step (generic function)
• %coerce-to-step (method)
• %date-test-fn-finder (function)
• %date-test-form (function)
• clause-for-from-date-1 (function)
• clause-for-from-date-thru-5 (function)
• clause-for-from-date-to-3 (function)
• clause-for-from-datetime-2 (function)
• clause-for-from-datetime-thru-6 (function)
• clause-for-from-datetime-to-4 (function)

3.1.5 clsql-helper/connections.lisp

Dependency

iterate-clauses.lisp (file)

Parent

clsql-helper (system)

Location

connections.lisp

Exported Definitions

• *connection-database* (special variable)
• add-connection-spec (function)
• find-active-connection-name (function)
• find-any-active-connection-name (function)
• find-any-connection (function)
• find-connection (function)
• get-connection-spec (function)
• new-connection-database (function)
• remove-connection-spec (function)
• with-a-database (macro)
• with-a-database-context (function)
• with-a-transaction (macro)
• with-a-transaction-context (function)
• with-database (macro)
• with-database-context (function)
• with-database-function (function)
• with-transaction-context (function)

Internal Definitions

• %call-perhaps-logged (function)
• *inner-transaction-error* (special variable)
• *thread-local-transaction-catch-tag* (special variable)
• coerce-connection-spec (function)
• commit (condition)
• connection-database (class)
• maybe-call (function)
• names->conn (method)
• (setf names->conn) (method)
• names->spec (method)
• (setf names->spec) (method)
• rollback (condition)
• same-database-connection? (function)

3.1.6 clsql-helper/date.lisp

Dependency

connections.lisp (file)

Parent

clsql-helper (system)

Location

date.lisp

Exported Definitions

• after-day-of-month (function)
• before-day-of-month (function)
• clsql-date/times->utime (function)
• clsql-datetime-equal (function)
• convert-to-clsql-date (generic function)
• convert-to-clsql-date (method)
• convert-to-clsql-date! (macro)
• convert-to-clsql-datetime (generic function)
• convert-to-clsql-datetime (method)
• convert-to-clsql-datetime! (macro)
• current-sql-date (function)
• current-sql-time (function)
• date-add (function)
• date-day (generic function)
• date-day (method)
• date-diff (function)
• date-month (generic function)
• date-month (method)
• date-year (generic function)
• date-year (method)
• day-after (function)
• day-before (function)
• days-in-month (function)
• dt< (function)
• dt<= (function)
• dt> (function)
• dt>= (function)
• first-of-next-month (function)
• first-of-the-month (function)
• first-of-the-month? (function)
• iso8601-datestamp (generic function)
• iso8601-datestamp (method)
• iso8601-timestamp (generic function)
• iso8601-timestamp (method)
• last-month (function)
• last-of-the-month (function)
• last-of-the-month? (function)
• month-day-string (function)
• month-string (function)
• next-month (function)
• print-nullable-date (function)
• print-nullable-datetime (function)
• print-timestamp (function)

Internal Definitions

• *iso8601-date-separator* (special variable)
• *iso8601-date-time-separator* (special variable)
• *iso8601-microseconds* (special variable)
• *iso8601-time-separator* (special variable)
• *iso8601-timezone* (special variable)
• +date-sep+ (special variable)
• +date-time-regex+ (special variable)
• +iso-8601-ish-regex+ (special variable)
• +iso-8601-ish-regex-string+ (special variable)

3.1.7 clsql-helper/clsql.lisp

Dependency

date.lisp (file)

Parent

clsql-helper (system)

Location

clsql.lisp

Exported Definitions

• by-col (generic function)
• by-col (method)
• by-id (generic function)
• by-id (method)
• clsql-and (function)
• clsql-ands (function)
• clsql-column-name (function)
• clsql-exp (function)
• clsql-get-val (function)
• clsql-or (function)
• clsql-ors (function)
• coerce-value-to-db-type (method)
• column-name-string (function)
• db-eql (generic function)
• db-eql (method)
• db-exec (function)
• db-null (function)
• db-null! (macro)
• db-objs (function)
• db-objs-select (function)
• db-query (function)
• db-query-plists (function)
• db-scalar (function)
• db-select (function)
• db-select-first (function)
• db-select-scalar (function)
• db-string (function)
• db-type-from-lisp-type (function)
• format-value-for-database (function)
• identity-slot? (method)
• join-slot? (function)
• list-of-db-strings (function)
• log-database-command (macro)
• make-instance-plist (function)
• make-instances (function)
• make-instances-setting-access (function)
• make-instances-setting-accessors (function)
• new-object-p (generic function)
• new-object-p (method)
• pretty-print-sql (function)
• primary-key-column-names (function)
• primary-key-slot (function)
• primary-key-slot-names (function)
• primary-key-slots (function)
• primary-key-value (function)
• primary-key-where-clauses (function)
• save! (generic function)
• save! (method)
• save! (method)
• save-failed (condition)
• table-name-exp (function)
• table-name-string (function)
• type-coercion-error (function)
• type-coercion-error (condition)
• with-command-logging (macro)
• with-command-logging-to-string (macro)

Internal Definitions

• %clsql-subclauses (function)
• %coerce-rows (function)
• %command-if-needed (function)
• %log-fn-perhaps (function)
• coerce-to-db-string-representation (generic function)
• coerce-to-db-string-representation (method)
• db-object-has-no-keys (condition)
• db-object-key-slots (generic function)
• db-object-key-slots (method)
• default-log-fn (function)
• error-db-obj-has-no-keys (function)
• log-database-command-fn (function)
• make-instances-setting-slot-values (function)
• message (method)
• (setf message) (method)
• message (method)
• (setf message) (method)
• obj (method)
• (setf obj) (method)
• string-to-boolean (function)
• to-type (method)
• (setf to-type) (method)
• val (method)
• (setf val) (method)
• warn-db-obj-has-no-keys (function)

3.1.8 clsql-helper/db-object.lisp

Dependency

clsql.lisp (file)

Parent

clsql-helper (system)

Location

db-object.lisp

Exported Definitions

• db-object (class)
• fill-identifier! (method)
• has-db-data-to-store? (function)
• mssql-db-object (class)
• next-identifier (method)
• next-identifier-sql (generic function)
• next-identifier-sql (method)
• next-identifier-sql (method)
• next-identifier-sql (method)
• pg-db-object (class)
• slot-db-stored? (function)
• sqlite3-db-object (class)

Internal Definitions

mssql-db-view (class)

3.1.9 clsql-helper/dirty.lisp

Dependency

db-object.lisp (file)

Parent

clsql-helper (system)

Location

dirty.lisp

Exported Definitions

• dirty-db-slots-mixin (class)
• dirty-slots (method)
• (setf dirty-slots) (method)
• dirty-test (method)
• (setf dirty-test) (method)
• fill-identifier! (method)
• find-dirty-test (function)
• slot-dirty? (generic function)
• slot-dirty? (method)

Internal Definitions

• %dirty-before (function)
• defmethod-when-possible (macro)
• dirty-slot (class)
• make-dirty-slot (function)
• new-value (method)
• (setf new-value) (method)
• old-value (method)
• (setf old-value) (method)
• reset-dirty (function)
• slot-name (method)
• (setf slot-name) (method)

3.1.10 clsql-helper/migrations.lisp

Dependency

dirty.lisp (file)

Parent

clsql-helper (system)

Location

migrations.lisp

Exported Definitions

• *migration-table-name* (special variable)
• migrations (method)

Internal Definitions

• %default-migrations (function)
• %migration-done-p (function)
• %sql-hash (function)
• command (method)
• ensure-migration-table (function)
• hash (method)
• md5-string (function)
• migrate (generic function)
• migrate (method)
• migrate (method)
• migration (class)
• migration-done-p (method)
• to-migrations (generic function)
• to-migrations (method)

3.1.11 clsql-helper/merge.lisp

Dependency

migrations.lisp (file)

Parent

clsql-helper (system)

Location

merge.lisp

Exported Definitions

• copy-instance (generic function)
• copy-instance (method)
• merge-changes (method)
• merge-conflict (condition)
• merge-conflicts (condition)
• merging-values (condition)

Internal Definitions

• *default-object-diff-ignore-list* (special variable)
• already-saved (method)
• (setf already-saved) (method)
• conflicts (method)
• (setf conflicts) (method)
• from (method)
• (setf from) (method)
• object-diff-equals (method)
• object-diff-list (method)
• old-value (method)
• (setf old-value) (method)
• pending-value (method)
• (setf pending-value) (method)
• saved-value (method)
• (setf saved-value) (method)
• slot (method)
• (setf slot) (method)
• slot (method)
• (setf slot) (method)
• target (method)
• (setf target) (method)
• value (method)
• (setf value) (method)

3.1.12 clsql-helper/recency.lisp

Dependency

merge.lisp (file)

Parent

clsql-helper (system)

Location

recency.lisp

Exported Definitions

• %retrieved-at (method)
• (setf %retrieved-at) (method)
• current-timestamp (function)
• recency-error (condition)
• recency-mixin (class)
• save! (method)

Internal Definitions

• %after-update-recency-check (function)
• %before-update-recency-check (function)
• %history-select-fn (method)
• (setf %history-select-fn) (method)
• current-timestamp-sql (function)
• get-history-info (generic function)
• get-history-info (method)
• history-info (method)
• (setf history-info) (method)
• instance (method)
• (setf instance) (method)
• most-recent-history-date (function)
• validate-recency (generic function)
• validate-recency (method)

4 Packages

Packages are listed by definition order.

4.1 clsql-helper.system

Source

clsql-helper.asd

Use List

• asdf/interface
• common-lisp

4.2 clsql-helper

Source

package.lisp (file)

Use List

• iterate
• common-lisp-user
• common-lisp

Exported Definitions

• %retrieved-at (generic function)
• %retrieved-at (method)
• (setf %retrieved-at) (method)
• (setf %retrieved-at) (generic function)
• *command-log-stream* (special variable)
• *connection-database* (special variable)
• *connection-settings* (special variable)
• *migration-table-name* (special variable)
• +a-day+ (special variable)
• +a-minute+ (special variable)
• +a-month+ (special variable)
• +a-negative-day+ (special variable)
• +a-negative-hour+ (special variable)
• +a-negative-minute+ (special variable)
• +a-negative-month+ (special variable)
• +a-negative-second+ (special variable)
• +a-negative-year+ (special variable)
• +a-second+ (special variable)
• +a-year+ (special variable)
• +an-hour+ (special variable)
• add-connection-spec (function)
• after-day-of-month (function)
• before-day-of-month (function)
• by-col (generic function)
• by-col (method)
• by-id (generic function)
• by-id (method)
• clsql-and (function)
• clsql-ands (function)
• clsql-column-name (function)
• clsql-date/times->utime (function)
• clsql-datetime-equal (function)
• clsql-exp (function)
• clsql-get-val (function)
• clsql-or (function)
• clsql-ors (function)
• coerce-value-to-db-type (generic function)
• coerce-value-to-db-type (method)
• column-name-string (function)
• convert-to-clsql-date (generic function)
• convert-to-clsql-date (method)
• convert-to-clsql-date! (macro)
• convert-to-clsql-datetime (generic function)
• convert-to-clsql-datetime (method)
• convert-to-clsql-datetime! (macro)
• copy-instance (generic function)
• copy-instance (method)
• current-sql-date (function)
• current-sql-time (function)
• current-timestamp (function)
• date-add (function)
• date-day (generic function)
• date-day (method)
• date-diff (function)
• date-month (generic function)
• date-month (method)
• date-year (generic function)
• date-year (method)
• day-after (function)
• day-before (function)
• days-in-month (function)
• db-eql (generic function)
• db-eql (method)
• db-exec (function)
• db-null (function)
• db-null! (macro)
• db-object (class)
• db-objs (function)
• db-objs-select (function)
• db-query (function)
• db-query-plists (function)
• db-scalar (function)
• db-select (function)
• db-select-first (function)
• db-select-scalar (function)
• db-string (function)
• db-type-from-lisp-type (function)
• dirty-db-slots-mixin (class)
• dirty-slots (generic function)
• dirty-slots (method)
• (setf dirty-slots) (method)
• (setf dirty-slots) (generic function)
• dirty-test (generic function)
• dirty-test (method)
• (setf dirty-test) (method)
• (setf dirty-test) (generic function)
• dt< (function)
• dt<= (function)
• dt> (function)
• dt>= (function)
• fill-identifier! (generic function)
• fill-identifier! (method)
• fill-identifier! (method)
• find-active-connection-name (function)
• find-any-active-connection-name (function)
• find-any-connection (function)
• find-connection (function)
• find-dirty-test (function)
• first-of-next-month (function)
• first-of-the-month (function)
• first-of-the-month? (function)
• format-value-for-database (function)
• get-connection-spec (function)
• has-db-data-to-store? (function)
• identity-slot? (generic function)
• identity-slot? (method)
• iso8601-datestamp (generic function)
• iso8601-datestamp (method)
• iso8601-timestamp (generic function)
• iso8601-timestamp (method)
• join-slot? (function)
• last-month (function)
• last-of-the-month (function)
• last-of-the-month? (function)
• list-of-db-strings (function)
• log-database-command (macro)
• make-instance-plist (function)
• make-instances (function)
• make-instances-setting-access (function)
• make-instances-setting-accessors (function)
• merge-changes (generic function)
• merge-changes (method)
• merge-conflict (condition)
• merge-conflicts (condition)
• merging-values (condition)
• migrations (generic function)
• migrations (method)
• month-day-string (function)
• month-string (function)
• mssql-db-object (class)
• new-connection-database (function)
• new-object-p (generic function)
• new-object-p (method)
• next-identifier (generic function)
• next-identifier (method)
• next-identifier-sql (generic function)
• next-identifier-sql (method)
• next-identifier-sql (method)
• next-identifier-sql (method)
• next-month (function)
• pg-db-object (class)
• pretty-print-sql (function)
• primary-key-column-names (function)
• primary-key-slot (function)
• primary-key-slot-names (function)
• primary-key-slots (function)
• primary-key-value (function)
• primary-key-where-clauses (function)
• print-nullable-date (function)
• print-nullable-datetime (function)
• print-timestamp (function)
• recency-error (condition)
• recency-mixin (class)
• remove-connection-spec (function)
• save! (generic function)
• save! (method)
• save! (method)
• save! (method)
• save-failed (condition)
• slot-db-stored? (function)
• slot-dirty? (generic function)
• slot-dirty? (method)
• sqlite3-db-object (class)
• table-name-exp (function)
• table-name-string (function)
• type-coercion-error (function)
• type-coercion-error (condition)
• with-a-database (macro)
• with-a-database-context (function)
• with-a-transaction (macro)
• with-a-transaction-context (function)
• with-command-logging (macro)
• with-command-logging-to-string (macro)
• with-database (macro)
• with-database-context (function)
• with-database-function (function)
• with-transaction-context (function)

Internal Definitions

• %after-update-recency-check (function)
• %before-update-recency-check (function)
• %call-perhaps-logged (function)
• %clsql-subclauses (function)
• %coerce-rows (function)
• %coerce-to-step (generic function)
• %coerce-to-step (method)
• %command-if-needed (function)
• %date-test-fn-finder (function)
• %date-test-form (function)
• %default-migrations (function)
• %dirty-before (function)
• %history-select-fn (generic function)
• %history-select-fn (method)
• (setf %history-select-fn) (method)
• (setf %history-select-fn) (generic function)
• %log-fn-perhaps (function)
• %migration-done-p (function)
• %sql-hash (function)
• *clsql-codebase-loaded* (special variable)
• *default-log-fn* (special variable)
• *default-object-diff-ignore-list* (special variable)
• *inner-transaction-error* (special variable)
• *iso8601-date-separator* (special variable)
• *iso8601-date-time-separator* (special variable)
• *iso8601-microseconds* (special variable)
• *iso8601-time-separator* (special variable)
• *iso8601-timezone* (special variable)
• *record-this-dirty-slot* (special variable)
• *thread-local-transaction-catch-tag* (special variable)
• +common-white-space-trimbag+ (special variable)
• +date-sep+ (special variable)
• +date-time-regex+ (special variable)
• +iso-8601-ish-regex+ (special variable)
• +iso-8601-ish-regex-string+ (special variable)
• already-saved (generic function)
• already-saved (method)
• (setf already-saved) (method)
• (setf already-saved) (generic function)
• clause-for-from-date-1 (function)
• clause-for-from-date-thru-5 (function)
• clause-for-from-date-to-3 (function)
• clause-for-from-datetime-2 (function)
• clause-for-from-datetime-thru-6 (function)
• clause-for-from-datetime-to-4 (function)
• coerce-connection-spec (function)
• coerce-to-db-string-representation (generic function)
• coerce-to-db-string-representation (method)
• command (generic function)
• command (method)
• commit (condition)
• conflicts (generic function)
• conflicts (method)
• (setf conflicts) (method)
• (setf conflicts) (generic function)
• connection-database (class)
• current-timestamp-sql (function)
• db-object-has-no-keys (condition)
• db-object-key-slots (generic function)
• db-object-key-slots (method)
• default-log-fn (function)
• defmethod-when-possible (macro)
• dirty-slot (class)
• ensure-migration-table (function)
• error-db-obj-has-no-keys (function)
• from (generic function)
• from (method)
• (setf from) (method)
• (setf from) (generic function)
• get-history-info (generic function)
• get-history-info (method)
• hash (generic function)
• hash (method)
• history-info (generic function)
• history-info (method)
• (setf history-info) (method)
• (setf history-info) (generic function)
• instance (generic function)
• instance (method)
• (setf instance) (method)
• (setf instance) (generic function)
• log-database-command-fn (function)
• make-dirty-slot (function)
• make-instances-setting-slot-values (function)
• maybe-call (function)
• md5-string (function)
• message (generic function)
• message (method)
• (setf message) (method)
• message (method)
• (setf message) (method)
• (setf message) (generic function)
• migrate (generic function)
• migrate (method)
• migrate (method)
• migration (class)
• migration-done-p (generic function)
• migration-done-p (method)
• most-recent-history-date (function)
• mssql-db-view (class)
• names->conn (generic function)
• names->conn (method)
• (setf names->conn) (method)
• (setf names->conn) (generic function)
• names->spec (generic function)
• names->spec (method)
• (setf names->spec) (method)
• (setf names->spec) (generic function)
• new-value (generic function)
• new-value (method)
• (setf new-value) (method)
• (setf new-value) (generic function)
• obj (generic function)
• obj (method)
• (setf obj) (method)
• (setf obj) (generic function)
• object-diff-equals (generic function)
• object-diff-equals (method)
• object-diff-list (generic function)
• object-diff-list (method)
• old-value (generic function)
• old-value (method)
• (setf old-value) (method)
• old-value (method)
• (setf old-value) (method)
• (setf old-value) (generic function)
• pending-value (generic function)
• pending-value (method)
• (setf pending-value) (method)
• (setf pending-value) (generic function)
• relaxed-parse-float (generic function)
• relaxed-parse-float (method)
• reset-dirty (function)
• rollback (condition)
• same-database-connection? (function)
• saved-value (generic function)
• saved-value (method)
• (setf saved-value) (method)
• (setf saved-value) (generic function)
• slot (generic function)
• slot (method)
• (setf slot) (method)
• slot (method)
• (setf slot) (method)
• (setf slot) (generic function)
• slot-name (generic function)
• slot-name (method)
• (setf slot-name) (method)
• (setf slot-name) (generic function)
• string-to-boolean (function)
• target (generic function)
• target (method)
• (setf target) (method)
• (setf target) (generic function)
• to-migrations (generic function)
• to-migrations (method)
• to-type (generic function)
• to-type (method)
• (setf to-type) (method)
• (setf to-type) (generic function)
• trim-and-nullify (function)
• trim-whitespace (function)
• val (generic function)
• val (method)
• (setf val) (method)
• (setf val) (generic function)
• validate-recency (generic function)
• validate-recency (method)
• value (generic function)
• value (method)
• (setf value) (method)
• (setf value) (generic function)
• warn-db-obj-has-no-keys (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *command-log-stream*

a stream that we will record sql commands to in the body of

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: *connection-database*

A variable that when bound to a connection-database object will look up

Package

clsql-helper

Source

connections.lisp (file)

Special Variable: *connection-settings*

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: *migration-table-name*

the table name to use for migrations

Package

clsql-helper

Source

migrations.lisp (file)

Special Variable: +a-day+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-minute+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-month+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-negative-day+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-negative-hour+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-negative-minute+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-negative-month+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-negative-second+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-negative-year+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-second+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +a-year+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +an-hour+

Package

clsql-helper

Source

utils.lisp (file)

5.1.2 Macros

Macro: convert-to-clsql-date! &rest PLACES

Package

clsql-helper

Source

date.lisp (file)

Macro: convert-to-clsql-datetime! &rest PLACES

Package

clsql-helper

Source

date.lisp (file)

Macro: db-null! &rest PLACES

Package

clsql-helper

Source

clsql.lisp (file)

Macro: log-database-command (&optional LOG-FN-NAME DATABASE) &body BODY

MUST BE Inside a database connection, creates a lexical scope in which all sql commands executed on this connection are logged to a specific logger

tries to format such that it will be readable in the log

log-fn-name is a function/macro name that will be called with a string/array as (log-fn-name stuff)

Package

clsql-helper

Source

clsql.lisp (file)

Macro: with-a-database (&optional CONNECTION-SETTINGS &key POST-CONNECT-FN LOG) &body BODY

If a database connection exists and it matches the passed in settings or the passed in settings are null, use it!, otherwise aquire a new database connection

Package

clsql-helper

Source

connections.lisp (file)

Macro: with-a-transaction (&key DATABASE) &body BODY

Wrapper around clsql:with-transaction, when a rollback is issued the code escapes (throw) to the outermost with-a-transaction.

without the catch, its possible for an error handler in an intermediate function

Package

clsql-helper

Source

connections.lisp (file)

Macro: with-command-logging (&key DATABASE) &body BODY

record commands to the *command-log-stream* for the duration of body then restore its previous binding

Package

clsql-helper

Source

clsql.lisp (file)

Macro: with-command-logging-to-string (&key STRING DATABASE) &body BODY

Log the sql commands of the body to a string

Package

clsql-helper

Source

clsql.lisp (file)

Macro: with-database (&optional CONNECTION-SETTINGS &key POST-CONNECT-FN LOG) &body BODY

opens a database connection and executes the body

connect-settings: a plist of connection info for clsql, also supports :post-connect-fn, a function to run after opening the connection

post-connect-fn: a function of no arguments to run after opening the connection

Package

clsql-helper

Source

connections.lisp (file)

5.1.3 Functions

Function: add-connection-spec NAME SPEC &key DB

Package

clsql-helper

Source

connections.lisp (file)

Function: after-day-of-month DATE DAY

Are we past a specific day of the month

Package

clsql-helper

Source

date.lisp (file)

Function: before-day-of-month DATE DAY

Are we past a specific day of the month

Package

clsql-helper

Source

date.lisp (file)

Function: clsql-and &rest CLAUSES

returns a CLSQL:SQL-AND for all non-nil clauses, no nil if there are no non-nil clauses

Package

clsql-helper

Source

clsql.lisp (file)

Function: clsql-ands CLAUSES

Package

clsql-helper

Source

clsql.lisp (file)

Function: clsql-column-name COLUMN &optional TABLE

Package

clsql-helper

Source

clsql.lisp (file)

Function: clsql-date/times->utime OBJ &optional TIMEZONE

obj is either a wall-time or a date in local time. Converts to UTC and returns a utime.

pass timezone nil to skip UTC conversion.

if you are looking for the other it is clsql-sys:utime->time

Package

clsql-helper

Source

date.lisp (file)

Function: clsql-datetime-equal X Y

Tries to handle full datetime equality reguardless of the format (string datestamp, date, datetime, utime)

Package

clsql-helper

Source

date.lisp (file)

Function: clsql-exp S

Package

clsql-helper

Source

clsql.lisp (file)

Function: clsql-get-val SQL &key LOG

alias of get-scalar

Package

clsql-helper

Source

clsql.lisp (file)

Function: clsql-or &rest CLAUSES

returns a CLSQL:SQL-AND for all non-nil clauses, no nil if there are no non-nil clauses

Package

clsql-helper

Source

clsql.lisp (file)

Function: clsql-ors CLAUSES

returns a CLSQL:SQL-AND for all non-nil clauses, no nil if there are no non-nil clauses

Package

clsql-helper

Source

clsql.lisp (file)

Function: column-name-string COLUMN

Package

clsql-helper

Source

clsql.lisp (file)

Function: current-sql-date ()

current date

Package

clsql-helper

Source

date.lisp (file)

Function: current-sql-time ()

current date and time

Package

clsql-helper

Source

date.lisp (file)

Function: current-timestamp ()

Package

clsql-helper

Source

recency.lisp (file)

Function: date-add D DUR

Package

clsql-helper

Source

date.lisp (file)

Function: date-diff D1 D2

Gets the difference in days between two dates
returns a negative number to indicate that d1 is after d2 returns a positive number to indicate that d2 is after d1

Package

clsql-helper

Source

date.lisp (file)

Function: day-after &optional DATE

Package

clsql-helper

Source

date.lisp (file)

Function: day-before &optional DATE

Package

clsql-helper

Source

date.lisp (file)

Function: days-in-month &optional DATE

Return the number of days in the month of the date passed in

Package

clsql-helper

Source

date.lisp (file)

Function: db-exec CMD &key PARAMS LOG

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-null IT

Returns a value or the string null

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-objs CLASS CMD &key PARAMS MAKE-INSTANCES-FN LOG COERCE-ROWS? COLUMN-MUNGER

retrieve objects of type class from the database using db-query

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-objs-select CLASS COLUMNS &key SELECT-ARGS MAKE-INSTANCES-FN

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-query CMD &rest KEYS &key PARAMS LOG &allow-other-keys

runs a db query

sets :flatp to t
if params are provided we build a command object (backend better support this)

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-query-plists CMD &rest KEYS &key PARAMS LOG

Returns a list of plists that correspond to the query results

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-scalar CMD &rest KEYS &key PARAMS LOG

Query a single value from the database

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-select &rest SELECT-ARGS &aux LOG

Runs a clsql:select

defaulting to :flatp T
unnests any lists as part of the select list

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-select-first &rest SELECT-ARGS

query a single row / value from the database using clsql:select

alias with db-select-scalar

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-select-scalar &rest SELECT-ARGS

query a single row / value from the database using clsql:select

alias with db-select-first which was deemed more aptly named when selecting a row

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-string S &key PREFIX POSTFIX WRAPPER

trims, nullifies, escapes and wraps in single quotes so that the string is ready to be spliced into a query (eg: with cl-interpol). returns ’foo’ or NIL.

Package

clsql-helper

Source

clsql.lisp (file)

Function: db-type-from-lisp-type TYPE &key LENGTH SCALE PG-DEFAULT-INT-TYPE

Package

clsql-helper

Source

clsql.lisp (file)

Function: dt< &rest D

Package

clsql-helper

Source

date.lisp (file)

Function: dt<= &rest D

Package

clsql-helper

Source

date.lisp (file)

Function: dt> &rest D

Package

clsql-helper

Source

date.lisp (file)

Function: dt>= &rest D

Package

clsql-helper

Source

date.lisp (file)

Function: find-active-connection-name NAME &key (DB *CONNECTION-DATABASE*)

Package

clsql-helper

Source

connections.lisp (file)

Function: find-any-active-connection-name NAMES &key (DB *CONNECTION-DATABASE*)

Package

clsql-helper

Source

connections.lisp (file)

Function: find-any-connection NAMES &key (DB *CONNECTION-DATABASE*)

Package

clsql-helper

Source

connections.lisp (file)

Function: find-connection NAME &key (DB *CONNECTION-DATABASE*)

Package

clsql-helper

Source

connections.lisp (file)

Function: find-dirty-test O SLOT-NAME

Package

clsql-helper

Source

dirty.lisp (file)

Function: first-of-next-month &optional DATE

Package

clsql-helper

Source

date.lisp (file)

Function: first-of-the-month &optional DATE

returns the first of the month for the month/year of the date passed in

Package

clsql-helper

Source

date.lisp (file)

Function: first-of-the-month? &optional DATE

returns whether or not the date passed in is the first of the month

Package

clsql-helper

Source

date.lisp (file)

Function: format-value-for-database D &optional STREAM

prints a correctly sql escaped value for postgres

Package

clsql-helper

Source

clsql.lisp (file)

Function: get-connection-spec NAME-OR-SPEC &key DB

Package

clsql-helper

Source

connections.lisp (file)

Function: has-db-data-to-store? IT &key EXCLUDE

Package

clsql-helper

Source

db-object.lisp (file)

Function: join-slot? SLOT-DEF

Package

clsql-helper

Source

clsql.lisp (file)

Function: last-month &optional DATE &aux ORIG

Package

clsql-helper

Source

date.lisp (file)

Function: last-of-the-month START-DATE &aux MONTH

Returns the first of next month eg: 2/14/2012->2/29/2012

Package

clsql-helper

Source

date.lisp (file)

Function: last-of-the-month? START-DATE

Returns T if its the last day of the month

Package

clsql-helper

Source

date.lisp (file)

Function: list-of-db-strings LIST

For use in creating ‘column IN (${stuff})‘ type of clauses

Package

clsql-helper

Source

clsql.lisp (file)

Function: make-instance-plist COLUMNS ROW

Creates a plist intended to be passed to make-instance

Package

clsql-helper

Source

clsql.lisp (file)

Function: make-instances CLASS COLUMNS ROWS

From N rows and some column-names make N instances of class filling data from rows using make instance

Package

clsql-helper

Source

clsql.lisp (file)

Function: make-instances-setting-access CLASS COLUMNS ROWS

From N rows and column-name make N instances of class filling data from rows by creating instances and setting through access lib

Package

clsql-helper

Source

clsql.lisp (file)

Function: make-instances-setting-accessors CLASS COLUMNS ROWS

From N rows and column-name make N instances of class filling data from rows by creating instances and setting existing accessor functions

Package

clsql-helper

Source

clsql.lisp (file)

Function: month-day-string D

prints dates as January 3

Package

clsql-helper

Source

date.lisp (file)

Function: month-string D

Converts the date to the full name, January, February,etc

Package

clsql-helper

Source

date.lisp (file)

Function: new-connection-database &key DB NAME NEW-CONNECTION

Package

clsql-helper

Source

connections.lisp (file)

Function: next-month &optional DATE &aux ORIG

Package

clsql-helper

Source

date.lisp (file)

Function: pretty-print-sql SQL-COMMAND

Package

clsql-helper

Source

clsql.lisp (file)

Function: primary-key-column-names OBJ

Package

clsql-helper

Source

clsql.lisp (file)

Function: primary-key-slot OBJ

Package

clsql-helper

Source

clsql.lisp (file)

Function: primary-key-slot-names OBJ

Package

clsql-helper

Source

clsql.lisp (file)

Function: primary-key-slots OBJ

Package

clsql-helper

Source

clsql.lisp (file)

Function: primary-key-value OBJ

Package

clsql-helper

Source

clsql.lisp (file)

Function: primary-key-where-clauses OBJ &aux SLOTS

Generates a where clause based on all of the primary keys of the object ex: pk1 = val1 and pk2 = val2 ...

Package

clsql-helper

Source

clsql.lisp (file)

Function: print-nullable-date FIELD

if the date exists, prints m?m/d?d/yyyy

Package

clsql-helper

Source

date.lisp (file)

Function: print-nullable-datetime FIELD

if the date exists, prints mm/dd/yyyy hh:mm:ss

Package

clsql-helper

Source

date.lisp (file)

Function: print-timestamp FIELD

if the date exists, prints yyyy-mm-dd hh:mm:ss.uuuuuu

Package

clsql-helper

Source

date.lisp (file)

Function: remove-connection-spec NAME &key DB

Package

clsql-helper

Source

connections.lisp (file)

Function: slot-db-stored? SLOT-DEF &key KINDS

Package

clsql-helper

Source

db-object.lisp (file)

Function: table-name-exp TABLE-NAME

based on what is passed in, tries to figure out what the table name is

Package

clsql-helper

Source

clsql.lisp (file)

Function: table-name-string TABLE-NAME

Package

clsql-helper

Source

clsql.lisp (file)

Function: type-coercion-error VAL TO-TYPE

Package

clsql-helper

Source

clsql.lisp (file)

Function: with-a-database-context BODY-FN &key CONNECTION-SETTINGS DB POST-CONNECT-FN LOG &aux EXISTING-CONNECTION *CONNECTION-SETTINGS* *CONNECTION-DATABASE*

If a database connection exists and it matches the passed in settings or the passed in settings are null, use it!, otherwise aquire a new database connection

Package

clsql-helper

Source

connections.lisp (file)

Function: with-a-transaction-context BODY-FN DATABASE

Either establish a new transaction context (with-transaction-context) or run the body in the extisting transaction context

Package

clsql-helper

Source

connections.lisp (file)

Function: with-database-context BODY-FN &key CONNECTION-SETTINGS DB POST-CONNECT-FN LOG &aux *CONNECTION-SETTINGS* *CONNECTION-DATABASE*

opens a database connection with the given settings, and runs the function.

connect-settings: a plist of connection info for clsql, also supports :post-connect-fn, a function to run after opening the connection

post-connect-fn: a function of no arguments to run after opening the connection

Package

clsql-helper

Source

connections.lisp (file)

Function: with-database-function FN CONNECT-SETTINGS &key POST-CONNECT-FN LOG

Alias of with-database-context for backwards compatability
Creates a context inside which *default-database* is bound and runs the fn inside it

Package

clsql-helper

Source

connections.lisp (file)

Function: with-transaction-context BODY-FN DATABASE

Establish a context for enlisting in transactions and run the body in a new transaction

Package

clsql-helper

Source

connections.lisp (file)

5.1.4 Generic functions

Generic Function: %retrieved-at OBJECT

Generic Function: (setf %retrieved-at) NEW-VALUE OBJECT

Package

clsql-helper

Methods

Method: %retrieved-at (RECENCY-MIXIN recency-mixin)

Method: (setf %retrieved-at) NEW-VALUE (RECENCY-MIXIN recency-mixin)

The Server time this was retrieved from the database
Named this way to reduce conflict likely hood with database columns

Source

recency.lisp (file)

Generic Function: by-col CLASS COLUMN COLVALUE

fetchs the first row for the given class by id

Package

clsql-helper

Source

clsql.lisp (file)

Methods

Method: by-col CLASS COLUMN COLVALUE

Generic Function: by-id CLASS ID &optional COLNAME

Fetchs the first row for the given class by id

Package

clsql-helper

Source

clsql.lisp (file)

Methods

Method: by-id CLASS ID &optional COLNAME

direct implementation of by-id, (select class). fetchs the first row for the given class by id

Generic Function: coerce-value-to-db-type VAL DB-TYPE

Package

clsql-helper

Methods

Method: coerce-value-to-db-type VAL DB-TYPE

Coerces a value to the correct db-type

if the conversion fails signals a continueable type-coercion-error (use-value is also available)

returns (values val coerced?)
the coerced value and whether or not a coersion took place

Source

clsql.lisp (file)

Generic Function: convert-to-clsql-date VAL

Convert your value into a clsql:date structure

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: convert-to-clsql-date VAL

Generic Function: convert-to-clsql-datetime VAL

Converts a string timestamp into a clsql date time object

Makes every possible effort to understand your date that will invariably be in some format it wont understand.

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: convert-to-clsql-datetime VAL

Generic Function: copy-instance I

Makes a copy of an instance via allocate instance then copies all slot-values and calls reinitialize-instance

Package

clsql-helper

Source

merge.lisp (file)

Methods

Method: copy-instance I

Generic Function: date-day D

Given an object that encodes a date, return the day component

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: date-day D

Generic Function: date-month D

Given an object that encodes a date, return the month component

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: date-month D

Generic Function: date-year D

Given an object that encodes a date, return the year component

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: date-year D

Generic Function: db-eql X Y &key TEST

Tries to determine if the objects are of the same type and have the same primary key values
Many times objects which pass new-objectp are db-eql ,but once saved are no longer db-eql (due to using serial pkey)

Package

clsql-helper

Source

clsql.lisp (file)

Methods

Method: db-eql X Y &key TEST

Generic Function: dirty-slots OBJECT

Generic Function: (setf dirty-slots) NEW-VALUE OBJECT

Package

clsql-helper

Methods

Method: dirty-slots (DIRTY-DB-SLOTS-MIXIN dirty-db-slots-mixin)

automatically generated reader method

Source

dirty.lisp (file)

Method: (setf dirty-slots) NEW-VALUE (DIRTY-DB-SLOTS-MIXIN dirty-db-slots-mixin)

automatically generated writer method

Source

dirty.lisp (file)

Generic Function: dirty-test OBJECT

Generic Function: (setf dirty-test) NEW-VALUE OBJECT

Package

clsql-helper

Methods

Method: dirty-test (DIRTY-DB-SLOTS-MIXIN dirty-db-slots-mixin)

automatically generated reader method

Source

dirty.lisp (file)

Method: (setf dirty-test) NEW-VALUE (DIRTY-DB-SLOTS-MIXIN dirty-db-slots-mixin)

automatically generated writer method

Source

dirty.lisp (file)

Generic Function: fill-identifier! OBJ &key DATABASE

Package

clsql-helper

Methods

Method: fill-identifier! (O dirty-db-slots-mixin) &key DATABASE around

Source

dirty.lisp (file)

Method: fill-identifier! OBJ &key DATABASE &aux KEY-SLOTS

fill the id field on the object with the appropriate next-identifier

Source

db-object.lisp (file)

Generic Function: identity-slot? SLOT-DEF

Package

clsql-helper

Methods

Method: identity-slot? SLOT-DEF

Source

clsql.lisp (file)

Generic Function: iso8601-datestamp D

Given an object that encodes a date
return an iso8601-datestamp representation of it

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: iso8601-datestamp D

Generic Function: iso8601-timestamp D

CLSQL has a function (I wrote) to do this, but I wanted more flexibility in output so that I could use this in more situations

clsql:iso-timestamp is used only to write to database backends, so a very strict ISO is fine

Package

clsql-helper

Source

date.lisp (file)

Methods

Method: iso8601-timestamp D

Generic Function: merge-changes ORIGINAL ALREADY-SAVED PENDING

Package

clsql-helper

Methods

Method: merge-changes ORIGINAL ALREADY-SAVED PENDING

Source

merge.lisp (file)

Generic Function: migrations &rest SQL-STATEMENTS

Package

clsql-helper

Methods

Method: migrations &rest SQL-STATEMENTS

run ‘sql-statements‘ on the database once and only once. ‘sql-statements‘ can be strings, pathnames, or lists.

Source

migrations.lisp (file)

Generic Function: new-object-p OBJ

Checks that primary keys have values and that the object with those primary key values exists in the database

Package

clsql-helper

Source

clsql.lisp (file)

Methods

Method: new-object-p OBJ

Generic Function: next-identifier OBJ &key DATABASE

Package

clsql-helper

Methods

Method: next-identifier OBJ &key DATABASE

fetch the next unique identifier for this obj/database, usually the value of a autoincrement field.

Source

db-object.lisp (file)

Generic Function: next-identifier-sql OBJ &key DATABASE

returns the SQL query to run to get the next identifier. Query should return 1 row with 1 column.

Package

clsql-helper

Source

db-object.lisp (file)

Methods

Method: next-identifier-sql (OBJ sqlite3-db-object) &key DATABASE

fetch most recent AUTOINCREMENT on this connection. https://www.sqlite.org/lang_corefunc.html#last_insert_rowid

Method: next-identifier-sql (OBJ mssql-db-object) &key DATABASE

use SCOPE_IDENTITY

Method: next-identifier-sql (OBJ pg-db-object) &key DATABASE

pull the sequence value for this object’s table

Generic Function: save! DB-OBJ &key LOG ORIGNAL ORIGINAL &allow-other-keys

saves the given object, then returns the saved object

Package

clsql-helper

Source

clsql.lisp (file)

Methods

Method: save! (O recency-mixin) &key ORIGINAL &allow-other-keys

Source

recency.lisp (file)

Method: save! DB-OBJ &key LOG &allow-other-keys around

Method: save! DB-OBJ &key &allow-other-keys

Generic Function: slot-dirty? OBJECT SLOT-NAME &key ALL?

determines whether or not a slot on a given object is dirty
slot-name can be a list and all? determines if we want to not if all of them or dirty or if any of them are dirty

Package

clsql-helper

Source

dirty.lisp (file)

Methods

Method: slot-dirty? (O dirty-db-slots-mixin) SLOT-NAME &key ALL?

5.1.5 Conditions

Condition: merge-conflict ()

Package

clsql-helper

Source

merge.lisp (file)

Direct superclasses

error (condition)

Direct methods

• pending-value (method)
• pending-value (method)
• saved-value (method)
• saved-value (method)
• old-value (method)
• old-value (method)
• slot (method)
• slot (method)
• already-saved (method)
• already-saved (method)

Direct slots

Slot: already-saved

The object that was saved while we were working

Initargs

:already-saved

Initform

(quote nil)

Readers

already-saved (generic function)

Writers

(setf already-saved) (generic function)

Slot: slot

Initargs

:slot

Initform

(quote nil)

Readers

slot (generic function)

Writers

(setf slot) (generic function)

Slot: old-value

Initargs

:old-value

Initform

(quote nil)

Readers

old-value (generic function)

Writers

(setf old-value) (generic function)

Slot: saved-value

Initargs

:saved-value

Initform

(quote nil)

Readers

saved-value (generic function)

Writers

(setf saved-value) (generic function)

Slot: pending-value

Initargs

:pending-value

Initform

(quote nil)

Readers

pending-value (generic function)

Writers

(setf pending-value) (generic function)

Condition: merge-conflicts ()

Package

clsql-helper

Source

merge.lisp (file)

Direct superclasses

error (condition)

Direct methods

• conflicts (method)
• conflicts (method)

Direct slots

Slot: conflicts

Initargs

:conflicts

Initform

(quote nil)

Readers

conflicts (generic function)

Writers

(setf conflicts) (generic function)

Condition: merging-values ()

Package

clsql-helper

Source

merge.lisp (file)

Direct superclasses

condition (condition)

Direct methods

• slot (method)
• slot (method)
• value (method)
• value (method)
• from (method)
• from (method)
• target (method)
• target (method)

Direct slots

Slot: target

Initargs

:target

Initform

(quote nil)

Readers

target (generic function)

Writers

(setf target) (generic function)

Slot: from

Initargs

:from

Initform

(quote nil)

Readers

from (generic function)

Writers

(setf from) (generic function)

Slot: value

Initargs

:value

Initform

(quote nil)

Readers

value (generic function)

Writers

(setf value) (generic function)

Slot: slot

Initargs

:slot

Initform

(quote nil)

Readers

slot (generic function)

Writers

(setf slot) (generic function)

Condition: recency-error ()

Package

clsql-helper

Source

recency.lisp (file)

Direct superclasses

error (condition)

Direct methods

• history-info (method)
• history-info (method)
• instance (method)
• instance (method)

Direct slots

Slot: instance

Initargs

:instance

Initform

(quote nil)

Readers

instance (generic function)

Writers

(setf instance) (generic function)

Slot: history-info

Initargs

:history-info

Initform

(quote nil)

Readers

history-info (generic function)

Writers

(setf history-info) (generic function)

Condition: save-failed ()

Package

clsql-helper

Source

clsql.lisp (file)

Direct superclasses

error (condition)

Direct methods

• message (method)
• message (method)

Direct slots

Slot: message

Initargs

:message

Readers

message (generic function)

Writers

(setf message) (generic function)

Condition: type-coercion-error ()

Package

clsql-helper

Source

clsql.lisp (file)

Direct superclasses

error (condition)

Direct methods

• message (method)
• message (method)
• to-type (method)
• to-type (method)
• val (method)
• val (method)

Direct slots

Slot: val

Initargs

:val

Initform

(quote nil)

Readers

val (generic function)

Writers

(setf val) (generic function)

Slot: to-type

Initargs

:to-type

Initform

(quote nil)

Readers

to-type (generic function)

Writers

(setf to-type) (generic function)

Slot: message

Initargs

:message

Initform

(quote nil)

Readers

message (generic function)

Writers

(setf message) (generic function)

5.1.6 Classes

Class: db-object ()

Package

clsql-helper

Source

db-object.lisp (file)

Direct superclasses

standard-db-object (class)

Direct subclasses

• pg-db-object (class)
• mssql-db-object (class)
• mssql-db-view (class)
• sqlite3-db-object (class)
• recency-mixin (class)

Direct methods

• slot-value-using-class (method)
• update-record-from-slots (method)
• update-records-from-instance (method)
• choose-database-for-instance (method)

Class: dirty-db-slots-mixin ()

Package

clsql-helper

Source

dirty.lisp (file)

Direct superclasses

standard-db-object (class)

Direct methods

• view-classes-and-storable-slots (method)
• slot-value-using-class (method)
• update-instance-from-records (method)
• fill-identifier! (method)
• update-slot-from-db-value (method)
• get-slot-values-from-view (method)
• slot-dirty? (method)
• initialize-instance (method)
• dirty-test (method)
• dirty-test (method)
• dirty-slots (method)
• dirty-slots (method)

Direct slots

Slot: dirty-slots

Initargs

:dirty-slots

Readers

dirty-slots (generic function)

Writers

(setf dirty-slots) (generic function)

Slot: dirty-test

Initargs

:dirty-test

Initform

(sb-int:quasiquote ((t . #s(sb-impl::comma :expr (function equalp) :kind 0))))

Readers

dirty-test (generic function)

Writers

(setf dirty-test) (generic function)

Class: mssql-db-object ()

Package

clsql-helper

Source

db-object.lisp (file)

Direct superclasses

db-object (class)

Direct methods

next-identifier-sql (method)

Class: pg-db-object ()

Package

clsql-helper

Source

db-object.lisp (file)

Direct superclasses

db-object (class)

Direct methods

next-identifier-sql (method)

Class: recency-mixin ()

Package

clsql-helper

Source

recency.lisp (file)

Direct superclasses

db-object (class)

Direct methods

• save! (method)
• update-record-from-slots (method)
• update-record-from-slots (method)
• update-records-from-instance (method)
• update-records-from-instance (method)
• validate-recency (method)
• get-history-info (method)
• filter-select-list (method)
• %history-select-fn (method)
• %history-select-fn (method)
• %retrieved-at (method)
• %retrieved-at (method)

Direct slots

Slot: %retrieved-at

The Server time this was retrieved from the database
Named this way to reduce conflict likely hood with database columns

Type

(or null clsql-sys:wall-time)

Initargs

:%retrieved-at

Readers

%retrieved-at (generic function)

Writers

(setf %retrieved-at) (generic function)

Slot: %history-select-fn

a function that returns history data about an object the
first returned value MUST be the most recent time the object was saved in the database

Initargs

:%history-select-fn

Readers

%history-select-fn (generic function)

Writers

(setf %history-select-fn) (generic function)

Class: sqlite3-db-object ()

Package

clsql-helper

Source

db-object.lisp (file)

Direct superclasses

db-object (class)

Direct methods

next-identifier-sql (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *clsql-codebase-loaded*

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: *default-log-fn*

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: *default-object-diff-ignore-list*

Package

clsql-helper

Source

merge.lisp (file)

Special Variable: *inner-transaction-error*

Variable to hold conditions from internal errors, just makes for a bit cleaner code I think.

Package

clsql-helper

Source

connections.lisp (file)

Special Variable: *iso8601-date-separator*

Package

clsql-helper

Source

date.lisp (file)

Special Variable: *iso8601-date-time-separator*

Package

clsql-helper

Source

date.lisp (file)

Special Variable: *iso8601-microseconds*

Package

clsql-helper

Source

date.lisp (file)

Special Variable: *iso8601-time-separator*

Package

clsql-helper

Source

date.lisp (file)

Special Variable: *iso8601-timezone*

Package

clsql-helper

Source

date.lisp (file)

Special Variable: *record-this-dirty-slot*

Should we record this slot as dirty?

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: *thread-local-transaction-catch-tag*

Variable to hold the gensymed catch tag this thread’s with-a-transaction is using.

Package

clsql-helper

Source

connections.lisp (file)

Special Variable: +common-white-space-trimbag+

Package

clsql-helper

Source

utils.lisp (file)

Special Variable: +date-sep+

Package

clsql-helper

Source

date.lisp (file)

Special Variable: +date-time-regex+

Package

clsql-helper

Source

date.lisp (file)

Special Variable: +iso-8601-ish-regex+

Package

clsql-helper

Source

date.lisp (file)

Special Variable: +iso-8601-ish-regex-string+

Package

clsql-helper

Source

date.lisp (file)

5.2.2 Macros

Macro: defmethod-when-possible NAME ARGS &body BODY

Package

clsql-helper

Source

dirty.lisp (file)

5.2.3 Functions

Function: %after-update-recency-check O

Package

clsql-helper

Source

recency.lisp (file)

Function: %before-update-recency-check O

Package

clsql-helper

Source

recency.lisp (file)

Function: %call-perhaps-logged FN LOG &optional DATABASE

Package

clsql-helper

Source

connections.lisp (file)

Function: %clsql-subclauses CLAUSES

Package

clsql-helper

Source

clsql.lisp (file)

Function: %coerce-rows CLASS SLOT-NAMES ROWS &aux TYPES

Package

clsql-helper

Source

clsql.lisp (file)

Function: %command-if-needed CMD PARAMS

Package

clsql-helper

Source

clsql.lisp (file)

Function: %date-test-fn-finder START END &key DATE? TO?

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: %date-test-form DATE END-VAR TEST

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: %default-migrations ()

These are migrations necessary to making the system work as it upgrades

Package

clsql-helper

Source

migrations.lisp (file)

Function: %dirty-before NEW CLASS OBJECT SLOT &key OLD-VALUE &aux NAME

Package

clsql-helper

Source

dirty.lisp (file)

Function: %log-fn-perhaps LOG

Package

clsql-helper

Source

clsql.lisp (file)

Function: %migration-done-p HASH

returns non-nil if this hashed migration has been run

Package

clsql-helper

Source

migrations.lisp (file)

Function: %sql-hash SQL-STATEMENT

returns a hashed form of the query, as a string

Package

clsql-helper

Source

migrations.lisp (file)

Function: clause-for-from-date-1 &key (FOR DATE) (FROM-DATE START) (BY STEP) GENERATE

iterates through dates from start by step
HAS NO END CHECK eg an infinite loop unless you prevent it

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: clause-for-from-date-thru-5 &key (FOR DATE) (FROM-DATE START) (THRU END) (BY STEP) GENERATE

iterates through dates from start to end inclusively

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: clause-for-from-date-to-3 &key (FOR DATE) (FROM-DATE START) (TO END) (BY STEP) GENERATE

iterates through dates from start to end exclusive of end

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: clause-for-from-datetime-2 &key (FOR DATE) (FROM-DATETIME START) (BY STEP) GENERATE

iterates through dates from start by step
HAS NO END CHECK eg an infinite loop unless you prevent it

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: clause-for-from-datetime-thru-6 &key (FOR DATE) (FROM-DATETIME START) (THRU END) (BY STEP) GENERATE

iterates through dates from start to end inclusively

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: clause-for-from-datetime-to-4 &key (FOR DATE) (FROM-DATETIME START) (TO END) (BY STEP) GENERATE

iterates through dates from start to end exclusive of end

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Function: coerce-connection-spec C

Package

clsql-helper

Source

connections.lisp (file)