1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: postgresql-sql.lisp
6 ;;;; Purpose: High-level PostgreSQL interface using UFFI
7 ;;;; Date Started: Feb 2002
11 ;;;; CLSQL users are granted the rights to distribute and use this software
12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
14 ;;;; *************************************************************************
16 (in-package #:cl-user)
18 (defpackage #:clsql-postgresql
19 (:use #:common-lisp #:clsql-sys #:postgresql #:clsql-uffi)
20 (:export #:postgresql-database)
21 (:documentation "This is the CLSQL interface to PostgreSQL."))
23 (in-package #:clsql-postgresql)
25 ;;; Field conversion functions
27 (defun make-type-list-for-auto (num-fields res-ptr)
28 (let ((new-types '()))
29 (dotimes (i num-fields)
31 (let* ((type (PQftype res-ptr i)))
40 ((#.pgsql-ftype#float4
46 (nreverse new-types)))
48 (defun canonicalize-types (types num-fields res-ptr)
51 (let ((auto-list (make-type-list-for-auto num-fields res-ptr)))
54 (canonicalize-type-list types auto-list))
60 (defun tidy-error-message (message)
61 (unless (stringp message)
62 (setq message (uffi:convert-from-foreign-string message)))
63 (let ((message (string-right-trim '(#\Return #\Newline) message)))
65 ((< (length message) (length "ERROR:"))
67 ((string= message "ERROR:" :end1 6)
68 (string-left-trim '(#\Space) (subseq message 6)))
72 (defmethod database-initialize-database-type ((database-type
76 (uffi:def-type pgsql-conn-def pgsql-conn)
77 (uffi:def-type pgsql-result-def pgsql-result)
80 (defclass postgresql-database (database)
81 ((conn-ptr :accessor database-conn-ptr :initarg :conn-ptr
84 :accessor database-lock
85 :initform (make-process-lock "conn"))))
87 (defmethod database-type ((database postgresql-database))
90 (defmethod database-name-from-spec (connection-spec (database-type
92 (check-connection-spec connection-spec database-type
93 (host db user password &optional port options tty))
94 (destructuring-bind (host db user password &optional port options tty)
96 (declare (ignore password options tty))
100 (pathname (namestring host))
106 (integer (write-to-string port))
111 (defmethod database-connect (connection-spec (database-type (eql :postgresql)))
112 (check-connection-spec connection-spec database-type
113 (host db user password &optional port options tty))
114 (destructuring-bind (host db user password &optional port options tty)
116 (uffi:with-cstrings ((host-native host)
118 (password-native password)
121 (options-native options)
123 (let ((connection (PQsetdbLogin host-native port-native
124 options-native tty-native
125 db-native user-native
127 (declare (type pgsql-conn-def connection))
128 (when (not (eq (PQstatus connection)
129 pgsql-conn-status-type#connection-ok))
130 (error 'clsql-connect-error
131 :database-type database-type
132 :connection-spec connection-spec
133 :errno (PQstatus connection)
134 :error (tidy-error-message
135 (PQerrorMessage connection))))
136 (make-instance 'postgresql-database
137 :name (database-name-from-spec connection-spec
139 :database-type :postgresql
140 :connection-spec connection-spec
141 :conn-ptr connection)))))
144 (defmethod database-disconnect ((database postgresql-database))
145 (PQfinish (database-conn-ptr database))
146 (setf (database-conn-ptr database) nil)
149 (defmethod database-query (query-expression (database postgresql-database) result-types field-names)
150 (let ((conn-ptr (database-conn-ptr database)))
151 (declare (type pgsql-conn-def conn-ptr))
152 (uffi:with-cstring (query-native query-expression)
153 (let ((result (PQexec conn-ptr query-native)))
154 (when (uffi:null-pointer-p result)
155 (error 'clsql-sql-error
157 :expression query-expression
159 :error (tidy-error-message (PQerrorMessage conn-ptr))))
161 (case (PQresultStatus result)
162 (#.pgsql-exec-status-type#empty-query
164 (#.pgsql-exec-status-type#tuples-ok
165 (let ((num-fields (PQnfields result)))
167 (canonicalize-types result-types num-fields
170 (loop for tuple-index from 0 below (PQntuples result)
172 (loop for i from 0 below num-fields
174 (if (zerop (PQgetisnull result tuple-index i))
176 (PQgetvalue result tuple-index i)
180 (result-field-names num-fields result)))))
182 (error 'clsql-sql-error
184 :expression query-expression
185 :errno (PQresultStatus result)
186 :error (tidy-error-message
187 (PQresultErrorMessage result)))))
188 (PQclear result))))))
190 (defun result-field-names (num-fields result)
191 "Return list of result field names."
193 (dotimes (i num-fields (nreverse names))
195 (push (uffi:convert-from-cstring (PQfname result i)) names))))
197 (defmethod database-execute-command (sql-expression
198 (database postgresql-database))
199 (let ((conn-ptr (database-conn-ptr database)))
200 (declare (type pgsql-conn-def conn-ptr))
201 (uffi:with-cstring (sql-native sql-expression)
202 (let ((result (PQexec conn-ptr sql-native)))
203 (when (uffi:null-pointer-p result)
204 (error 'clsql-sql-error
206 :expression sql-expression
208 :error (tidy-error-message (PQerrorMessage conn-ptr))))
210 (case (PQresultStatus result)
211 (#.pgsql-exec-status-type#command-ok
213 ((#.pgsql-exec-status-type#empty-query
214 #.pgsql-exec-status-type#tuples-ok)
215 (warn "Strange result...")
218 (error 'clsql-sql-error
220 :expression sql-expression
221 :errno (PQresultStatus result)
222 :error (tidy-error-message
223 (PQresultErrorMessage result)))))
224 (PQclear result))))))
226 (defstruct postgresql-result-set
227 (res-ptr (uffi:make-null-pointer 'pgsql-result)
228 :type pgsql-result-def)
230 (num-tuples 0 :type integer)
231 (num-fields 0 :type integer)
232 (tuple-index 0 :type integer))
234 (defmethod database-query-result-set ((query-expression string)
235 (database postgresql-database)
236 &key full-set result-types)
237 (let ((conn-ptr (database-conn-ptr database)))
238 (declare (type pgsql-conn-def conn-ptr))
239 (uffi:with-cstring (query-native query-expression)
240 (let ((result (PQexec conn-ptr query-native)))
241 (when (uffi:null-pointer-p result)
242 (error 'clsql-sql-error
244 :expression query-expression
246 :error (tidy-error-message (PQerrorMessage conn-ptr))))
247 (case (PQresultStatus result)
248 ((#.pgsql-exec-status-type#empty-query
249 #.pgsql-exec-status-type#tuples-ok)
250 (let ((result-set (make-postgresql-result-set
252 :num-fields (PQnfields result)
253 :num-tuples (PQntuples result)
254 :types (canonicalize-types
263 (PQnfields result)))))
266 (error 'clsql-sql-error
268 :expression query-expression
269 :errno (PQresultStatus result)
270 :error (tidy-error-message
271 (PQresultErrorMessage result)))
272 (PQclear result))))))))
274 (defmethod database-dump-result-set (result-set (database postgresql-database))
275 (let ((res-ptr (postgresql-result-set-res-ptr result-set)))
276 (declare (type pgsql-result-def res-ptr))
280 (defmethod database-store-next-row (result-set (database postgresql-database)
282 (let ((result (postgresql-result-set-res-ptr result-set))
283 (types (postgresql-result-set-types result-set)))
284 (declare (type pgsql-result-def result))
285 (if (>= (postgresql-result-set-tuple-index result-set)
286 (postgresql-result-set-num-tuples result-set))
288 (loop with tuple-index = (postgresql-result-set-tuple-index result-set)
289 for i from 0 below (postgresql-result-set-num-fields result-set)
293 (if (zerop (PQgetisnull result tuple-index i))
295 (PQgetvalue result tuple-index i)
299 (incf (postgresql-result-set-tuple-index result-set))
302 ;;; Large objects support (Marc B)
304 (defmethod database-create-large-object ((database postgresql-database))
305 (lo-create (database-conn-ptr database)
306 (logior postgresql::+INV_WRITE+ postgresql::+INV_READ+)))
310 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
311 (let ((ptr (database-conn-ptr database))
312 (length (length data))
315 (with-transaction (:database database)
318 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
320 (when (= (lo-write ptr fd data length) length)
323 (when (and fd (>= fd 0))
328 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
329 (let ((ptr (database-conn-ptr database))
330 (length (length data))
333 (database-execute-command "begin" database)
336 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
338 (when (= (lo-write ptr fd data length) length)
341 (when (and fd (>= fd 0))
343 (database-execute-command (if result "commit" "rollback") database)))
346 ;; (MB) the begin/commit/rollback stuff will be removed when with-transaction wil be implemented
347 ;; (KMR) Can't use with-transaction since that function is in high-level code
348 (defmethod database-read-large-object (object-id (database postgresql-database))
349 (let ((ptr (database-conn-ptr database))
356 (database-execute-command "begin" database)
357 (setf fd (lo-open ptr object-id postgresql::+INV_READ+))
359 (setf length (lo-lseek ptr fd 0 2))
360 (lo-lseek ptr fd 0 0)
362 (setf buffer (uffi:allocate-foreign-string
364 (when (= (lo-read ptr fd buffer length) length)
365 (setf result (uffi:convert-from-foreign-string
366 buffer :length length :null-terminated-p nil))))))
368 (when buffer (uffi:free-foreign-object buffer))
369 (when (and fd (>= fd 0)) (lo-close ptr fd))
370 (database-execute-command (if result "commit" "rollback") database)))
373 (defmethod database-delete-large-object (object-id (database postgresql-database))
374 (lo-unlink (database-conn-ptr database) object-id))
379 (defun owner-clause (owner)
384 " AND (relowner=(SELECT usesysid FROM pg_user WHERE (usename='~A')))"
387 (format nil " AND (NOT (relowner=1))"))
390 (defun database-list-objects-of-type (database type owner)
394 "SELECT relname FROM pg_class WHERE (relkind = '~A')~A"
396 (owner-clause owner))
399 (defmethod database-list-tables ((database postgresql-database)
401 (database-list-objects-of-type database "r" owner))
403 (defmethod database-list-views ((database postgresql-database)
405 (database-list-objects-of-type database "v" owner))
407 (defmethod database-list-indexes ((database postgresql-database)
409 (database-list-objects-of-type database "i" owner))
412 (defmethod database-list-table-indexes (table (database postgresql-database)
418 "select indexrelid from pg_index where indrelid=(select relfilenode from pg_class where relname='~A'~A)"
419 (string-downcase table)
420 (owner-clause owner))
423 (dolist (indexrelid indexrelids (nreverse result))
425 (caar (database-query
426 (format nil "select relname from pg_class where relfilenode='~A'"
431 (defmethod database-list-attributes ((table string)
432 (database postgresql-database)
435 (cond ((stringp owner)
436 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
437 ((null owner) " AND (not (relowner=1))")
442 (format nil "SELECT attname FROM pg_class,pg_attribute WHERE pg_class.oid=attrelid AND relname='~A'~A"
443 (string-downcase table)
447 (remove-if #'(lambda (it) (member it '("cmin"
453 ;; kmr -- added tableoid
454 "tableoid") :test #'equal))
457 (defmethod database-attribute-type (attribute (table string)
458 (database postgresql-database)
460 (let ((row (car (database-query
461 (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"
462 (string-downcase table)
463 (string-downcase attribute)
464 (owner-clause owner))
468 (ensure-keyword (first row))
469 (if (string= "-1" (second row))
470 (- (parse-integer (third row) :junk-allowed t) 4)
471 (parse-integer (second row)))
473 (if (string-equal "f" (fourth row))
477 (defmethod database-create-sequence (sequence-name
478 (database postgresql-database))
479 (database-execute-command
480 (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
483 (defmethod database-drop-sequence (sequence-name
484 (database postgresql-database))
485 (database-execute-command
486 (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name)) database))
488 (defmethod database-list-sequences ((database postgresql-database)
490 (database-list-objects-of-type database "S" owner))
492 (defmethod database-set-sequence-position (name (position integer)
493 (database postgresql-database))
498 (format nil "SELECT SETVAL ('~A', ~A)" name position)
499 database nil nil)))))
501 (defmethod database-sequence-next (sequence-name
502 (database postgresql-database))
507 (concatenate 'string "SELECT NEXTVAL ('" (sql-escape sequence-name) "')")
508 database nil nil)))))
510 (defmethod database-sequence-last (sequence-name (database postgresql-database))
515 (concatenate 'string "SELECT LAST_VALUE ('" sequence-name "')")
516 database nil nil)))))
518 (defmethod database-create (connection-spec (type (eql :postgresql)))
519 (destructuring-bind (host name user password) connection-spec
520 (declare (ignore user password))
521 (multiple-value-bind (output status)
522 (clsql-sys:command-output "createdb -h~A ~A"
523 (if host host "localhost")
525 (if (or (not (zerop status))
526 (search "database creation failed: ERROR:" output))
527 (error 'clsql-access-error
528 :connection-spec connection-spec
531 (format nil "database-create failed: ~A"
535 (defmethod database-destroy (connection-spec (type (eql :postgresql)))
536 (destructuring-bind (host name user password) connection-spec
537 (declare (ignore user password))
538 (multiple-value-bind (output status)
539 (clsql-sys:command-output "dropdb -h~A ~A"
540 (if host host "localhost")
542 (if (or (not (zerop status))
543 (search "database removal failed: ERROR:" output))
544 (error 'clsql-access-error
545 :connection-spec connection-spec
548 (format nil "database-destory failed: ~A"
553 (defmethod database-probe (connection-spec (type (eql :postgresql)))
554 (when (find (second connection-spec) (database-list connection-spec type)
555 :key #'car :test #'string-equal)
558 (defmethod database-list (connection-spec (type (eql :postgresql)))
559 (destructuring-bind (host name user password) connection-spec
560 (declare (ignore name))
561 (let ((database (database-connect (list host "template1" user password)
565 (setf (slot-value database 'clsql-sys::state) :open)
566 (mapcar #'car (database-query "select datname from pg_database"
569 (database-disconnect database)
570 (setf (slot-value database 'clsql-sys::state) :closed))))))
572 (defmethod database-describe-table ((database postgresql-database) table)
574 (format nil "select a.attname, t.typname
575 from pg_class c, pg_attribute a, pg_type t
576 where c.relname = '~a'
578 and a.attrelid = c.oid
579 and a.atttypid = t.oid"
580 (sql-escape (string-downcase table)))
583 (defun %pg-database-connection (connection-spec)
584 (check-connection-spec connection-spec :postgresql
585 (host db user password &optional port options tty))
586 (macrolet ((coerce-string (var)
587 `(unless (typep ,var 'simple-base-string)
588 (setf ,var (coerce ,var 'simple-base-string)))))
589 (destructuring-bind (host db user password &optional port options tty)
593 (let ((connection (PQsetdbLogin host port options tty db user password)))
594 (declare (type postgresql::pgsql-conn-ptr connection))
595 (unless (eq (PQstatus connection) :connection-ok)
597 (error 'clsql-connect-error
598 :database-type :postgresql
599 :connection-spec connection-spec
600 :errno (PQstatus connection)
601 :error (PQerrorMessage connection)))
604 (defmethod database-reconnect ((database postgresql-database))
605 (let ((lock (database-lock database)))
606 (with-process-lock (lock "Reconnecting")
607 (with-slots (connection-spec conn-ptr)
609 (setf conn-ptr (%pg-database-connection connection-spec))
612 ;;; Database capabilities
614 (defmethod db-type-has-fancy-math? ((db-type (eql :postgresql)))
617 (defmethod db-type-default-case ((db-type (eql :postgresql)))
620 (when (clsql-sys:database-type-library-loaded :postgresql)
621 (clsql-sys:initialize-database-type :database-type :postgresql))