r9457: Reworked CLSQL file structure.
[clsql.git] / db-postgresql-socket / postgresql-socket-sql.lisp
index 176dfcb7ff5ce041ad1421bada3f9516440e6151..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
 ;;;; (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,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)
@@ -129,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)))
 
@@ -152,6 +159,8 @@ doesn't depend on UFFI."
     (declare (ignore password options tty))
     (concatenate 'string 
       (etypecase host
+       (null
+        "localhost")
        (pathname (namestring host))
        (string host))
       (when port 
@@ -173,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))))))
@@ -183,16 +192,17 @@ 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
                                :name (database-name-from-spec connection-spec
                                                               database-type)
+                               :database-type :postgresql-socket
                                :connection-spec connection-spec
                                :connection connection)))))
 
@@ -200,7 +210,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)
@@ -208,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."))
-       (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.")))))))
+                :error-id "missing-result"
+                :message "Didn't receive result cursor 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 '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))
@@ -235,39 +248,39 @@ 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)
   (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)
@@ -276,15 +289,15 @@ 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
-                :types (canonicalize-types types cursor))
+                :types (canonicalize-types result-types cursor))
                (length (postgresql-cursor-fields cursor)))))))
 
 (defmethod database-dump-result-set (result-set
@@ -310,5 +323,42 @@ 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))
+(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))
+
+
+;; 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)
+
+(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))