X-Git-Url: http://git.kpe.io/?p=clsql.git;a=blobdiff_plain;f=sql%2Fgenerics.lisp;h=d8066cf04a8709fbcddaf58e9c766af737ac380b;hp=d1b642aecf2202ebcf595302c926b082b5caa393;hb=9ba5ee2647740aca7777ac12a21db32837f3f2b6;hpb=9898f50385419417475b1c07874a16902695cb8b diff --git a/sql/generics.lisp b/sql/generics.lisp index d1b642a..d8066cf 100644 --- a/sql/generics.lisp +++ b/sql/generics.lisp @@ -7,7 +7,7 @@ ;;;; Author: Kevin M. Rosenberg based on ;;;; Created: Apr 2004 ;;;; -;;;; $Id: db-interface.lisp 9123 2004-04-21 20:34:42Z kevin $ +;;;; $Id$ ;;;; ;;;; This file, part of CLSQL, is Copyright (c) 2002-2004 by Kevin M. Rosenberg ;;;; @@ -18,76 +18,106 @@ (in-package #:clsql-sys) + +;; FDML + +(defgeneric execute-command (expression &key database) + (:documentation + "Executes the SQL command EXPRESSION, which may be an SQL +expression or a string representing any SQL statement apart from +a query, on the supplied DATABASE which defaults to +*DEFAULT-DATABASE*.")) + + +(defgeneric query (query-expression &key database result-types flatp field-names) + (:documentation + "Executes the SQL query expression QUERY-EXPRESSION, which may +be an SQL expression or a string, on the supplied DATABASE which +defaults to *DEFAULT-DATABASE*. RESULT-TYPES is a list of symbols +which specifies the lisp type for each field returned by +QUERY-EXPRESSION. If RESULT-TYPES is nil all results are returned +as strings whereas the default value of :auto means that the lisp +types are automatically computed for each field. FIELD-NAMES is t +by default which means that the second value returned is a list +of strings representing the columns selected by +QUERY-EXPRESSION. If FIELD-NAMES is nil, the list of column names +is not returned as a second value. FLATP has a default value of +nil which means that the results are returned as a list of +lists. If FLATP is t and only one result is returned for each +record selected by QUERY-EXPRESSION, the results are returned as +elements of a list.")) + + +;; OODML + (defgeneric update-record-from-slot (object slot &key database) (:documentation - "The generic function UPDATE-RECORD-FROM-SLOT updates an individual -data item in the column represented by SLOT. The DATABASE is only used -if OBJECT is not yet associated with any database, in which case a -record is created in DATABASE. Only SLOT is initialized in this case; -other columns in the underlying database receive default values. The -argument SLOT is the CLOS slot name; the corresponding column names -are derived from the View Class definition.")) + "Updates the value stored in the column represented by the +slot, specified by the CLOS slot name SLOT, of View Class +instance OBJECT. DATABASE defaults to *DEFAULT-DATABASE* and +specifies the database in which the update is made only if OBJECT +is not associated with a database. In this case, a record is +created in DATABASE and the attribute represented by SLOT is +initialised from the value of the supplied slots with other +attributes having default values. Furthermore, OBJECT becomes +associated with DATABASE.")) (defgeneric update-record-from-slots (object slots &key database) (:documentation - "The generic function UPDATE-RECORD-FROM-SLOTS updates data in the -columns represented by SLOTS. The DATABASE is only used if OBJECT is -not yet associated with any database, in which case a record is -created in DATABASE. Only slots are initialized in this case; other -columns in the underlying database receive default values. The -argument SLOTS contains the CLOS slot names; the corresponding column -names are derived from the view class definition.")) + "Updates the values stored in the columns represented by the +slots, specified by the CLOS slot names SLOTS, of View Class +instance OBJECT. DATABASE defaults to *DEFAULT-DATABASE* and +specifies the database in which the update is made only if OBJECT +is not associated with a database. In this case, a record is +created in the appropriate table of DATABASE and the attributes +represented by SLOTS are initialised from the values of the +supplied slots with other attributes having default +values. Furthermore, OBJECT becomes associated with DATABASE.")) (defgeneric update-records-from-instance (object &key database) (:documentation - "Using an instance of a view class, OBJECT, update the database -table that stores its instance data. If OBJECT is already associated -with a database, that database is used, and DATABASE is ignored. If -OBJECT is not yet associated with a database, a record is created for -instance in the appropriate table of DATABASE and the instance becomes -associated with that database.")) - -(defgeneric delete-instance-records (instance) + "Using an instance of a View Class, OBJECT, update the table +that stores its instance data. DATABASE defaults to +*DEFAULT-DATABASE* and specifies the database in which the update +is made only if OBJECT is not associated with a database. In this +case, a record is created in the appropriate table of DATABASE +using values from the slot values of OBJECT, and OBJECT becomes +associated with DATABASE.")) + +(defgeneric delete-instance-records (object) (:documentation - "Deletes the records represented by INSTANCE from the database -associated with it. If INSTANCE has no associated database, an error -is signalled.")) + "Deletes the records represented by OBJECT in the appropriate +table of the database associated with OBJECT. If OBJECT is not +yet associated with a database, an error is signalled.")) -(defgeneric update-instance-from-records (instance &key database) +(defgeneric update-instance-from-records (object &key database) (:documentation - "The generic function UPDATE-INSTANCE-FROM-RECORDS updates the -values in the slots of the View Class instance INSTANCE using the data -in the database DATABASE which defaults to the DATABASE that instance -is associated with, or the value of *DEFAULT-DATABASE*. If INSTANCE is -associated with a database, then DATABASE must be that same -database. The update is not recursive on joins. Join slots (that is, -slots with :db-kind :join ) are updated, but the joined objects are -not updated.")) - -(defgeneric update-slot-from-record (instance slot &key database) + "Updates the slot values of the View Class instance OBJECT +using the attribute values of the appropriate table of DATABASE +which defaults to the database associated with OBJECT or, if +OBJECT is not associated with a database, *DEFAULT-DATABASE*. +Join slots are updated but instances of the class on which the +join is made are not updated.")) + +(defgeneric update-slot-from-record (object slot &key database) (:documentation - "Updates the value in the slot SLOT of the View Class instance -INSTANCE using the data in the database DATABASE which defaults to the -database that INSTANCE is associated with, or the value of -*DEFAULT-DATABASE*. The argument SLOT is the CLOS slot name, the -corresponding column names are derived from the View Class -definition. The update is not recursive on joins. Join slots (that is, -slots with :db-kind :join) are updated, but the joined objects are not + "Updates the slot value, specified by the CLOS slot name SLOT, +of the View Class instance OBJECT using the attribute values of +the appropriate table of DATABASE which defaults to the database +associated with OBJECT or, if OBJECT is not associated with a +database, *DEFAULT-DATABASE*. Join slots are updated but +instances of the class on which the join is made are not updated.")) -(defgeneric instance-refreshed (instance) +(defgeneric instance-refreshed (object) (:documentation - "The function INSTANCE-REFRESHED is called inside SELECT when its -REFRESH argument is true and the instance INSTANCE has just been -updated. The supplied method on STANDARD-DB-OBJECT does nothing. If -your application needs to take action when a View Class instance has -been updated by (select ... :refresh t) then add an INSTANCE-REFRESH -method specializing on your subclass of STANDARD-DB-OBJECT.")) - -(defgeneric database-null-value (type) - (:documentation - "Return an expression of type TYPE which SQL NULL values will be -converted into.")) + "Provides a hook which is called within an object oriented +call to SELECT with a non-nil value of REFRESH when the View +Class instance OBJECT has been updated from the database. A +method specialised on STANDARD-DB-OBJECT is provided which has no +effects. Methods specialised on particular View Classes can be +used to specify any operations that need to be made on View +Classes instances which have been updated in calls to SELECT.")) (defgeneric update-slot-with-null (instance slotname slotdef) (:documentation "Called to update a slot when its column has a NULL @@ -95,23 +125,9 @@ value. If nulls are allowed for the column, the slot's value will be nil, otherwise its value will be set to the result of calling DATABASE-NULL-VALUE on the type of the slot.")) -(defgeneric output-sql (expr database) - ) - -(defgeneric output-sql-hash-key (arg database) - ) - -(defgeneric collect-table-refs (sql) - ) -(defgeneric database-output-sql (arg database) - ) -(defgeneric database-constraint-description (constraint database) - ) (defgeneric database-pkey-constraint (class database) ) -(defgeneric database-constraint-statement (constraints database) - ) -(defgeneric %install-class (class database) +(defgeneric %install-class (class database &key transactions) ) (defgeneric database-generate-column-definition (class slotdef database) ) @@ -121,12 +137,35 @@ DATABASE-NULL-VALUE on the type of the slot.")) ) (defgeneric get-slot-values-from-view (obj slotdeflist values) ) -(defgeneric database-output-sql-as-type (type val database) - ) -(defgeneric read-sql-value (val type database) +(defgeneric database-output-sql-as-type (type val database db-type) ) -(defgeneric add-to-relation (target slot-name value) +(defgeneric read-sql-value (val type database db-type) ) -(defgeneric remove-from-relation (target slot-name value) + + +;; Generation of SQL strings from lisp expressions + +(defgeneric output-sql (expr database) + (:documentation "Writes an SQL string appropriate for DATABASE + and corresponding to the lisp expression EXPR to + *SQL-STREAM*. The function SQL-OUTPUT is a top-level call for + generating SQL strings which initialises *SQL-STREAM*, calls + OUTPUT-SQL and reads the generated SQL string from + *SQL-STREAM*.")) + +(defgeneric database-output-sql (expr database) + (:documentation "Returns an SQL string appropriate for DATABASE + and corresponding to the lisp expression + EXPR. DATABASE-OUTPUT-SQL is called by OUTPUT-SQL when no more + specific method exists for EXPR.")) + +(defgeneric output-sql-hash-key (expr database) + (:documentation "Returns a list (or other object suitable for +use as the key of an EQUAL hash table) which uniquely identifies +the arguments EXPR and DATABASE.")) + +(defgeneric collect-table-refs (sql) ) +(defgeneric database-constraint-statement (constraints database) + )