The clsql-helper Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The clsql-helper Reference Manual

This is the clsql-helper Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:29:05 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CLSQL-Helper

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

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

Authors

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

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 clsql-helper

License

BSD

Description

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

Version

0.1

Dependencies
Source

clsql-helper.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 clsql-helper.asd

Location

clsql-helper.asd

Systems

clsql-helper (system)

Packages

clsql-helper.system


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 clsql-helper/package.lisp

Parent

clsql-helper (system)

Location

package.lisp

Packages

clsql-helper


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 clsql-helper/utils.lisp

Dependency

package.lisp (file)

Parent

clsql-helper (system)

Location

utils.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 clsql-helper/iterate-clauses.lisp

Dependency

utils.lisp (file)

Parent

clsql-helper (system)

Location

iterate-clauses.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 clsql-helper/connections.lisp

Dependency

iterate-clauses.lisp (file)

Parent

clsql-helper (system)

Location

connections.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 clsql-helper/date.lisp

Dependency

connections.lisp (file)

Parent

clsql-helper (system)

Location

date.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 clsql-helper/clsql.lisp

Dependency

date.lisp (file)

Parent

clsql-helper (system)

Location

clsql.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 clsql-helper/db-object.lisp

Dependency

clsql.lisp (file)

Parent

clsql-helper (system)

Location

db-object.lisp

Exported Definitions
Internal Definitions

mssql-db-view (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 clsql-helper/dirty.lisp

Dependency

db-object.lisp (file)

Parent

clsql-helper (system)

Location

dirty.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 clsql-helper/migrations.lisp

Dependency

dirty.lisp (file)

Parent

clsql-helper (system)

Location

migrations.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.11 clsql-helper/merge.lisp

Dependency

migrations.lisp (file)

Parent

clsql-helper (system)

Location

merge.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.12 clsql-helper/recency.lisp

Dependency

merge.lisp (file)

Parent

clsql-helper (system)

Location

recency.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 clsql-helper.system

Source

clsql-helper.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 clsql-helper

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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?

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: merge-conflict ()
Package

clsql-helper

Source

merge.lisp (file)

Direct superclasses

error (condition)

Direct methods
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
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
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)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: db-object ()
Package

clsql-helper

Source

db-object.lisp (file)

Direct superclasses

standard-db-object (class)

Direct subclasses
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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

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

clsql-helper

Source

dirty.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)

Function: current-timestamp-sql ()
Package

clsql-helper

Source

recency.lisp (file)

Function: default-log-fn MSG
Package

clsql-helper

Source

clsql.lisp (file)

Function: ensure-migration-table ()

if it doesn’t exist, create the migration table

Package

clsql-helper

Source

migrations.lisp (file)

Function: error-db-obj-has-no-keys OBJ
Package

clsql-helper

Source

clsql.lisp (file)

Function: log-database-command-fn BODY-FN &key LOG-FN DATABASE
Package

clsql-helper

Source

clsql.lisp (file)

Function: make-dirty-slot NAME OLD NEW
Package

clsql-helper

Source

dirty.lisp (file)

Function: make-instances-setting-slot-values CLASS COLUMNS ROWS

From N rows and column-name make N instances of class filling data from rows by creating instances and setting slot-values

Package

clsql-helper

Source

clsql.lisp (file)

Function: maybe-call IT
Package

clsql-helper

Source

connections.lisp (file)

Function: md5-string STRING
Package

clsql-helper

Source

migrations.lisp (file)

Function: most-recent-history-date O
Package

clsql-helper

Source

recency.lisp (file)

Function: reset-dirty O
Package

clsql-helper

Source

dirty.lisp (file)

Function: same-database-connection? C1 C2

determines whether or not two connections are the same
by comparing their connection spec (eg ’(server db user pass)) handles connection-settings, connection-specs and clsql:database

Package

clsql-helper

Source

connections.lisp (file)

Function: string-to-boolean S

convert a string to a boolean value

Package

clsql-helper

Source

clsql.lisp (file)

Function: trim-and-nullify S

trims the whitespace from a string returning nil
if trimming produces an empty string or the string ’nil’

Package

clsql-helper

Source

utils.lisp (file)

Function: trim-whitespace S
Package

clsql-helper

Source

utils.lisp (file)

Function: warn-db-obj-has-no-keys OBJ
Package

clsql-helper

Source

clsql.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: %coerce-to-step STEP

Converts something in an iterate date iteration clause BY section to a valid clsql:duration if it can

Package

clsql-helper

Source

iterate-clauses.lisp (file)

Methods
Method: %coerce-to-step STEP
Generic Function: %history-select-fn OBJECT
Generic Function: (setf %history-select-fn) NEW-VALUE OBJECT
Package

clsql-helper

Methods
Method: %history-select-fn (RECENCY-MIXIN recency-mixin)
Method: (setf %history-select-fn) NEW-VALUE (RECENCY-MIXIN recency-mixin)

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

Source

recency.lisp (file)

Generic Function: already-saved CONDITION
Generic Function: (setf already-saved) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: already-saved (CONDITION merge-conflict)
Method: (setf already-saved) NEW-VALUE (CONDITION merge-conflict)
Source

merge.lisp (file)

Generic Function: coerce-to-db-string-representation S

Convert an object into an unquoted string that the database understands

mostly used to do the coercion in db-string

Package

clsql-helper

Source

clsql.lisp (file)

Methods
Method: coerce-to-db-string-representation S
Generic Function: command OBJECT
Package

clsql-helper

Methods
Method: command (MIGRATION migration)

automatically generated reader method

Source

migrations.lisp (file)

Generic Function: conflicts CONDITION
Generic Function: (setf conflicts) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: conflicts (CONDITION merge-conflicts)
Method: (setf conflicts) NEW-VALUE (CONDITION merge-conflicts)
Source

merge.lisp (file)

Generic Function: db-object-key-slots O

returns the primarky key-slots of the given object

Package

clsql-helper

Source

clsql.lisp (file)

Methods
Method: db-object-key-slots O
Generic Function: from CONDITION
Generic Function: (setf from) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: from (CONDITION merging-values)
Method: (setf from) NEW-VALUE (CONDITION merging-values)
Source

merge.lisp (file)

Generic Function: get-history-info O
Package

clsql-helper

Source

recency.lisp (file)

Methods
Method: get-history-info (O recency-mixin)
Generic Function: hash OBJECT
Package

clsql-helper

Methods
Method: hash (MIGRATION migration)

automatically generated reader method

Source

migrations.lisp (file)

Generic Function: history-info CONDITION
Generic Function: (setf history-info) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: history-info (CONDITION recency-error)
Method: (setf history-info) NEW-VALUE (CONDITION recency-error)
Source

recency.lisp (file)

Generic Function: instance CONDITION
Generic Function: (setf instance) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: instance (CONDITION recency-error)
Method: (setf instance) NEW-VALUE (CONDITION recency-error)
Source

recency.lisp (file)

Generic Function: message CONDITION
Generic Function: (setf message) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: message (CONDITION type-coercion-error)
Method: (setf message) NEW-VALUE (CONDITION type-coercion-error)
Source

clsql.lisp (file)

Method: message (CONDITION save-failed)
Method: (setf message) NEW-VALUE (CONDITION save-failed)
Source

clsql.lisp (file)

Generic Function: migrate THING &key FORCE

perform the migration, returns the number of statments executed

Package

clsql-helper

Source

migrations.lisp (file)

Methods
Method: migrate O &key FORCE
Method: migrate (O migration) &key FORCE
Generic Function: migration-done-p OBJECT
Package

clsql-helper

Methods
Method: migration-done-p (MIGRATION migration)

automatically generated reader method

Source

migrations.lisp (file)

Generic Function: names->conn OBJECT
Generic Function: (setf names->conn) NEW-VALUE OBJECT
Package

clsql-helper

Methods
Method: names->conn (CONNECTION-DATABASE connection-database)
Method: (setf names->conn) NEW-VALUE (CONNECTION-DATABASE connection-database)

A mapping of names to active connections

Source

connections.lisp (file)

Generic Function: names->spec OBJECT
Generic Function: (setf names->spec) NEW-VALUE OBJECT
Package

clsql-helper

Methods
Method: names->spec (CONNECTION-DATABASE connection-database)
Method: (setf names->spec) NEW-VALUE (CONNECTION-DATABASE connection-database)

A mapping of names to connection specs

Source

connections.lisp (file)

Generic Function: new-value OBJECT
Generic Function: (setf new-value) NEW-VALUE OBJECT
Package

clsql-helper

Methods
Method: new-value (DIRTY-SLOT dirty-slot)

automatically generated reader method

Source

dirty.lisp (file)

Method: (setf new-value) NEW-VALUE (DIRTY-SLOT dirty-slot)

automatically generated writer method

Source

dirty.lisp (file)

Generic Function: obj CONDITION
Generic Function: (setf obj) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: obj (CONDITION db-object-has-no-keys)
Method: (setf obj) NEW-VALUE (CONDITION db-object-has-no-keys)
Source

clsql.lisp (file)

Generic Function: object-diff-equals V1 V2
Package

clsql-helper

Methods
Method: object-diff-equals V1 V2
Source

merge.lisp (file)

Generic Function: object-diff-list O1 O2 &key IGNORED-SLOT-NAMES COMPARE
Package

clsql-helper

Methods
Method: object-diff-list O1 O2 &key IGNORED-SLOT-NAMES COMPARE &aux SAME-TYPE?
Source

merge.lisp (file)

Generic Function: old-value OBJECT
Generic Function: (setf old-value) NEW-VALUE OBJECT
Package

clsql-helper

Methods
Method: old-value (CONDITION merge-conflict)
Method: (setf old-value) NEW-VALUE (CONDITION merge-conflict)
Source

merge.lisp (file)

Method: old-value (DIRTY-SLOT dirty-slot)

automatically generated reader method

Source

dirty.lisp (file)

Method: (setf old-value) NEW-VALUE (DIRTY-SLOT dirty-slot)

automatically generated writer method

Source

dirty.lisp (file)

Generic Function: pending-value CONDITION
Generic Function: (setf pending-value) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: pending-value (CONDITION merge-conflict)
Method: (setf pending-value) NEW-VALUE (CONDITION merge-conflict)
Source

merge.lisp (file)

Generic Function: relaxed-parse-float STR &key TYPE

trys to read a value we hope to be a floating point number returns nil on failure

The goal is to allow reading strings with spaces commas and dollar signs in them correctly

Package

clsql-helper

Source

utils.lisp (file)

Methods
Method: relaxed-parse-float STR &key TYPE
Generic Function: saved-value CONDITION
Generic Function: (setf saved-value) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: saved-value (CONDITION merge-conflict)
Method: (setf saved-value) NEW-VALUE (CONDITION merge-conflict)
Source

merge.lisp (file)

Generic Function: slot CONDITION
Generic Function: (setf slot) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: slot (CONDITION merge-conflict)
Method: (setf slot) NEW-VALUE (CONDITION merge-conflict)
Source

merge.lisp (file)

Method: slot (CONDITION merging-values)
Method: (setf slot) NEW-VALUE (CONDITION merging-values)
Source

merge.lisp (file)

Generic Function: slot-name OBJECT
Generic Function: (setf slot-name) NEW-VALUE OBJECT
Package

clsql-helper

Methods
Method: slot-name (DIRTY-SLOT dirty-slot)

automatically generated reader method

Source

dirty.lisp (file)

Method: (setf slot-name) NEW-VALUE (DIRTY-SLOT dirty-slot)

automatically generated writer method

Source

dirty.lisp (file)

Generic Function: target CONDITION
Generic Function: (setf target) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: target (CONDITION merging-values)
Method: (setf target) NEW-VALUE (CONDITION merging-values)
Source

merge.lisp (file)

Generic Function: to-migrations THING

Recursively turn the input into a list of migrations to be performed

Package

clsql-helper

Source

migrations.lisp (file)

Methods
Method: to-migrations THING
Generic Function: to-type CONDITION
Generic Function: (setf to-type) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: to-type (CONDITION type-coercion-error)
Method: (setf to-type) NEW-VALUE (CONDITION type-coercion-error)
Source

clsql.lisp (file)

Generic Function: val CONDITION
Generic Function: (setf val) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: val (CONDITION type-coercion-error)
Method: (setf val) NEW-VALUE (CONDITION type-coercion-error)
Source

clsql.lisp (file)

Generic Function: validate-recency O &key HISTORY-INFO %RETRIEVED-AT
Package

clsql-helper

Source

recency.lisp (file)

Methods
Method: validate-recency (O recency-mixin) &key HISTORY-INFO %RETRIEVED-AT &aux *ISO8601-MICROSECONDS*
Generic Function: value CONDITION
Generic Function: (setf value) NEW-VALUE CONDITION
Package

clsql-helper

Methods
Method: value (CONDITION merging-values)
Method: (setf value) NEW-VALUE (CONDITION merging-values)
Source

merge.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Conditions

Condition: commit ()
Package

clsql-helper

Source

connections.lisp (file)

Direct superclasses

condition (condition)

Condition: db-object-has-no-keys ()
Package

clsql-helper

Source

clsql.lisp (file)

Direct superclasses

warning (condition)

Direct methods
  • obj (method)
  • obj (method)
Direct slots
Slot: obj
Initargs

:obj

Initform

(quote nil)

Readers

obj (generic function)

Writers

(setf obj) (generic function)

Condition: rollback ()
Package

clsql-helper

Source

connections.lisp (file)

Direct superclasses

condition (condition)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Classes

Class: connection-database ()
Package

clsql-helper

Source

connections.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: names->spec

A mapping of names to connection specs

Initargs

:names->spec

Readers

names->spec (generic function)

Writers

(setf names->spec) (generic function)

Slot: names->conn

A mapping of names to active connections

Initargs

:names->conn

Readers

names->conn (generic function)

Writers

(setf names->conn) (generic function)

Class: dirty-slot ()
Package

clsql-helper

Source

dirty.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • new-value (method)
  • new-value (method)
  • old-value (method)
  • old-value (method)
  • slot-name (method)
  • slot-name (method)
Direct slots
Slot: slot-name
Initargs

:slot-name

Readers

slot-name (generic function)

Writers

(setf slot-name) (generic function)

Slot: old-value
Initargs

:old-value

Readers

old-value (generic function)

Writers

(setf old-value) (generic function)

Slot: new-value
Initargs

:new-value

Readers

new-value (generic function)

Writers

(setf new-value) (generic function)

Class: migration ()
Package

clsql-helper

Source

migrations.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: command
Initargs

:command

Readers

command (generic function)

Slot: migration-done-p
Initargs

:migration-done-p

Readers

migration-done-p (generic function)

Slot: hash
Initargs

:hash

Readers

hash (generic function)

Class: mssql-db-view ()
Package

clsql-helper

Source

db-object.lisp (file)

Direct superclasses

db-object (class)

Direct methods

update-record-from-slots (method)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
clsql-helper.asd: The clsql-helper<dot>asd file
clsql-helper/clsql.lisp: The clsql-helper/clsql<dot>lisp file
clsql-helper/connections.lisp: The clsql-helper/connections<dot>lisp file
clsql-helper/date.lisp: The clsql-helper/date<dot>lisp file
clsql-helper/db-object.lisp: The clsql-helper/db-object<dot>lisp file
clsql-helper/dirty.lisp: The clsql-helper/dirty<dot>lisp file
clsql-helper/iterate-clauses.lisp: The clsql-helper/iterate-clauses<dot>lisp file
clsql-helper/merge.lisp: The clsql-helper/merge<dot>lisp file
clsql-helper/migrations.lisp: The clsql-helper/migrations<dot>lisp file
clsql-helper/package.lisp: The clsql-helper/package<dot>lisp file
clsql-helper/recency.lisp: The clsql-helper/recency<dot>lisp file
clsql-helper/utils.lisp: The clsql-helper/utils<dot>lisp file

F
File, Lisp, clsql-helper.asd: The clsql-helper<dot>asd file
File, Lisp, clsql-helper/clsql.lisp: The clsql-helper/clsql<dot>lisp file
File, Lisp, clsql-helper/connections.lisp: The clsql-helper/connections<dot>lisp file
File, Lisp, clsql-helper/date.lisp: The clsql-helper/date<dot>lisp file
File, Lisp, clsql-helper/db-object.lisp: The clsql-helper/db-object<dot>lisp file
File, Lisp, clsql-helper/dirty.lisp: The clsql-helper/dirty<dot>lisp file
File, Lisp, clsql-helper/iterate-clauses.lisp: The clsql-helper/iterate-clauses<dot>lisp file
File, Lisp, clsql-helper/merge.lisp: The clsql-helper/merge<dot>lisp file
File, Lisp, clsql-helper/migrations.lisp: The clsql-helper/migrations<dot>lisp file
File, Lisp, clsql-helper/package.lisp: The clsql-helper/package<dot>lisp file
File, Lisp, clsql-helper/recency.lisp: The clsql-helper/recency<dot>lisp file
File, Lisp, clsql-helper/utils.lisp: The clsql-helper/utils<dot>lisp file

L
Lisp File, clsql-helper.asd: The clsql-helper<dot>asd file
Lisp File, clsql-helper/clsql.lisp: The clsql-helper/clsql<dot>lisp file
Lisp File, clsql-helper/connections.lisp: The clsql-helper/connections<dot>lisp file
Lisp File, clsql-helper/date.lisp: The clsql-helper/date<dot>lisp file
Lisp File, clsql-helper/db-object.lisp: The clsql-helper/db-object<dot>lisp file
Lisp File, clsql-helper/dirty.lisp: The clsql-helper/dirty<dot>lisp file
Lisp File, clsql-helper/iterate-clauses.lisp: The clsql-helper/iterate-clauses<dot>lisp file
Lisp File, clsql-helper/merge.lisp: The clsql-helper/merge<dot>lisp file
Lisp File, clsql-helper/migrations.lisp: The clsql-helper/migrations<dot>lisp file
Lisp File, clsql-helper/package.lisp: The clsql-helper/package<dot>lisp file
Lisp File, clsql-helper/recency.lisp: The clsql-helper/recency<dot>lisp file
Lisp File, clsql-helper/utils.lisp: The clsql-helper/utils<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   L   M   N   O   P   R   S   T   V   W  
Index Entry  Section

%
%after-update-recency-check: Internal functions
%before-update-recency-check: Internal functions
%call-perhaps-logged: Internal functions
%clsql-subclauses: Internal functions
%coerce-rows: Internal functions
%coerce-to-step: Internal generic functions
%coerce-to-step: Internal generic functions
%command-if-needed: Internal functions
%date-test-fn-finder: Internal functions
%date-test-form: Internal functions
%default-migrations: Internal functions
%dirty-before: Internal functions
%history-select-fn: Internal generic functions
%history-select-fn: Internal generic functions
%log-fn-perhaps: Internal functions
%migration-done-p: Internal functions
%retrieved-at: Exported generic functions
%retrieved-at: Exported generic functions
%sql-hash: Internal functions

(
(setf %history-select-fn): Internal generic functions
(setf %history-select-fn): Internal generic functions
(setf %retrieved-at): Exported generic functions
(setf %retrieved-at): Exported generic functions
(setf already-saved): Internal generic functions
(setf already-saved): Internal generic functions
(setf conflicts): Internal generic functions
(setf conflicts): Internal generic functions
(setf dirty-slots): Exported generic functions
(setf dirty-slots): Exported generic functions
(setf dirty-test): Exported generic functions
(setf dirty-test): Exported generic functions
(setf from): Internal generic functions
(setf from): Internal generic functions
(setf history-info): Internal generic functions
(setf history-info): Internal generic functions
(setf instance): Internal generic functions
(setf instance): Internal generic functions
(setf message): Internal generic functions
(setf message): Internal generic functions
(setf message): Internal generic functions
(setf names->conn): Internal generic functions
(setf names->conn): Internal generic functions
(setf names->spec): Internal generic functions
(setf names->spec): Internal generic functions
(setf new-value): Internal generic functions
(setf new-value): Internal generic functions
(setf obj): Internal generic functions
(setf obj): Internal generic functions
(setf old-value): Internal generic functions
(setf old-value): Internal generic functions
(setf old-value): Internal generic functions
(setf pending-value): Internal generic functions
(setf pending-value): Internal generic functions
(setf saved-value): Internal generic functions
(setf saved-value): Internal generic functions
(setf slot): Internal generic functions
(setf slot): Internal generic functions
(setf slot): Internal generic functions
(setf slot-name): Internal generic functions
(setf slot-name): Internal generic functions
(setf target): Internal generic functions
(setf target): Internal generic functions
(setf to-type): Internal generic functions
(setf to-type): Internal generic functions
(setf val): Internal generic functions
(setf val): Internal generic functions
(setf value): Internal generic functions
(setf value): Internal generic functions

A
add-connection-spec: Exported functions
after-day-of-month: Exported functions
already-saved: Internal generic functions
already-saved: Internal generic functions

B
before-day-of-month: Exported functions
by-col: Exported generic functions
by-col: Exported generic functions
by-id: Exported generic functions
by-id: Exported generic functions

C
clause-for-from-date-1: Internal functions
clause-for-from-date-thru-5: Internal functions
clause-for-from-date-to-3: Internal functions
clause-for-from-datetime-2: Internal functions
clause-for-from-datetime-thru-6: Internal functions
clause-for-from-datetime-to-4: Internal functions
clsql-and: Exported functions
clsql-ands: Exported functions
clsql-column-name: Exported functions
clsql-date/times->utime: Exported functions
clsql-datetime-equal: Exported functions
clsql-exp: Exported functions
clsql-get-val: Exported functions
clsql-or: Exported functions
clsql-ors: Exported functions
coerce-connection-spec: Internal functions
coerce-to-db-string-representation: Internal generic functions
coerce-to-db-string-representation: Internal generic functions
coerce-value-to-db-type: Exported generic functions
coerce-value-to-db-type: Exported generic functions
column-name-string: Exported functions
command: Internal generic functions
command: Internal generic functions
conflicts: Internal generic functions
conflicts: Internal generic functions
convert-to-clsql-date: Exported generic functions
convert-to-clsql-date: Exported generic functions
convert-to-clsql-date!: Exported macros
convert-to-clsql-datetime: Exported generic functions
convert-to-clsql-datetime: Exported generic functions
convert-to-clsql-datetime!: Exported macros
copy-instance: Exported generic functions
copy-instance: Exported generic functions
current-sql-date: Exported functions
current-sql-time: Exported functions
current-timestamp: Exported functions
current-timestamp-sql: Internal functions

D
date-add: Exported functions
date-day: Exported generic functions
date-day: Exported generic functions
date-diff: Exported functions
date-month: Exported generic functions
date-month: Exported generic functions
date-year: Exported generic functions
date-year: Exported generic functions
day-after: Exported functions
day-before: Exported functions
days-in-month: Exported functions
db-eql: Exported generic functions
db-eql: Exported generic functions
db-exec: Exported functions
db-null: Exported functions
db-null!: Exported macros
db-object-key-slots: Internal generic functions
db-object-key-slots: Internal generic functions
db-objs: Exported functions
db-objs-select: Exported functions
db-query: Exported functions
db-query-plists: Exported functions
db-scalar: Exported functions
db-select: Exported functions
db-select-first: Exported functions
db-select-scalar: Exported functions
db-string: Exported functions
db-type-from-lisp-type: Exported functions
default-log-fn: Internal functions
defmethod-when-possible: Internal macros
dirty-slots: Exported generic functions
dirty-slots: Exported generic functions
dirty-test: Exported generic functions
dirty-test: Exported generic functions
dt<: Exported functions
dt<=: Exported functions
dt>: Exported functions
dt>=: Exported functions

E
ensure-migration-table: Internal functions
error-db-obj-has-no-keys: Internal functions

F
fill-identifier!: Exported generic functions
fill-identifier!: Exported generic functions
fill-identifier!: Exported generic functions
find-active-connection-name: Exported functions
find-any-active-connection-name: Exported functions
find-any-connection: Exported functions
find-connection: Exported functions
find-dirty-test: Exported functions
first-of-next-month: Exported functions
first-of-the-month: Exported functions
first-of-the-month?: Exported functions
format-value-for-database: Exported functions
from: Internal generic functions
from: Internal generic functions
Function, %after-update-recency-check: Internal functions
Function, %before-update-recency-check: Internal functions
Function, %call-perhaps-logged: Internal functions
Function, %clsql-subclauses: Internal functions
Function, %coerce-rows: Internal functions
Function, %command-if-needed: Internal functions
Function, %date-test-fn-finder: Internal functions
Function, %date-test-form: Internal functions
Function, %default-migrations: Internal functions
Function, %dirty-before: Internal functions
Function, %log-fn-perhaps: Internal functions
Function, %migration-done-p: Internal functions
Function, %sql-hash: Internal functions
Function, add-connection-spec: Exported functions
Function, after-day-of-month: Exported functions
Function, before-day-of-month: Exported functions
Function, clause-for-from-date-1: Internal functions
Function, clause-for-from-date-thru-5: Internal functions
Function, clause-for-from-date-to-3: Internal functions
Function, clause-for-from-datetime-2: Internal functions
Function, clause-for-from-datetime-thru-6: Internal functions
Function, clause-for-from-datetime-to-4: Internal functions
Function, clsql-and: Exported functions
Function, clsql-ands: Exported functions
Function, clsql-column-name: Exported functions
Function, clsql-date/times->utime: Exported functions
Function, clsql-datetime-equal: Exported functions
Function, clsql-exp: Exported functions
Function, clsql-get-val: Exported functions
Function, clsql-or: Exported functions
Function, clsql-ors: Exported functions
Function, coerce-connection-spec: Internal functions
Function, column-name-string: Exported functions
Function, current-sql-date: Exported functions
Function, current-sql-time: Exported functions
Function, current-timestamp: Exported functions
Function, current-timestamp-sql: Internal functions
Function, date-add: Exported functions
Function, date-diff: Exported functions
Function, day-after: Exported functions
Function, day-before: Exported functions
Function, days-in-month: Exported functions
Function, db-exec: Exported functions
Function, db-null: Exported functions
Function, db-objs: Exported functions
Function, db-objs-select: Exported functions
Function, db-query: Exported functions
Function, db-query-plists: Exported functions
Function, db-scalar: Exported functions
Function, db-select: Exported functions
Function, db-select-first: Exported functions
Function, db-select-scalar: Exported functions
Function, db-string: Exported functions
Function, db-type-from-lisp-type: Exported functions
Function, default-log-fn: Internal functions
Function, dt<: Exported functions
Function, dt<=: Exported functions
Function, dt>: Exported functions
Function, dt>=: Exported functions
Function, ensure-migration-table: Internal functions
Function, error-db-obj-has-no-keys: Internal functions
Function, find-active-connection-name: Exported functions
Function, find-any-active-connection-name: Exported functions
Function, find-any-connection: Exported functions
Function, find-connection: Exported functions
Function, find-dirty-test: Exported functions
Function, first-of-next-month: Exported functions
Function, first-of-the-month: Exported functions
Function, first-of-the-month?: Exported functions
Function, format-value-for-database: Exported functions
Function, get-connection-spec: Exported functions
Function, has-db-data-to-store?: Exported functions
Function, join-slot?: Exported functions
Function, last-month: Exported functions
Function, last-of-the-month: Exported functions
Function, last-of-the-month?: Exported functions
Function, list-of-db-strings: Exported functions
Function, log-database-command-fn: Internal functions
Function, make-dirty-slot: Internal functions
Function, make-instance-plist: Exported functions
Function, make-instances: Exported functions
Function, make-instances-setting-access: Exported functions
Function, make-instances-setting-accessors: Exported functions
Function, make-instances-setting-slot-values: Internal functions
Function, maybe-call: Internal functions
Function, md5-string: Internal functions
Function, month-day-string: Exported functions
Function, month-string: Exported functions
Function, most-recent-history-date: Internal functions
Function, new-connection-database: Exported functions
Function, next-month: Exported functions
Function, pretty-print-sql: Exported functions
Function, primary-key-column-names: Exported functions
Function, primary-key-slot: Exported functions
Function, primary-key-slot-names: Exported functions
Function, primary-key-slots: Exported functions
Function, primary-key-value: Exported functions
Function, primary-key-where-clauses: Exported functions
Function, print-nullable-date: Exported functions
Function, print-nullable-datetime: Exported functions
Function, print-timestamp: Exported functions
Function, remove-connection-spec: Exported functions
Function, reset-dirty: Internal functions
Function, same-database-connection?: Internal functions
Function, slot-db-stored?: Exported functions
Function, string-to-boolean: Internal functions
Function, table-name-exp: Exported functions
Function, table-name-string: Exported functions
Function, trim-and-nullify: Internal functions
Function, trim-whitespace: Internal functions
Function, type-coercion-error: Exported functions
Function, warn-db-obj-has-no-keys: Internal functions
Function, with-a-database-context: Exported functions
Function, with-a-transaction-context: Exported functions
Function, with-database-context: Exported functions
Function, with-database-function: Exported functions
Function, with-transaction-context: Exported functions

G
Generic Function, %coerce-to-step: Internal generic functions
Generic Function, %history-select-fn: Internal generic functions
Generic Function, %retrieved-at: Exported generic functions
Generic Function, (setf %history-select-fn): Internal generic functions
Generic Function, (setf %retrieved-at): Exported generic functions
Generic Function, (setf already-saved): Internal generic functions
Generic Function, (setf conflicts): Internal generic functions
Generic Function, (setf dirty-slots): Exported generic functions
Generic Function, (setf dirty-test): Exported generic functions
Generic Function, (setf from): Internal generic functions
Generic Function, (setf history-info): Internal generic functions
Generic Function, (setf instance): Internal generic functions
Generic Function, (setf message): Internal generic functions
Generic Function, (setf names->conn): Internal generic functions
Generic Function, (setf names->spec): Internal generic functions
Generic Function, (setf new-value): Internal generic functions
Generic Function, (setf obj): Internal generic functions
Generic Function, (setf old-value): Internal generic functions
Generic Function, (setf pending-value): Internal generic functions
Generic Function, (setf saved-value): Internal generic functions
Generic Function, (setf slot): Internal generic functions
Generic Function, (setf slot-name): Internal generic functions
Generic Function, (setf target): Internal generic functions
Generic Function, (setf to-type): Internal generic functions
Generic Function, (setf val): Internal generic functions
Generic Function, (setf value): Internal generic functions
Generic Function, already-saved: Internal generic functions
Generic Function, by-col: Exported generic functions
Generic Function, by-id: Exported generic functions
Generic Function, coerce-to-db-string-representation: Internal generic functions
Generic Function, coerce-value-to-db-type: Exported generic functions
Generic Function, command: Internal generic functions
Generic Function, conflicts: Internal generic functions
Generic Function, convert-to-clsql-date: Exported generic functions
Generic Function, convert-to-clsql-datetime: Exported generic functions
Generic Function, copy-instance: Exported generic functions
Generic Function, date-day: Exported generic functions
Generic Function, date-month: Exported generic functions
Generic Function, date-year: Exported generic functions
Generic Function, db-eql: Exported generic functions
Generic Function, db-object-key-slots: Internal generic functions
Generic Function, dirty-slots: Exported generic functions
Generic Function, dirty-test: Exported generic functions
Generic Function, fill-identifier!: Exported generic functions
Generic Function, from: Internal generic functions
Generic Function, get-history-info: Internal generic functions
Generic Function, hash: Internal generic functions
Generic Function, history-info: Internal generic functions
Generic Function, identity-slot?: Exported generic functions
Generic Function, instance: Internal generic functions
Generic Function, iso8601-datestamp: Exported generic functions
Generic Function, iso8601-timestamp: Exported generic functions
Generic Function, merge-changes: Exported generic functions
Generic Function, message: Internal generic functions
Generic Function, migrate: Internal generic functions
Generic Function, migration-done-p: Internal generic functions
Generic Function, migrations: Exported generic functions
Generic Function, names->conn: Internal generic functions
Generic Function, names->spec: Internal generic functions
Generic Function, new-object-p: Exported generic functions
Generic Function, new-value: Internal generic functions
Generic Function, next-identifier: Exported generic functions
Generic Function, next-identifier-sql: Exported generic functions
Generic Function, obj: Internal generic functions
Generic Function, object-diff-equals: Internal generic functions
Generic Function, object-diff-list: Internal generic functions
Generic Function, old-value: Internal generic functions
Generic Function, pending-value: Internal generic functions
Generic Function, relaxed-parse-float: Internal generic functions
Generic Function, save!: Exported generic functions
Generic Function, saved-value: Internal generic functions
Generic Function, slot: Internal generic functions
Generic Function, slot-dirty?: Exported generic functions
Generic Function, slot-name: Internal generic functions
Generic Function, target: Internal generic functions
Generic Function, to-migrations: Internal generic functions
Generic Function, to-type: Internal generic functions
Generic Function, val: Internal generic functions
Generic Function, validate-recency: Internal generic functions
Generic Function, value: Internal generic functions
get-connection-spec: Exported functions
get-history-info: Internal generic functions
get-history-info: Internal generic functions

H
has-db-data-to-store?: Exported functions
hash: Internal generic functions
hash: Internal generic functions
history-info: Internal generic functions
history-info: Internal generic functions

I
identity-slot?: Exported generic functions
identity-slot?: Exported generic functions
instance: Internal generic functions
instance: Internal generic functions
iso8601-datestamp: Exported generic functions
iso8601-datestamp: Exported generic functions
iso8601-timestamp: Exported generic functions
iso8601-timestamp: Exported generic functions

J
join-slot?: Exported functions

L
last-month: Exported functions
last-of-the-month: Exported functions
last-of-the-month?: Exported functions
list-of-db-strings: Exported functions
log-database-command: Exported macros
log-database-command-fn: Internal functions

M
Macro, convert-to-clsql-date!: Exported macros
Macro, convert-to-clsql-datetime!: Exported macros
Macro, db-null!: Exported macros
Macro, defmethod-when-possible: Internal macros
Macro, log-database-command: Exported macros
Macro, with-a-database: Exported macros
Macro, with-a-transaction: Exported macros
Macro, with-command-logging: Exported macros
Macro, with-command-logging-to-string: Exported macros
Macro, with-database: Exported macros
make-dirty-slot: Internal functions
make-instance-plist: Exported functions
make-instances: Exported functions
make-instances-setting-access: Exported functions
make-instances-setting-accessors: Exported functions
make-instances-setting-slot-values: Internal functions
maybe-call: Internal functions
md5-string: Internal functions
merge-changes: Exported generic functions
merge-changes: Exported generic functions
message: Internal generic functions
message: Internal generic functions
message: Internal generic functions
Method, %coerce-to-step: Internal generic functions
Method, %history-select-fn: Internal generic functions
Method, %retrieved-at: Exported generic functions
Method, (setf %history-select-fn): Internal generic functions
Method, (setf %retrieved-at): Exported generic functions
Method, (setf already-saved): Internal generic functions
Method, (setf conflicts): Internal generic functions
Method, (setf dirty-slots): Exported generic functions
Method, (setf dirty-test): Exported generic functions
Method, (setf from): Internal generic functions
Method, (setf history-info): Internal generic functions
Method, (setf instance): Internal generic functions
Method, (setf message): Internal generic functions
Method, (setf message): Internal generic functions
Method, (setf names->conn): Internal generic functions
Method, (setf names->spec): Internal generic functions
Method, (setf new-value): Internal generic functions
Method, (setf obj): Internal generic functions
Method, (setf old-value): Internal generic functions
Method, (setf old-value): Internal generic functions
Method, (setf pending-value): Internal generic functions
Method, (setf saved-value): Internal generic functions
Method, (setf slot): Internal generic functions
Method, (setf slot): Internal generic functions
Method, (setf slot-name): Internal generic functions
Method, (setf target): Internal generic functions
Method, (setf to-type): Internal generic functions
Method, (setf val): Internal generic functions
Method, (setf value): Internal generic functions
Method, already-saved: Internal generic functions
Method, by-col: Exported generic functions
Method, by-id: Exported generic functions
Method, coerce-to-db-string-representation: Internal generic functions
Method, coerce-value-to-db-type: Exported generic functions
Method, command: Internal generic functions
Method, conflicts: Internal generic functions
Method, convert-to-clsql-date: Exported generic functions
Method, convert-to-clsql-datetime: Exported generic functions
Method, copy-instance: Exported generic functions
Method, date-day: Exported generic functions
Method, date-month: Exported generic functions
Method, date-year: Exported generic functions
Method, db-eql: Exported generic functions
Method, db-object-key-slots: Internal generic functions
Method, dirty-slots: Exported generic functions
Method, dirty-test: Exported generic functions
Method, fill-identifier!: Exported generic functions
Method, fill-identifier!: Exported generic functions
Method, from: Internal generic functions
Method, get-history-info: Internal generic functions
Method, hash: Internal generic functions
Method, history-info: Internal generic functions
Method, identity-slot?: Exported generic functions
Method, instance: Internal generic functions
Method, iso8601-datestamp: Exported generic functions
Method, iso8601-timestamp: Exported generic functions
Method, merge-changes: Exported generic functions
Method, message: Internal generic functions
Method, message: Internal generic functions
Method, migrate: Internal generic functions
Method, migrate: Internal generic functions
Method, migration-done-p: Internal generic functions
Method, migrations: Exported generic functions
Method, names->conn: Internal generic functions
Method, names->spec: Internal generic functions
Method, new-object-p: Exported generic functions
Method, new-value: Internal generic functions
Method, next-identifier: Exported generic functions
Method, next-identifier-sql: Exported generic functions
Method, next-identifier-sql: Exported generic functions
Method, next-identifier-sql: Exported generic functions
Method, obj: Internal generic functions
Method, object-diff-equals: Internal generic functions
Method, object-diff-list: Internal generic functions
Method, old-value: Internal generic functions
Method, old-value: Internal generic functions
Method, pending-value: Internal generic functions
Method, relaxed-parse-float: Internal generic functions
Method, save!: Exported generic functions
Method, save!: Exported generic functions
Method, save!: Exported generic functions
Method, saved-value: Internal generic functions
Method, slot: Internal generic functions
Method, slot: Internal generic functions
Method, slot-dirty?: Exported generic functions
Method, slot-name: Internal generic functions
Method, target: Internal generic functions
Method, to-migrations: Internal generic functions
Method, to-type: Internal generic functions
Method, val: Internal generic functions
Method, validate-recency: Internal generic functions
Method, value: Internal generic functions
migrate: Internal generic functions
migrate: Internal generic functions
migrate: Internal generic functions
migration-done-p: Internal generic functions
migration-done-p: Internal generic functions
migrations: Exported generic functions
migrations: Exported generic functions
month-day-string: Exported functions
month-string: Exported functions
most-recent-history-date: Internal functions

N
names->conn: Internal generic functions
names->conn: Internal generic functions
names->spec: Internal generic functions
names->spec: Internal generic functions
new-connection-database: Exported functions
new-object-p: Exported generic functions
new-object-p: Exported generic functions
new-value: Internal generic functions
new-value: Internal generic functions
next-identifier: Exported generic functions
next-identifier: Exported generic functions
next-identifier-sql: Exported generic functions
next-identifier-sql: Exported generic functions
next-identifier-sql: Exported generic functions
next-identifier-sql: Exported generic functions
next-month: Exported functions

O
obj: Internal generic functions
obj: Internal generic functions
object-diff-equals: Internal generic functions
object-diff-equals: Internal generic functions
object-diff-list: Internal generic functions
object-diff-list: Internal generic functions
old-value: Internal generic functions
old-value: Internal generic functions
old-value: Internal generic functions

P
pending-value: Internal generic functions
pending-value: Internal generic functions
pretty-print-sql: Exported functions
primary-key-column-names: Exported functions
primary-key-slot: Exported functions
primary-key-slot-names: Exported functions
primary-key-slots: Exported functions
primary-key-value: Exported functions
primary-key-where-clauses: Exported functions
print-nullable-date: Exported functions
print-nullable-datetime: Exported functions
print-timestamp: Exported functions

R
relaxed-parse-float: Internal generic functions
relaxed-parse-float: Internal generic functions
remove-connection-spec: Exported functions
reset-dirty: Internal functions

S
same-database-connection?: Internal functions
save!: Exported generic functions
save!: Exported generic functions
save!: Exported generic functions
save!: Exported generic functions
saved-value: Internal generic functions
saved-value: Internal generic functions
slot: Internal generic functions
slot: Internal generic functions
slot: Internal generic functions
slot-db-stored?: Exported functions
slot-dirty?: Exported generic functions
slot-dirty?: Exported generic functions
slot-name: Internal generic functions
slot-name: Internal generic functions
string-to-boolean: Internal functions

T
table-name-exp: Exported functions
table-name-string: Exported functions
target: Internal generic functions
target: Internal generic functions
to-migrations: Internal generic functions
to-migrations: Internal generic functions
to-type: Internal generic functions
to-type: Internal generic functions
trim-and-nullify: Internal functions
trim-whitespace: Internal functions
type-coercion-error: Exported functions

V
val: Internal generic functions
val: Internal generic functions
validate-recency: Internal generic functions
validate-recency: Internal generic functions
value: Internal generic functions
value: Internal generic functions

W
warn-db-obj-has-no-keys: Internal functions
with-a-database: Exported macros
with-a-database-context: Exported functions
with-a-transaction: Exported macros
with-a-transaction-context: Exported functions
with-command-logging: Exported macros
with-command-logging-to-string: Exported macros
with-database: Exported macros
with-database-context: Exported functions
with-database-function: Exported functions
with-transaction-context: Exported functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   L   M   N   O   P   R   S   T   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   %   *   +  
A   C   D   F   H   I   M   N   O   P   S   T   V  
Index Entry  Section

%
%history-select-fn: Exported classes
%retrieved-at: Exported classes

*
*clsql-codebase-loaded*: Internal special variables
*command-log-stream*: Exported special variables
*connection-database*: Exported special variables
*connection-settings*: Exported special variables
*default-log-fn*: Internal special variables
*default-object-diff-ignore-list*: Internal special variables
*inner-transaction-error*: Internal special variables
*iso8601-date-separator*: Internal special variables
*iso8601-date-time-separator*: Internal special variables
*iso8601-microseconds*: Internal special variables
*iso8601-time-separator*: Internal special variables
*iso8601-timezone*: Internal special variables
*migration-table-name*: Exported special variables
*record-this-dirty-slot*: Internal special variables
*thread-local-transaction-catch-tag*: Internal special variables

+
+a-day+: Exported special variables
+a-minute+: Exported special variables
+a-month+: Exported special variables
+a-negative-day+: Exported special variables
+a-negative-hour+: Exported special variables
+a-negative-minute+: Exported special variables
+a-negative-month+: Exported special variables
+a-negative-second+: Exported special variables
+a-negative-year+: Exported special variables
+a-second+: Exported special variables
+a-year+: Exported special variables
+an-hour+: Exported special variables
+common-white-space-trimbag+: Internal special variables
+date-sep+: Internal special variables
+date-time-regex+: Internal special variables
+iso-8601-ish-regex+: Internal special variables
+iso-8601-ish-regex-string+: Internal special variables

A
already-saved: Exported conditions

C
command: Internal classes
conflicts: Exported conditions

D
dirty-slots: Exported classes
dirty-test: Exported classes

F
from: Exported conditions

H
hash: Internal classes
history-info: Exported conditions

I
instance: Exported conditions

M
message: Exported conditions
message: Exported conditions
migration-done-p: Internal classes

N
names->conn: Internal classes
names->spec: Internal classes
new-value: Internal classes

O
obj: Internal conditions
old-value: Exported conditions
old-value: Internal classes

P
pending-value: Exported conditions

S
saved-value: Exported conditions
slot: Exported conditions
slot: Exported conditions
Slot, %history-select-fn: Exported classes
Slot, %retrieved-at: Exported classes
Slot, already-saved: Exported conditions
Slot, command: Internal classes
Slot, conflicts: Exported conditions
Slot, dirty-slots: Exported classes
Slot, dirty-test: Exported classes
Slot, from: Exported conditions
Slot, hash: Internal classes
Slot, history-info: Exported conditions
Slot, instance: Exported conditions
Slot, message: Exported conditions
Slot, message: Exported conditions
Slot, migration-done-p: Internal classes
Slot, names->conn: Internal classes
Slot, names->spec: Internal classes
Slot, new-value: Internal classes
Slot, obj: Internal conditions
Slot, old-value: Exported conditions
Slot, old-value: Internal classes
Slot, pending-value: Exported conditions
Slot, saved-value: Exported conditions
Slot, slot: Exported conditions
Slot, slot: Exported conditions
Slot, slot-name: Internal classes
Slot, target: Exported conditions
Slot, to-type: Exported conditions
Slot, val: Exported conditions
Slot, value: Exported conditions
slot-name: Internal classes
Special Variable, *clsql-codebase-loaded*: Internal special variables
Special Variable, *command-log-stream*: Exported special variables
Special Variable, *connection-database*: Exported special variables
Special Variable, *connection-settings*: Exported special variables
Special Variable, *default-log-fn*: Internal special variables
Special Variable, *default-object-diff-ignore-list*: Internal special variables
Special Variable, *inner-transaction-error*: Internal special variables
Special Variable, *iso8601-date-separator*: Internal special variables
Special Variable, *iso8601-date-time-separator*: Internal special variables
Special Variable, *iso8601-microseconds*: Internal special variables
Special Variable, *iso8601-time-separator*: Internal special variables
Special Variable, *iso8601-timezone*: Internal special variables
Special Variable, *migration-table-name*: Exported special variables
Special Variable, *record-this-dirty-slot*: Internal special variables
Special Variable, *thread-local-transaction-catch-tag*: Internal special variables
Special Variable, +a-day+: Exported special variables
Special Variable, +a-minute+: Exported special variables
Special Variable, +a-month+: Exported special variables
Special Variable, +a-negative-day+: Exported special variables
Special Variable, +a-negative-hour+: Exported special variables
Special Variable, +a-negative-minute+: Exported special variables
Special Variable, +a-negative-month+: Exported special variables
Special Variable, +a-negative-second+: Exported special variables
Special Variable, +a-negative-year+: Exported special variables
Special Variable, +a-second+: Exported special variables
Special Variable, +a-year+: Exported special variables
Special Variable, +an-hour+: Exported special variables
Special Variable, +common-white-space-trimbag+: Internal special variables
Special Variable, +date-sep+: Internal special variables
Special Variable, +date-time-regex+: Internal special variables
Special Variable, +iso-8601-ish-regex+: Internal special variables
Special Variable, +iso-8601-ish-regex-string+: Internal special variables

T
target: Exported conditions
to-type: Exported conditions

V
val: Exported conditions
value: Exported conditions

Jump to:   %   *   +  
A   C   D   F   H   I   M   N   O   P   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   M   P   R   S   T  
Index Entry  Section

C
Class, connection-database: Internal classes
Class, db-object: Exported classes
Class, dirty-db-slots-mixin: Exported classes
Class, dirty-slot: Internal classes
Class, migration: Internal classes
Class, mssql-db-object: Exported classes
Class, mssql-db-view: Internal classes
Class, pg-db-object: Exported classes
Class, recency-mixin: Exported classes
Class, sqlite3-db-object: Exported classes
clsql-helper: The clsql-helper system
clsql-helper: The clsql-helper package
clsql-helper.system: The clsql-helper<dot>system package
commit: Internal conditions
Condition, commit: Internal conditions
Condition, db-object-has-no-keys: Internal conditions
Condition, merge-conflict: Exported conditions
Condition, merge-conflicts: Exported conditions
Condition, merging-values: Exported conditions
Condition, recency-error: Exported conditions
Condition, rollback: Internal conditions
Condition, save-failed: Exported conditions
Condition, type-coercion-error: Exported conditions
connection-database: Internal classes

D
db-object: Exported classes
db-object-has-no-keys: Internal conditions
dirty-db-slots-mixin: Exported classes
dirty-slot: Internal classes

M
merge-conflict: Exported conditions
merge-conflicts: Exported conditions
merging-values: Exported conditions
migration: Internal classes
mssql-db-object: Exported classes
mssql-db-view: Internal classes

P
Package, clsql-helper: The clsql-helper package
Package, clsql-helper.system: The clsql-helper<dot>system package
pg-db-object: Exported classes

R
recency-error: Exported conditions
recency-mixin: Exported classes
rollback: Internal conditions

S
save-failed: Exported conditions
sqlite3-db-object: Exported classes
System, clsql-helper: The clsql-helper system

T
type-coercion-error: Exported conditions

Jump to:   C   D   M   P   R   S   T