X-Git-Url: http://git.kpe.io/?p=clsql.git;a=blobdiff_plain;f=base%2Fdb-interface.lisp;h=3ddfd89c032e64741fbd3f949dddecc8166dc8ba;hp=8b608473eea9d543f4cbd1aa2cd4af1eab6107dc;hb=09f07ac9d914a83f9426609f3264f4e66b5a6d97;hpb=bada52b7a8fd2cc484dee33cccd64ca09a52ec3d

diff --git a/base/db-interface.lisp b/base/db-interface.lisp
index 8b60847..3ddfd89 100644
--- a/base/db-interface.lisp
+++ b/base/db-interface.lisp
@@ -2,7 +2,7 @@
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
-;;;; Name:          db-interface.cl
+;;;; Name:          db-interface.lisp
 ;;;; Purpose:       Generic function definitions for DB interfaces
 ;;;; Programmers:   Kevin M. Rosenberg based on
 ;;;;                Original code by Pierre R. Mai. Additions from
@@ -11,7 +11,7 @@
 ;;;;
 ;;;; $Id$
 ;;;;
-;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
+;;;; This file, part of CLSQL, is Copyright (c) 2002-2004 by Kevin M. Rosenberg
 ;;;; and Copyright (c) 1999-2001 by Pierre R. Mai, and onShoreD
 ;;;;
 ;;;; CLSQL users are granted the rights to distribute and use this software
@@ -19,8 +19,7 @@
 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
 ;;;; *************************************************************************
 
-(declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
-(in-package :clsql-base-sys)
+(in-package #:clsql-base)
 
 (defgeneric database-type-load-foreign (database-type)
   (:documentation
@@ -31,13 +30,6 @@
    "The internal generic implementation for checking if
 database type library loaded successfully."))
 
-(defgeneric database-type (database)
-  (:documentation
-   "Returns database type")
-  (:method (database)
-	   (signal-nodb-error database)))
-
-
 (defgeneric database-initialize-database-type (database-type)
   (:documentation
    "The internal generic implementation of initialize-database-type."))
@@ -50,42 +42,35 @@ was called with the connection-spec."))
 (defgeneric database-connect (connection-spec database-type)
   (:documentation "Internal generic implementation of connect."))
 
+(defgeneric database-reconnect (database)
+  (:method ((database t))
+	   (signal-no-database-error database))
+  (:documentation "Internal generic implementation of reconnect."))
+
 (defgeneric database-disconnect (database)
-  (:method ((database closed-database))
-	   (signal-closed-database-error database))
   (:method ((database t))
-	   (signal-nodb-error database))
+	   (signal-no-database-error database))
   (:documentation "Internal generic implementation of disconnect."))
 
-(defgeneric database-query (query-expression database types)
-  (:method (query-expression (database closed-database) types)
-	   (declare (ignore query-expression types))
-	   (signal-closed-database-error database))  
-  (:method (query-expression (database t) types)
-	   (declare (ignore query-expression types))
-	   (signal-nodb-error database))
+(defgeneric database-query (query-expression database result-types field-names)
+  (:method (query-expression (database t) result-types field-names)
+	   (declare (ignore query-expression result-types field-names))
+	   (signal-no-database-error database))
   (:documentation "Internal generic implementation of query."))
 
 
 (defgeneric database-execute-command (sql-expression database)
-  (:method (sql-expression (database closed-database))
-	   (declare (ignore sql-expression))
-	   (signal-closed-database-error database))
   (:method (sql-expression (database t))
 	   (declare (ignore sql-expression))
-	   (signal-nodb-error database))
+	   (signal-no-database-error database))
   (:documentation "Internal generic implementation of execute-command."))
 
 ;;; Mapping and iteration
 (defgeneric database-query-result-set
-    (query-expression database &key full-set types)
-  (:method (query-expression (database closed-database) &key full-set types)
-	   (declare (ignore query-expression full-set types))
-	   (signal-closed-database-error database)
-	   (values nil nil nil))
-  (:method (query-expression (database t) &key full-set types)
-	   (declare (ignore query-expression full-set types))
-	   (signal-nodb-error database)
+    (query-expression database &key full-set result-types)
+  (:method (query-expression (database t) &key full-set result-types)
+	   (declare (ignore query-expression full-set result-types))
+	   (signal-no-database-error database)
 	   (values nil nil nil))
   (:documentation
    "Internal generic implementation of query mapping.  Starts the
@@ -103,27 +88,56 @@ returned otherwise.  If an error occurs during query execution, the
 function should signal a clsql-sql-error."))
 
 (defgeneric database-dump-result-set (result-set database)
-  (:method (result-set (database closed-database))
-	   (declare (ignore result-set))
-	   (signal-closed-database-error database))
   (:method (result-set (database t))
 	   (declare (ignore result-set))
-	   (signal-nodb-error database))
+	   (signal-no-database-error database))
   (:documentation "Dumps the received result-set."))
 
 (defgeneric database-store-next-row (result-set database list)
-  (:method (result-set (database closed-database) list)
-	   (declare (ignore result-set list))
-	   (signal-closed-database-error database))
   (:method (result-set (database t) list)
 	   (declare (ignore result-set list))
-	   (signal-nodb-error database))
+	   (signal-no-database-error database))
   (:documentation
    "Returns t and stores the next row in the result set in list or
 returns nil when result-set is finished."))
 
+(defgeneric database-create (connection-spec type)
+  (:documentation
+   "Creates a database, returns T if successfull or signals an error."))
+
+(defgeneric database-probe (connection-spec type)
+  (:method (spec type)
+    (declare (ignore spec))
+    (warn "database-proe not support for database-type ~A." type))
+  (:documentation
+   "Probes for the existence of a database, returns T if database found or NIL 
+if not found. May signal an error if unable to communicate with database server."))
+
+(defgeneric database-list (connection-spec type)
+  (:method (spec type)
+    (declare (ignore spec))
+    (warn "database-list not support for database-type ~A." type))
+  (:documentation
+   "Lists all databases found for TYPE. May signal an error if unable to communicate with database server."))
+
+(defgeneric database-destroy (connection-spec database)
+  (:documentation "Destroys (drops) a database."))
 
-;; Interfaces to support UncommonSQL
+(defgeneric database-truncate (database)
+  (:method ((database t))
+    (signal-no-database-error database))
+  (:documentation "Remove all data from database."))
+
+(defgeneric database-describe-table (database table)
+  (:method ((database t) table)
+    (declare (ignore table))
+    (signal-no-database-error database))
+  (:documentation "Return a list of name/type for columns in table"))
+
+(defgeneric database-destory (connection-spec type)
+  (:documentation
+   "Destroys a database, returns T if successfull or signals an error
+if unable to destory."))
 
 (defgeneric database-create-sequence (name database)
   (:documentation "Create a sequence in DATABASE."))
@@ -134,6 +148,15 @@ returns nil when result-set is finished."))
 (defgeneric database-sequence-next (name database)
   (:documentation "Increment a sequence in DATABASE."))
 
+(defgeneric database-list-sequences (database &key owner)
+  (:documentation "List all sequences in DATABASE."))
+
+(defgeneric database-set-sequence-position (name position database)
+  (:documentation "Set the position of the sequence called NAME in DATABASE."))
+
+(defgeneric database-sequence-last (name database)
+  (:documentation "Select the last value in sequence NAME in DATABASE."))
+
 (defgeneric database-start-transaction (database)
   (:documentation "Start a transaction in DATABASE."))
 
@@ -147,14 +170,24 @@ returns nil when result-set is finished."))
   (:documentation "Return the type SQL type specifier as a string, for
 the given lisp type and parameters."))
 
-(defgeneric database-list-tables (database &key system-tables)
+(defgeneric database-list-tables (database &key owner)
   (:documentation "List all tables in the given database"))
+ 
+(defgeneric database-list-views (database &key owner)
+  (:documentation "List all views in the DATABASE."))
+
+(defgeneric database-list-indexes (database &key owner)
+  (:documentation "List all indexes in the DATABASE."))
 
-(defgeneric database-list-attributes (table database)
+(defgeneric database-list-table-indexes (table database &key owner)
+  (:documentation "List all indexes for a table in the DATABASE."))
+
+(defgeneric database-list-attributes (table database &key owner)
   (:documentation "List all attributes in TABLE."))
 
-(defgeneric database-attribute-type (attribute table database)
-  (:documentation "Return the type of ATTRIBUTE in TABLE."))
+(defgeneric database-attribute-type (attribute table database &key owner)
+  (:documentation "Return the type of ATTRIBUTE in TABLE. Returns multiple values
+of TYPE_NAME (keyword) PRECISION SCALE NULLABLE."))
 
 (defgeneric database-add-attribute (table attribute database)
   (:documentation "Add the attribute to the table."))
@@ -165,7 +198,64 @@ the given lisp type and parameters."))
 (defgeneric oid (object)
   (:documentation "Return the unique ID of a database object."))
 
- 
+;;; Database backend capabilities
+
+(defgeneric database-underlying-type (database)
+  (:method (database)
+    (database-type database))
+  (:documentation "Returns the type of the underlying database. For ODBC, needs to query ODBC driver."))
+
+(defgeneric db-type-use-column-on-drop-index? (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   nil)
+  (:documentation "NIL [default] if database-type does not use column name on DROP INDEX."))
+
+(defgeneric db-type-has-views? (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   ;; SQL92 has views
+	   t)
+  (:documentation "T [default] if database-type supports views."))
+
+(defgeneric db-type-default-case (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   ;; By default, CommonSQL converts identifiers to UPPER case. 
+	   :upper)
+  (:documentation ":upper [default] if means identifiers mapped to UPPER case SQL like CommonSQL API. However, Postgresql maps identifiers to lower case, so PostgreSQL uses a value of :lower for this result."))
+
+(defgeneric db-type-has-fancy-math? (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   nil)
+  (:documentation "NIL [default] if database-type does not have fancy math."))
+
+(defgeneric db-type-has-subqueries? (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   t)
+  (:documentation "T [default] if database-type supports views."))
+
+(defgeneric db-type-has-boolean-where? (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   ;; SQL99 has boolean where
+	   t)
+  (:documentation "T [default] if database-type supports boolean WHERE clause, such as 'WHERE MARRIED'."))
+
+(defgeneric db-backend-has-create/destroy-db? (db-type)
+  (:method (db-type)
+	   (declare (ignore db-type))
+	   t)
+  (:documentation "T [default] if backend can destroy and create databases."))
+
+(defgeneric db-type-transaction-capable? (db database)
+  (:method (db database)
+	   (declare (ignore db database))
+	   t)
+  (:documentation "T [default] if database can supports transactions."))
+
 ;;; Large objects support (Marc Battyani)
 
 (defgeneric database-create-large-object (database)
@@ -179,3 +269,53 @@ the given lisp type and parameters."))
 
 (defgeneric database-delete-large-object (object-id database)
   (:documentation "Deletes the large object in the database"))
+
+
+;; Checks for closed database
+
+(defmethod database-disconnect :before ((database database))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-query :before (query-expression (database database) 
+				   result-set field-names)
+  (declare (ignore query-expression result-set field-names))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-execute-command :before (sql-expression (database database))
+  (declare (ignore sql-expression))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-query-result-set :before (expr (database database)
+                                            &key full-set result-types)
+  (declare (ignore expr full-set result-types))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-dump-result-set :before (result-set (database database))
+  (declare (ignore result-set))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+ 
+(defmethod database-store-next-row :before (result-set (database database) list)
+  (declare (ignore result-set list))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-commit-transaction :before ((database database))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-start-transaction :before ((database database))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defmethod database-abort-transaction :before ((database database))
+  (unless (is-database-open database)
+    (signal-closed-database-error database)))
+
+(defgeneric describe-table (table &key database)
+  (:documentation "Describes a table, returns a list of name/type for columns in table"))
+