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-base-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
82 :type pgsql-conn-def)))
84 (defmethod database-type ((database postgresql-database))
87 (defmethod database-name-from-spec (connection-spec (database-type
89 (check-connection-spec connection-spec database-type
90 (host db user password &optional port options tty))
91 (destructuring-bind (host db user password &optional port options tty)
93 (declare (ignore password options tty))
97 (pathname (namestring host))
103 (integer (write-to-string port))
108 (defmethod database-connect (connection-spec (database-type (eql :postgresql)))
109 (check-connection-spec connection-spec database-type
110 (host db user password &optional port options tty))
111 (destructuring-bind (host db user password &optional port options tty)
113 (uffi:with-cstrings ((host-native host)
115 (password-native password)
118 (options-native options)
120 (let ((connection (PQsetdbLogin host-native port-native
121 options-native tty-native
122 db-native user-native
124 (declare (type pgsql-conn-def connection))
125 (when (not (eq (PQstatus connection)
126 pgsql-conn-status-type#connection-ok))
127 (error 'clsql-connect-error
128 :database-type database-type
129 :connection-spec connection-spec
130 :errno (PQstatus connection)
131 :error (tidy-error-message
132 (PQerrorMessage connection))))
133 (make-instance 'postgresql-database
134 :name (database-name-from-spec connection-spec
136 :connection-spec connection-spec
137 :conn-ptr connection)))))
140 (defmethod database-disconnect ((database postgresql-database))
141 (PQfinish (database-conn-ptr database))
142 (setf (database-conn-ptr database) nil)
145 (defmethod database-query (query-expression (database postgresql-database) result-types)
146 (let ((conn-ptr (database-conn-ptr database)))
147 (declare (type pgsql-conn-def conn-ptr))
148 (uffi:with-cstring (query-native query-expression)
149 (let ((result (PQexec conn-ptr query-native)))
150 (when (uffi:null-pointer-p result)
151 (error 'clsql-sql-error
153 :expression query-expression
155 :error (tidy-error-message (PQerrorMessage conn-ptr))))
157 (case (PQresultStatus result)
158 (#.pgsql-exec-status-type#empty-query
160 (#.pgsql-exec-status-type#tuples-ok
161 (let ((num-fields (PQnfields result)))
163 (canonicalize-types result-types num-fields
165 (loop for tuple-index from 0 below (PQntuples result)
167 (loop for i from 0 below num-fields
169 (if (zerop (PQgetisnull result tuple-index i))
171 (PQgetvalue result tuple-index i)
175 (error 'clsql-sql-error
177 :expression query-expression
178 :errno (PQresultStatus result)
179 :error (tidy-error-message
180 (PQresultErrorMessage result)))))
181 (PQclear result))))))
183 (defmethod database-execute-command (sql-expression
184 (database postgresql-database))
185 (let ((conn-ptr (database-conn-ptr database)))
186 (declare (type pgsql-conn-def conn-ptr))
187 (uffi:with-cstring (sql-native sql-expression)
188 (let ((result (PQexec conn-ptr sql-native)))
189 (when (uffi:null-pointer-p result)
190 (error 'clsql-sql-error
192 :expression sql-expression
194 :error (tidy-error-message (PQerrorMessage conn-ptr))))
196 (case (PQresultStatus result)
197 (#.pgsql-exec-status-type#command-ok
199 ((#.pgsql-exec-status-type#empty-query
200 #.pgsql-exec-status-type#tuples-ok)
201 (warn "Strange result...")
204 (error 'clsql-sql-error
206 :expression sql-expression
207 :errno (PQresultStatus result)
208 :error (tidy-error-message
209 (PQresultErrorMessage result)))))
210 (PQclear result))))))
212 (defstruct postgresql-result-set
213 (res-ptr (uffi:make-null-pointer 'pgsql-result)
214 :type pgsql-result-def)
216 (num-tuples 0 :type integer)
217 (num-fields 0 :type integer)
218 (tuple-index 0 :type integer))
220 (defmethod database-query-result-set ((query-expression string)
221 (database postgresql-database)
222 &key full-set result-types)
223 (let ((conn-ptr (database-conn-ptr database)))
224 (declare (type pgsql-conn-def conn-ptr))
225 (uffi:with-cstring (query-native query-expression)
226 (let ((result (PQexec conn-ptr query-native)))
227 (when (uffi:null-pointer-p result)
228 (error 'clsql-sql-error
230 :expression query-expression
232 :error (tidy-error-message (PQerrorMessage conn-ptr))))
233 (case (PQresultStatus result)
234 ((#.pgsql-exec-status-type#empty-query
235 #.pgsql-exec-status-type#tuples-ok)
236 (let ((result-set (make-postgresql-result-set
238 :num-fields (PQnfields result)
239 :num-tuples (PQntuples result)
240 :types (canonicalize-types
249 (PQnfields result)))))
252 (error 'clsql-sql-error
254 :expression query-expression
255 :errno (PQresultStatus result)
256 :error (tidy-error-message
257 (PQresultErrorMessage result)))
258 (PQclear result))))))))
260 (defmethod database-dump-result-set (result-set (database postgresql-database))
261 (let ((res-ptr (postgresql-result-set-res-ptr result-set)))
262 (declare (type pgsql-result-def res-ptr))
266 (defmethod database-store-next-row (result-set (database postgresql-database)
268 (let ((result (postgresql-result-set-res-ptr result-set))
269 (types (postgresql-result-set-types result-set)))
270 (declare (type pgsql-result-def result))
271 (if (>= (postgresql-result-set-tuple-index result-set)
272 (postgresql-result-set-num-tuples result-set))
274 (loop with tuple-index = (postgresql-result-set-tuple-index result-set)
275 for i from 0 below (postgresql-result-set-num-fields result-set)
279 (if (zerop (PQgetisnull result tuple-index i))
281 (PQgetvalue result tuple-index i)
285 (incf (postgresql-result-set-tuple-index result-set))
288 ;;; Large objects support (Marc B)
290 (defmethod database-create-large-object ((database postgresql-database))
291 (lo-create (database-conn-ptr database)
292 (logior postgresql::+INV_WRITE+ postgresql::+INV_READ+)))
296 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
297 (let ((ptr (database-conn-ptr database))
298 (length (length data))
301 (with-transaction (:database database)
304 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
306 (when (= (lo-write ptr fd data length) length)
309 (when (and fd (>= fd 0))
314 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
315 (let ((ptr (database-conn-ptr database))
316 (length (length data))
319 (database-execute-command "begin" database)
322 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
324 (when (= (lo-write ptr fd data length) length)
327 (when (and fd (>= fd 0))
329 (database-execute-command (if result "commit" "rollback") database)))
332 ;; (MB) the begin/commit/rollback stuff will be removed when with-transaction wil be implemented
333 ;; (KMR) Can't use with-transaction since that function is in high-level code
334 (defmethod database-read-large-object (object-id (database postgresql-database))
335 (let ((ptr (database-conn-ptr database))
342 (database-execute-command "begin" database)
343 (setf fd (lo-open ptr object-id postgresql::+INV_READ+))
345 (setf length (lo-lseek ptr fd 0 2))
346 (lo-lseek ptr fd 0 0)
348 (setf buffer (uffi:allocate-foreign-string
350 (when (= (lo-read ptr fd buffer length) length)
351 (setf result (uffi:convert-from-foreign-string
352 buffer :length length :null-terminated-p nil))))))
354 (when buffer (uffi:free-foreign-object buffer))
355 (when (and fd (>= fd 0)) (lo-close ptr fd))
356 (database-execute-command (if result "commit" "rollback") database)))
359 (defmethod database-delete-large-object (object-id (database postgresql-database))
360 (lo-unlink (database-conn-ptr database) object-id))
365 (defmethod database-list-objects-of-type ((database postgresql-database)
368 (cond ((stringp owner)
369 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE (usename='~A')))" owner))
371 (format nil " AND (NOT (relowner=1))"))
376 "SELECT relname FROM pg_class WHERE (relkind = '~A')~A"
381 (defmethod database-list-tables ((database postgresql-database)
383 (database-list-objects-of-type database "r" owner))
385 (defmethod database-list-views ((database postgresql-database)
387 (database-list-objects-of-type database "v" owner))
389 (defmethod database-list-indexes ((database postgresql-database)
391 (database-list-objects-of-type database "i" owner))
393 (defmethod database-list-attributes ((table string)
394 (database postgresql-database)
397 (cond ((stringp owner)
398 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
399 ((null owner) " AND (not (relowner=1))")
404 (format nil "SELECT attname FROM pg_class,pg_attribute WHERE pg_class.oid=attrelid AND relname='~A'~A"
405 (string-downcase table)
410 (remove-if #'(lambda (it) (member it '("cmin"
416 ;; kmr -- added tableoid
417 "tableoid") :test #'equal))
420 (defmethod database-attribute-type (attribute (table string)
421 (database postgresql-database)
424 (cond ((stringp owner)
425 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
426 ((null owner) " AND (not (relowner=1))")
431 (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"
432 (string-downcase table)
433 (string-downcase attribute)
437 (intern (string-upcase (car result)) :keyword))))
439 (defmethod database-create-sequence (sequence-name
440 (database postgresql-database))
441 (database-execute-command
442 (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
445 (defmethod database-drop-sequence (sequence-name
446 (database postgresql-database))
447 (database-execute-command
448 (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name)) database))
450 (defmethod database-list-sequences ((database postgresql-database)
452 (database-list-objects-of-type database "S" owner))
454 (defmethod database-set-sequence-position (name (position integer)
455 (database postgresql-database))
460 (format nil "SELECT SETVAL ('~A', ~A)" name position)
463 (defmethod database-sequence-next (sequence-name
464 (database postgresql-database))
469 (concatenate 'string "SELECT NEXTVAL ('" (sql-escape sequence-name) "')")
472 (defmethod database-sequence-last (sequence-name (database postgresql-database))
477 (concatenate 'string "SELECT LAST_VALUE ('" sequence-name "')")
480 (defmethod database-create (connection-spec (type (eql :postgresql)))
481 (destructuring-bind (host name user password) connection-spec
482 (declare (ignore user password))
483 (multiple-value-bind (output status)
484 (clsql-base-sys:command-output "createdb -h~A ~A"
485 (if host host "localhost")
487 (if (or (not (zerop status))
488 (search "database creation failed: ERROR:" output))
489 (error 'clsql-access-error
490 :connection-spec connection-spec
493 (format nil "database-create failed: ~A"
497 (defmethod database-destroy (connection-spec (type (eql :postgresql)))
498 (destructuring-bind (host name user password) connection-spec
499 (declare (ignore user password))
500 (multiple-value-bind (output status)
501 (clsql-base-sys:command-output "dropdb -h~A ~A"
502 (if host host "localhost")
504 (if (or (not (zerop status))
505 (search "database removal failed: ERROR:" output))
506 (error 'clsql-access-error
507 :connection-spec connection-spec
510 (format nil "database-destory failed: ~A"
515 (defmethod database-probe (connection-spec (type (eql :postgresql)))
516 (destructuring-bind (host name user password) connection-spec
517 (let ((database (database-connect (list host "template1" user password)
521 (find name (database-query "select datname from pg_database"
523 :key #'car :test #'string-equal)
525 (database-disconnect database)))))
528 (when (clsql-base-sys:database-type-library-loaded :postgresql)
529 (clsql-base-sys:initialize-database-type :database-type :postgresql))