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 (generic-postgresql-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 'sql-connection-error
131 :database-type database-type
132 :connection-spec connection-spec
133 :error-id (PQstatus connection)
134 :message (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 'sql-database-data-error
157 :expression query-expression
158 :message (tidy-error-message (PQerrorMessage conn-ptr))))
160 (case (PQresultStatus result)
161 ;; User gave a command rather than a query
162 (#.pgsql-exec-status-type#command-ok
164 (#.pgsql-exec-status-type#empty-query
166 (#.pgsql-exec-status-type#tuples-ok
167 (let ((num-fields (PQnfields result)))
169 (canonicalize-types result-types num-fields
172 (loop for tuple-index from 0 below (PQntuples result)
174 (loop for i from 0 below num-fields
176 (if (zerop (PQgetisnull result tuple-index i))
178 (PQgetvalue result tuple-index i)
182 (result-field-names num-fields result)))))
184 (error 'sql-database-data-error
186 :expression query-expression
187 :error-id (PQresultStatus result)
188 :message (tidy-error-message
189 (PQresultErrorMessage result)))))
190 (PQclear result))))))
192 (defun result-field-names (num-fields result)
193 "Return list of result field names."
195 (dotimes (i num-fields (nreverse names))
197 (push (uffi:convert-from-cstring (PQfname result i)) names))))
199 (defmethod database-execute-command (sql-expression
200 (database postgresql-database))
201 (let ((conn-ptr (database-conn-ptr database)))
202 (declare (type pgsql-conn-def conn-ptr))
203 (uffi:with-cstring (sql-native sql-expression)
204 (let ((result (PQexec conn-ptr sql-native)))
205 (when (uffi:null-pointer-p result)
206 (error 'sql-database-data-error
208 :expression sql-expression
209 :message (tidy-error-message (PQerrorMessage conn-ptr))))
211 (case (PQresultStatus result)
212 (#.pgsql-exec-status-type#command-ok
214 ((#.pgsql-exec-status-type#empty-query
215 #.pgsql-exec-status-type#tuples-ok)
216 (warn "Strange result...")
219 (error 'sql-database-data-error
221 :expression sql-expression
222 :error-id (PQresultStatus result)
223 :message (tidy-error-message
224 (PQresultErrorMessage result)))))
225 (PQclear result))))))
227 (defstruct postgresql-result-set
228 (res-ptr (uffi:make-null-pointer 'pgsql-result)
229 :type pgsql-result-def)
231 (num-tuples 0 :type integer)
232 (num-fields 0 :type integer)
233 (tuple-index 0 :type integer))
235 (defmethod database-query-result-set ((query-expression string)
236 (database postgresql-database)
237 &key full-set result-types)
238 (let ((conn-ptr (database-conn-ptr database)))
239 (declare (type pgsql-conn-def conn-ptr))
240 (uffi:with-cstring (query-native query-expression)
241 (let ((result (PQexec conn-ptr query-native)))
242 (when (uffi:null-pointer-p result)
243 (error 'sql-database-data-error
245 :expression query-expression
246 :message (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 'sql-database-data-error
268 :expression query-expression
269 :error-id (PQresultStatus result)
270 :message (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))
381 (defmethod database-create (connection-spec (type (eql :postgresql)))
382 (destructuring-bind (host name user password) connection-spec
383 (declare (ignore user password))
384 (multiple-value-bind (output status)
385 (clsql-sys:command-output "createdb -h~A ~A"
386 (if host host "localhost")
388 (if (or (not (zerop status))
389 (search "database creation failed: ERROR:" output))
390 (error 'sql-database-error
392 (format nil "createdb failed for postgresql backend with connection spec ~A."
396 (defmethod database-destroy (connection-spec (type (eql :postgresql)))
397 (destructuring-bind (host name user password) connection-spec
398 (declare (ignore user password))
399 (multiple-value-bind (output status)
400 (clsql-sys:command-output "dropdb -h~A ~A"
401 (if host host "localhost")
403 (if (or (not (zerop status))
404 (search "database removal failed: ERROR:" output))
405 (error 'sql-database-error
407 (format nil "dropdb failed for postgresql backend with connection spec ~A."
412 (defmethod database-probe (connection-spec (type (eql :postgresql)))
413 (when (find (second connection-spec) (database-list connection-spec type)
414 :key #'car :test #'string-equal)
418 (defun %pg-database-connection (connection-spec)
419 (check-connection-spec connection-spec :postgresql
420 (host db user password &optional port options tty))
421 (macrolet ((coerce-string (var)
422 `(unless (typep ,var 'simple-base-string)
423 (setf ,var (coerce ,var 'simple-base-string)))))
424 (destructuring-bind (host db user password &optional port options tty)
428 (let ((connection (PQsetdbLogin host port options tty db user password)))
429 (declare (type postgresql::pgsql-conn-ptr connection))
430 (unless (eq (PQstatus connection) :connection-ok)
432 (error 'sql-connection-error
433 :database-type :postgresql
434 :connection-spec connection-spec
435 :error-id (PQstatus connection)
436 :message (PQerrorMessage connection)))
439 (defmethod database-reconnect ((database postgresql-database))
440 (let ((lock (database-lock database)))
441 (with-process-lock (lock "Reconnecting")
442 (with-slots (connection-spec conn-ptr)
444 (setf conn-ptr (%pg-database-connection connection-spec))
447 ;;; Database capabilities
449 (when (clsql-sys:database-type-library-loaded :postgresql)
450 (clsql-sys:initialize-database-type :database-type :postgresql))