r9336: 12 May 2004 Kevin Rosenberg (kevin@rosenberg.net)
[clsql.git] / db-postgresql-socket / postgresql-socket-sql.lisp
index a9cb8f5ed0536f78234ce77a2089084ba7b54b8b..ebda22c0a7b4557c82504aeedb825b80ad314702 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: postgresql-socket-sql.lisp,v 1.2 2003/05/02 03:05:54 kevin Exp $
+;;;; $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
 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
 ;;;; *************************************************************************
 
-(declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
-(in-package :cl-user)
+(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."))
 
-(in-package :clsql-postgresql-socket)
+(in-package #:clsql-postgresql-socket)
 
 ;; 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
@@ -106,8 +104,17 @@ 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 'clsql-database-warning :database database
+          :message (postgresql-condition-message condition)))
+    (:error
+     (error 'clsql-sql-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
@@ -129,7 +136,6 @@ 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
@@ -150,7 +156,19 @@ doesn't depend on UFFI."
   (destructuring-bind (host db user password &optional port options tty)
       connection-spec
     (declare (ignore password options tty))
-    (concatenate 'string host (if port ":") (if port port) "/" db "/" user)))
+    (concatenate 'string 
+      (etypecase host
+       (null
+        "localhost")
+       (pathname (namestring host))
+       (string host))
+      (when port 
+       (concatenate 'string
+                    ":"
+                    (etypecase port
+                      (integer (write-to-string port))
+                      (string port))))
+      "/" db "/" user)))
 
 (defmethod database-connect (connection-spec 
                             (database-type (eql :postgresql-socket)))
@@ -183,6 +201,7 @@ doesn't depend on UFFI."
                 (make-instance 'postgresql-socket-database
                                :name (database-name-from-spec connection-spec
                                                               database-type)
+                               :database-type :postgresql-socket
                                :connection-spec connection-spec
                                :connection connection)))))
 
@@ -190,7 +209,7 @@ doesn't depend on UFFI."
   (close-postgresql-connection (database-connection database))
   t)
 
-(defmethod database-query (expression (database postgresql-socket-database) 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)
@@ -203,18 +222,21 @@ doesn't depend on UFFI."
                 :expression expression
                 :errno 'missing-result
                 :error "Didn't receive result cursor for query."))
-       (setq types (canonicalize-types types cursor))
-       (loop for row = (read-cursor-row cursor 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.")))))))
+       (setq result-types (canonicalize-types result-types cursor))
+        (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 'clsql-sql-error
+                        :database database
+                        :expression expression
+                        :errno 'multiple-results
+                        :error "Received multiple results for query.")))
+         (when field-names
+          (mapcar #'car (postgresql-cursor-fields cursor))))))))
 
 (defmethod database-execute-command
     (expression (database postgresql-socket-database))
@@ -225,23 +247,23 @@ 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
                    :database database
                    :expression expression
                    :errno 'multiple-results
                    :error "Received multiple results for command."))
-          result)
+         result)
          (t
           (close-postgresql-connection connection)
           (error 'clsql-sql-error
@@ -255,9 +277,9 @@ doesn't depend on UFFI."
   (cursor nil)
   (types nil))
 
-(defmethod database-query-result-set (expression (database postgresql-socket-database) 
-                                     &key full-set types
-     )
+(defmethod database-query-result-set ((expression string)
+                                     (database postgresql-socket-database) 
+                                     &key full-set result-types)
   (declare (ignore full-set))
   (let ((connection (database-connection database)))
     (with-postgresql-handlers (database expression)
@@ -274,7 +296,7 @@ doesn't depend on UFFI."
        (values (make-postgresql-socket-result-set
                 :done nil 
                 :cursor cursor
-                :types (canonicalize-types types cursor))
+                :types (canonicalize-types result-types cursor))
                (length (postgresql-cursor-fields cursor)))))))
 
 (defmethod database-dump-result-set (result-set
@@ -300,5 +322,208 @@ doesn't depend on UFFI."
            (setf (postgresql-socket-result-set-done result-set) t)
            (wait-for-query-results (database-connection database)))))))
 
-(when (clsql-base-sys:database-type-library-loaded :postgresql-socket)
-  (clsql-base-sys:initialize-database-type :database-type :postgresql-socket))
+;;; 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 "")))
+
+(defun database-list-objects-of-type (database type owner)
+  (mapcar #'car
+         (database-query
+          (format nil
+                  "SELECT relname FROM pg_class WHERE (relkind = '~A')~A"
+                  type
+                  (owner-clause owner))
+          database nil 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 nil))
+       (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 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 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 ((row (car (database-query
+                  (format nil "SELECT pg_type.typname,pg_attribute.attlen,pg_attribute.atttypmod,pg_attribute.attnotnull 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 owner))
+                  database nil nil))))
+    (when row
+      (values
+       (ensure-keyword (first row))
+       (if (string= "-1" (second row))
+          (- (parse-integer (third row) :junk-allowed t) 4)
+        (parse-integer (second row)))
+       nil
+       (if (string-equal "f" (fourth row))
+          1
+        0)))))
+
+(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 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 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 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)
+                                     type)))
+      (unwind-protect
+          (execute-command (format nil "create database ~A" name))
+       (database-disconnect database)))))
+
+(defmethod database-destroy (connection-spec (type (eql :postgresql-socket)))
+  (destructuring-bind (host name user password) connection-spec
+    (let ((database (database-connect (list host "template1" user password)
+                                     type)))
+      (unwind-protect
+         (execute-command (format nil "drop database ~A" name))
+       (database-disconnect database)))))
+
+
+(defmethod database-probe (connection-spec (type (eql :postgresql-socket)))
+  (when (find (second connection-spec) (database-list connection-spec type)
+             :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-sys::state) :open)
+            (mapcar #'car (database-query "select datname from pg_database" 
+                                          database :auto nil)))
+       (progn
+         (database-disconnect database)
+         (setf (slot-value database 'clsql-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 nil))
+
+
+;; Database capabilities
+
+(defmethod db-backend-has-create/destroy-db? ((db-type (eql :postgresql-socket)))
+  nil)
+
+(defmethod db-type-has-fancy-math? ((db-type (eql :postgresql-socket)))
+  t)
+
+(defmethod db-type-default-case ((db-type (eql :postgresql-socket)))
+  :lower)
+
+(when (clsql-sys:database-type-library-loaded :postgresql-socket)
+  (clsql-sys:initialize-database-type :database-type :postgresql-socket))