r9457: Reworked CLSQL file structure.
[clsql.git] / db-postgresql-socket / postgresql-socket-sql.lisp
index d988edaffaf6485572beefa5e914528732d486bd..46e82ce928c64140be4ae54cd8e846eb74beed62 100644 (file)
@@ -2,15 +2,14 @@
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
-;;;; Name:          postgresql-socket-sql.sql
-;;;; Purpose:       High-level PostgreSQL interface using socket
-;;;; Programmers:   Kevin M. Rosenberg based on
-;;;;                Original code by Pierre R. Mai 
-;;;; Date Started:  Feb 2002
+;;;; Name:     postgresql-socket-sql.sql
+;;;; Purpose:  High-level PostgreSQL interface using socket
+;;;; Authors:  Kevin M. Rosenberg based on original code by Pierre R. Mai 
+;;;; Created:  Feb 2002
 ;;;;
 ;;;; $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
 ;;;;
 ;;;; CLSQL users are granted the rights to distribute and use this software
@@ -21,7 +20,7 @@
 (in-package #:cl-user)
 
 (defpackage :clsql-postgresql-socket
-    (:use #:common-lisp #:clsql-base-sys #:postgresql-socket)
+    (:use #:common-lisp #:clsql-sys #:postgresql-socket)
     (:export #:postgresql-socket-database)
     (:documentation "This is the CLSQL socket interface to PostgreSQL."))
 
@@ -30,7 +29,7 @@
 ;; interface foreign library loading routines
 
 
-(clsql-base-sys:database-type-load-foreign :postgresql-socket)
+(clsql-sys:database-type-load-foreign :postgresql-socket)
 
 
 ;; Field type conversion
@@ -105,14 +104,24 @@ doesn't depend on UFFI."
 
 
 (defun convert-to-clsql-warning (database condition)
-  (warn 'clsql-database-warning :database database
-       :message (postgresql-condition-message condition)))
+  (ecase *backend-warning-behavior*
+    (:warn
+     (warn 'sql-database-warning :database database
+          :message (postgresql-condition-message condition)))
+    (:error
+     (error 'sql-database-error :database database
+           :message (format nil "Warning upgraded to error: ~A" 
+                            (postgresql-condition-message condition))))
+    ((:ignore nil)
+     ;; do nothing
+     )))
 
 (defun convert-to-clsql-error (database expression condition)
-  (error 'clsql-sql-error :database database
+  (error 'sql-database-data-error
+        :database database
         :expression expression
-        :errno (type-of condition)
-        :error (postgresql-condition-message condition)))
+        :error-id (type-of condition)
+        :message (postgresql-condition-message condition)))
 
 (defmacro with-postgresql-handlers
     ((database &optional expression)
@@ -128,14 +137,13 @@ doesn't depend on UFFI."
                       (lambda (c)
                         (convert-to-clsql-error
                          ,database-var ,expression-var c))))
-        ;; KMR - removed double @@
         ,@body))))
 
 (defmethod database-initialize-database-type ((database-type
                                               (eql :postgresql-socket)))
   t)
 
-(defclass postgresql-socket-database (database)
+(defclass postgresql-socket-database (generic-postgresql-database)
   ((connection :accessor database-connection :initarg :connection
               :type postgresql-connection)))
 
@@ -174,7 +182,7 @@ doesn't depend on UFFI."
     (handler-case
        (handler-bind ((postgresql-warning
                        (lambda (c)
-                         (warn 'clsql-simple-warning
+                         (warn 'sql-warning
                                :format-control "~A"
                                :format-arguments
                                (list (princ-to-string c))))))
@@ -184,11 +192,11 @@ doesn't depend on UFFI."
                                      :password password))
       (postgresql-error (c)
        ;; Connect failed
-       (error 'clsql-connect-error
+       (error 'sql-connection-error
               :database-type database-type
               :connection-spec connection-spec
-              :errno (type-of c)
-              :error (postgresql-condition-message c)))
+              :error-id (type-of c)
+              :message (postgresql-condition-message c)))
       (:no-error (connection)
                 ;; Success, make instance
                 (make-instance 'postgresql-socket-database
@@ -202,7 +210,7 @@ doesn't depend on UFFI."
   (close-postgresql-connection (database-connection database))
   t)
 
-(defmethod database-query (expression (database postgresql-socket-database) result-types)
+(defmethod database-query (expression (database postgresql-socket-database) result-types field-names)
   (let ((connection (database-connection database)))
     (with-postgresql-handlers (database expression)
       (start-query-execution connection expression)
@@ -210,23 +218,26 @@ doesn't depend on UFFI."
          (wait-for-query-results connection)
        (unless (eq status :cursor)
          (close-postgresql-connection connection)
-         (error 'clsql-sql-error
+         (error 'sql-database-data-error
                 :database database
                 :expression expression
-                :errno 'missing-result
-                :error "Didn't receive result cursor for query."))
+                :error-id "missing-result"
+                :message "Didn't receive result cursor for query."))
        (setq result-types (canonicalize-types result-types cursor))
-       (loop for row = (read-cursor-row cursor result-types)
-             while row
-             collect row
-             finally
-             (unless (null (wait-for-query-results connection))
-               (close-postgresql-connection connection)
-               (error 'clsql-sql-error
-                      :database database
-                      :expression expression
-                      :errno 'multiple-results
-                      :error "Received multiple results for query.")))))))
+        (values
+         (loop for row = (read-cursor-row cursor result-types)
+               while row
+               collect row
+               finally
+               (unless (null (wait-for-query-results connection))
+                 (close-postgresql-connection connection)
+                 (error 'sql-database-data-error
+                        :database database
+                        :expression expression
+                        :error-id "multiple-results"
+                        :message "Received multiple results for query.")))
+         (when field-names
+          (mapcar #'car (postgresql-cursor-fields cursor))))))))
 
 (defmethod database-execute-command
     (expression (database postgresql-socket-database))
@@ -237,30 +248,30 @@ doesn't depend on UFFI."
          (wait-for-query-results connection)
        (when (eq status :cursor)
          (loop
-             (multiple-value-bind (row stuff)
-                 (skip-cursor-row result)
-               (unless row
-                 (setq status :completed result stuff)
-                 (return)))))
+           (multiple-value-bind (row stuff)
+               (skip-cursor-row result)
+             (unless row
+               (setq status :completed result stuff)
+               (return)))))
        (cond
-         ((null status)
-          t)
-         ((eq status :completed)
-          (unless (null (wait-for-query-results connection))
+        ((null status)
+         t)
+        ((eq status :completed)
+         (unless (null (wait-for-query-results connection))
             (close-postgresql-connection connection)
-            (error 'clsql-sql-error
+            (error 'sql-database-data-error
                    :database database
                    :expression expression
-                   :errno 'multiple-results
-                   :error "Received multiple results for command."))
-          result)
+                   :error-id "multiple-results"
+                   :message "Received multiple results for command."))
+         result)
          (t
           (close-postgresql-connection connection)
-          (error 'clsql-sql-error
+          (error 'sql-database-data-error
                  :database database
                  :expression expression
-                 :errno 'missing-result
-                 :error "Didn't receive completion for command.")))))))
+                 :errno "missing-result"
+                 :message "Didn't receive completion for command.")))))))
 
 (defstruct postgresql-socket-result-set
   (done nil)
@@ -278,11 +289,11 @@ doesn't depend on UFFI."
          (wait-for-query-results connection)
        (unless (eq status :cursor)
          (close-postgresql-connection connection)
-         (error 'clsql-sql-error
+         (error 'sql-database-data-error
                 :database database
                 :expression expression
-                :errno 'missing-result
-                :error "Didn't receive result cursor for query."))
+                :error-id "missing-result"
+                :message "Didn't receive result cursor for query."))
        (values (make-postgresql-socket-result-set
                 :done nil 
                 :cursor cursor
@@ -312,150 +323,6 @@ doesn't depend on UFFI."
            (setf (postgresql-socket-result-set-done result-set) t)
            (wait-for-query-results (database-connection database)))))))
 
-;;; Object listing
-
-(defun owner-clause (owner)
-  (cond 
-   ((stringp owner)
-    (format
-     nil
-     " AND (relowner=(SELECT usesysid FROM pg_user WHERE (usename='~A')))" 
-     owner))
-   ((null owner)
-    (format nil " AND (NOT (relowner=1))"))
-   (t "")))
-
-(defmethod database-list-objects-of-type ((database postgresql-socket-database)
-                                          type owner)
-  (mapcar #'car
-         (database-query
-          (format nil
-                  "SELECT relname FROM pg_class WHERE (relkind = '~A')~A"
-                  type
-                  (owner-clause owner))
-          database nil)))
-
-(defmethod database-list-tables ((database postgresql-socket-database)
-                                 &key (owner nil))
-  (database-list-objects-of-type database "r" owner))
-  
-(defmethod database-list-views ((database postgresql-socket-database)
-                                &key (owner nil))
-  (database-list-objects-of-type database "v" owner))
-  
-(defmethod database-list-indexes ((database postgresql-socket-database)
-                                  &key (owner nil))
-  (database-list-objects-of-type database "i" owner))
-
-(defmethod database-list-table-indexes (table
-                                       (database postgresql-socket-database)
-                                       &key (owner nil))
-  (let ((indexrelids
-        (database-query
-         (format 
-          nil
-          "select indexrelid from pg_index where indrelid=(select relfilenode from pg_class where relname='~A'~A)"
-          (string-downcase table)
-          (owner-clause owner))
-         database :auto))
-       (result nil))
-    (dolist (indexrelid indexrelids (nreverse result))
-      (push 
-       (caar (database-query
-             (format nil "select relname from pg_class where relfilenode='~A'"
-                     (car indexrelid))
-             database
-             nil))
-       result))))
-
-(defmethod database-list-attributes ((table string)
-                                    (database postgresql-socket-database)
-                                     &key (owner nil))
-  (let* ((owner-clause
-          (cond ((stringp owner)
-                 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
-                ((null owner) " AND (not (relowner=1))")
-                (t "")))
-         (result
-         (mapcar #'car
-                 (database-query
-                  (format nil "SELECT attname FROM pg_class,pg_attribute WHERE pg_class.oid=attrelid AND relname='~A'~A"
-                           (string-downcase table)
-                           owner-clause)
-                   database nil))))
-    (if result
-       (reverse
-         (remove-if #'(lambda (it) (member it '("cmin"
-                                                "cmax"
-                                                "xmax"
-                                                "xmin"
-                                               "oid"
-                                                "ctid"
-                                               ;; kmr -- added tableoid
-                                               "tableoid") :test #'equal)) 
-                   result)))))
-
-(defmethod database-attribute-type (attribute (table string)
-                                   (database postgresql-socket-database)
-                                    &key (owner nil))
-  (let* ((owner-clause
-          (cond ((stringp owner)
-                 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
-                ((null owner) " AND (not (relowner=1))")
-                (t "")))
-         (result
-         (mapcar #'car
-                 (database-query
-                  (format nil "SELECT pg_type.typname FROM pg_type,pg_class,pg_attribute WHERE pg_class.oid=pg_attribute.attrelid AND pg_class.relname='~A' AND pg_attribute.attname='~A' AND pg_attribute.atttypid=pg_type.oid~A"
-                          (string-downcase table)
-                           (string-downcase attribute)
-                           owner-clause)
-                  database nil))))
-    (when result
-      (intern (string-upcase (car result)) :keyword))))
-
-(defmethod database-create-sequence (sequence-name
-                                    (database postgresql-socket-database))
-  (database-execute-command
-   (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
-   database))
-
-(defmethod database-drop-sequence (sequence-name
-                                  (database postgresql-socket-database))
-  (database-execute-command
-   (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name)) database))
-
-(defmethod database-list-sequences ((database postgresql-socket-database)
-                                    &key (owner nil))
-  (database-list-objects-of-type database "S" owner))
-
-(defmethod database-set-sequence-position (name (position integer)
-                                          (database postgresql-socket-database))
-  (values
-   (parse-integer
-    (caar
-     (database-query
-      (format nil "SELECT SETVAL ('~A', ~A)" name position)
-      database nil)))))
-
-(defmethod database-sequence-next (sequence-name 
-                                  (database postgresql-socket-database))
-  (values
-   (parse-integer
-    (caar
-     (database-query
-      (concatenate 'string "SELECT NEXTVAL ('" (sql-escape sequence-name) "')")
-      database nil)))))
-
-(defmethod database-sequence-last (sequence-name (database postgresql-socket-database))
-  (values
-   (parse-integer
-    (caar
-     (database-query
-      (concatenate 'string "SELECT LAST_VALUE ('" sequence-name "')")
-      database nil)))))
-  
-
 (defmethod database-create (connection-spec (type (eql :postgresql-socket)))
   (destructuring-bind (host name user password) connection-spec
     (let ((database (database-connect (list host "template1" user password)
@@ -478,32 +345,6 @@ doesn't depend on UFFI."
              :key #'car :test #'string-equal)
     t))
 
-(defmethod database-list (connection-spec (type (eql :postgresql-socket)))
-  (destructuring-bind (host name user password) connection-spec
-    (declare (ignore name))
-    (let ((database (database-connect (list host "template1" user password)
-                                     type)))
-      (unwind-protect
-          (progn
-            (setf (slot-value database 'clsql-base-sys::state) :open)
-            (mapcar #'car (database-query "select datname from pg_database" 
-                                          database :auto)))
-       (progn
-         (database-disconnect database)
-         (setf (slot-value database 'clsql-base-sys::state) :closed))))))
-
-(defmethod database-describe-table ((database postgresql-socket-database) 
-                                   table)
-  (database-query
-   (format nil "select a.attname, t.typname
-                               from pg_class c, pg_attribute a, pg_type t
-                               where c.relname = '~a'
-                                   and a.attnum > 0
-                                   and a.attrelid = c.oid
-                                   and a.atttypid = t.oid"
-           (sql-escape (string-downcase table)))
-   database :auto))
-
 
 ;; Database capabilities
 
@@ -513,8 +354,11 @@ doesn't depend on UFFI."
 (defmethod db-type-has-fancy-math? ((db-type (eql :postgresql-socket)))
   t)
 
-(defmethod db-type-default-case ((db-type (eql :postgresql)))
+(defmethod db-type-default-case ((db-type (eql :postgresql-socket)))
   :lower)
 
-(when (clsql-base-sys:database-type-library-loaded :postgresql-socket)
-  (clsql-base-sys:initialize-database-type :database-type :postgresql-socket))
+(defmethod database-underlying-type ((database postgresql-socket-database))
+  :postgresql)
+
+(when (clsql-sys:database-type-library-loaded :postgresql-socket)
+  (clsql-sys:initialize-database-type :database-type :postgresql-socket))