1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
4 ;;;; Generic postgresql layer, used by db-postgresql and db-postgresql-socket
6 ;;;; This file is part of CLSQL.
8 ;;;; CLSQL users are granted the rights to distribute and use this software
9 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
10 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
11 ;;;; *************************************************************************
13 (in-package #:clsql-sys)
15 (defclass generic-postgresql-database (database)
16 ((has-table-pg_roles :type boolean :reader has-table-pg_roles :initform nil))
17 (:documentation "Encapsulate same behavior across postgresql and postgresql-socket backends."))
23 (defmethod database-get-type-specifier (type args database
24 (db-type (eql :postgresql)))
25 (declare (ignore type args database))
28 (defmethod database-get-type-specifier ((type (eql 'string)) args database
29 (db-type (eql :postgresql)))
30 (declare (ignore database))
32 (format nil "CHAR(~A)" (car args))
35 (defmethod database-get-type-specifier ((type (eql 'tinyint)) args database
36 (db-type (eql :postgresql)))
37 (declare (ignore args database))
40 (defmethod database-get-type-specifier ((type (eql 'smallint)) args database
41 (db-type (eql :postgresql)))
42 (declare (ignore args database))
45 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database
46 (db-type (eql :postgresql)))
47 (declare (ignore args database))
48 "TIMESTAMP WITHOUT TIME ZONE")
50 (defmethod database-get-type-specifier ((type (eql 'number)) args database
51 (db-type (eql :postgresql)))
52 (declare (ignore database))
54 ((and (consp args) (= (length args) 2))
55 (format nil "NUMERIC(~D,~D)" (first args) (second args)))
56 ((and (consp args) (= (length args) 1))
57 (format nil "NUMERIC(~D)" (first args)))
63 (defun owner-clause (owner)
68 " AND (relowner=(SELECT usesysid FROM pg_user WHERE (usename='~A')))"
71 (format nil " AND (relowner<>(SELECT usesysid FROM pg_user WHERE usename='postgres'))"))
74 (defun has-table (name database)
77 (format nil "SELECT relname FROM pg_class WHERE relname='~A'"
80 (if (and (stringp name-retrieved) (plusp (length name-retrieved)))
84 (defmethod slot-unbound (class (obj generic-postgresql-database)
85 (slot (eql 'has-table-pg_roles)))
86 ;; Lazily cache slot value
87 (declare (ignore class))
88 (setf (slot-value obj 'has-table-pg_roles) (has-table "pg_roles" obj)))
90 (defun database-list-objects-of-type (database type owner)
94 (if (and (has-table-pg_roles database)
95 (not (eq owner :all)))
98 FROM pg_catalog.pg_class c
99 LEFT JOIN pg_catalog.pg_roles r ON r.oid = c.relowner
100 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
101 WHERE c.relkind IN ('~A','')
102 AND n.nspname NOT IN ('pg_catalog', 'pg_toast')
103 AND pg_catalog.pg_table_is_visible(c.oid)
105 "SELECT relname FROM pg_class WHERE (relkind =
108 (owner-clause owner))
111 (defmethod database-list-tables ((database generic-postgresql-database)
113 (database-list-objects-of-type database "r" owner))
115 (defmethod database-list-views ((database generic-postgresql-database)
117 (database-list-objects-of-type database "v" owner))
119 (defmethod database-list-indexes ((database generic-postgresql-database)
121 (database-list-objects-of-type database "i" owner))
124 (defmethod database-list-table-indexes (table (database generic-postgresql-database)
130 "select indexrelid from pg_index where indrelid=(select relfilenode from pg_class where relname='~A'~A)"
131 (string-downcase table)
132 (owner-clause owner))
135 (dolist (indexrelid indexrelids (nreverse result))
137 (caar (database-query
138 (format nil "select relname from pg_class where relfilenode='~A'"
143 (defmethod database-list-attributes ((table string)
144 (database generic-postgresql-database)
147 (cond ((stringp owner)
148 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
149 ((null owner) " AND (not (relowner=1))")
154 (format nil "SELECT attname FROM pg_class,pg_attribute WHERE pg_class.oid=attrelid AND attisdropped = FALSE AND relname='~A'~A"
155 (string-downcase table)
159 (remove-if #'(lambda (it) (member it '("cmin"
165 ;; kmr -- added tableoid
166 "tableoid") :test #'equal))
169 (defmethod database-attribute-type (attribute (table string)
170 (database generic-postgresql-database)
172 (let ((row (car (database-query
173 (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"
174 (string-downcase table)
175 (string-downcase attribute)
176 (owner-clause owner))
179 (destructuring-bind (typname attlen atttypmod attnull) row
181 (setf attlen (parse-integer attlen :junk-allowed t)
182 atttypmod (parse-integer atttypmod :junk-allowed t))
184 (let ((coltype (ensure-keyword typname))
185 (colnull (if (string-equal "f" attnull) 1 0))
188 (setf (values collen colprec)
193 (values (ash (- atttypmod 4) -16)
194 (boole boole-and (- atttypmod 4) #xffff))))
197 (cond ((and (= -1 attlen) (= -1 atttypmod)) nil)
198 ((= -1 attlen) (- atttypmod 4))
201 (values coltype collen colprec colnull))))))
203 (defmethod database-create-sequence (sequence-name
204 (database generic-postgresql-database))
205 (database-execute-command
206 (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
209 (defmethod database-drop-sequence (sequence-name
210 (database generic-postgresql-database))
211 (database-execute-command
212 (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name)) database))
214 (defmethod database-list-sequences ((database generic-postgresql-database)
216 (database-list-objects-of-type database "S" owner))
218 (defmethod database-set-sequence-position (name (position integer)
219 (database generic-postgresql-database))
224 (format nil "SELECT SETVAL ('~A', ~A)" name position)
225 database nil nil)))))
227 (defmethod database-sequence-next (sequence-name
228 (database generic-postgresql-database))
233 (concatenate 'string "SELECT NEXTVAL ('" (sql-escape sequence-name) "')")
234 database nil nil)))))
236 (defmethod database-sequence-last (sequence-name (database generic-postgresql-database))
241 (concatenate 'string "SELECT LAST_VALUE FROM " sequence-name)
242 database nil nil)))))
244 (defmethod database-last-auto-increment-id ((database generic-postgresql-database) table column)
245 (let (column-helper seq-name)
247 (sql-ident (setf table (slot-value table 'name)))
248 (standard-db-class (setf table (view-table table))))
250 (sql-ident (setf column-helper (slot-value column 'name)))
251 (view-class-slot-definition-mixin
252 (setf column-helper (view-class-slot-column column))))
253 (setq seq-name (or (view-class-slot-autoincrement-sequence column)
254 (convert-to-db-default-case (format nil "~a_~a_seq" table column-helper) database)))
255 (first (clsql:query (format nil "SELECT currval ('~a')" seq-name)
258 :result-types '(:int)))))
260 (defmethod database-generate-column-definition (class slotdef (database generic-postgresql-database))
261 ; handle autoincr slots special
262 (when (or (and (listp (view-class-slot-db-constraints slotdef))
263 (member :auto-increment (view-class-slot-db-constraints slotdef)))
264 (eql :auto-increment (view-class-slot-db-constraints slotdef))
265 (slot-value slotdef 'autoincrement-sequence))
266 (let ((sequence-name (database-make-autoincrement-sequence class slotdef database)))
267 (setf (view-class-slot-autoincrement-sequence slotdef) sequence-name)
268 (cond ((listp (view-class-slot-db-constraints slotdef))
269 (setf (view-class-slot-db-constraints slotdef)
270 (remove :auto-increment
271 (view-class-slot-db-constraints slotdef)))
272 (unless (member :default (view-class-slot-db-constraints slotdef))
273 (setf (view-class-slot-db-constraints slotdef)
275 (list :default (format nil "nextval('~a')" sequence-name))
276 (view-class-slot-db-constraints slotdef)))))
278 (setf (view-class-slot-db-constraints slotdef)
279 (list :default (format nil "nextval('~a')" sequence-name)))))))
280 (call-next-method class slotdef database))
282 (defmethod database-make-autoincrement-sequence (table column (database generic-postgresql-database))
283 (let* ((table-name (view-table table))
284 (column-name (view-class-slot-column column))
285 (sequence-name (or (slot-value column 'autoincrement-sequence)
286 (convert-to-db-default-case
287 (format nil "~a_~a_SEQ" table-name column-name) database))))
288 (unless (sequence-exists-p sequence-name :database database)
289 (database-create-sequence sequence-name database))
292 (defun postgresql-database-list (connection-spec type)
293 (destructuring-bind (host name &rest other-args) connection-spec
294 (declare (ignore name))
295 (let ((database (database-connect (list* host "template1" other-args)
299 (setf (slot-value database 'clsql-sys::state) :open)
300 (mapcar #'car (database-query "select datname from pg_database"
303 (database-disconnect database)
304 (setf (slot-value database 'clsql-sys::state) :closed))))))
306 (defmethod database-list (connection-spec (type (eql :postgresql)))
307 (postgresql-database-list connection-spec type))
309 (defmethod database-list (connection-spec (type (eql :postgresql-socket)))
310 (postgresql-database-list connection-spec type))
313 (defmethod database-describe-table ((database generic-postgresql-database) table)
314 ;; MTP: LIST-ATTRIBUTE-TYPES currently executes separate queries for
315 ;; each attribute. It would be more efficient to have a single SQL
316 ;; query return the type data for all attributes. This code is
317 ;; retained as an example of how to do this for PostgreSQL.
319 (format nil "select a.attname, t.typname
320 from pg_class c, pg_attribute a, pg_type t
321 where c.relname = '~a'
323 and a.attrelid = c.oid
324 and a.atttypid = t.oid"
325 (sql-escape (string-downcase table)))
328 ;;; Prepared statements
330 (defvar *next-prepared-id-num* 0)
331 (defun next-prepared-id ()
332 (let ((num (incf *next-prepared-id-num*)))
333 (format nil "CLSQL_PS_~D" num)))
335 (defclass postgresql-stmt ()
336 ((database :initarg :database :reader database)
337 (id :initarg :id :reader id)
338 (bindings :initarg :bindings :reader bindings)
339 (field-names :initarg :field-names :accessor stmt-field-names)
340 (result-types :initarg :result-types :reader result-types)))
342 (defun clsql-type->postgresql-type (type)
344 ((in type :int :integer) "INT4")
345 ((in type :short) "INT2")
346 ((in type :bigint) "INT8")
347 ((in type :float :double :number) "NUMERIC")
348 ((and (consp type) (in (car type) :char :varchar)) "VARCHAR")
350 (error 'sql-user-error
352 (format nil "Unknown clsql type ~A." type)))))
354 (defun prepared-sql-to-postgresql-sql (sql)
355 ;; FIXME: Convert #\? to "$n". Don't convert within strings
356 (declare (simple-string sql))
357 (with-output-to-string (out)
358 (do ((len (length sql))
363 (declare (fixnum len param pos))
364 (let ((c (schar sql pos)))
365 (declare (character c))
367 ((or (char= c #\") (char= c #\'))
368 (setq in-str (not in-str))
370 ((and (char= c #\?) (not in-str))
372 (write-string (write-to-string (incf param)) out))
374 (write-char c out)))))))
376 (defmethod database-prepare (sql-stmt types (database generic-postgresql-database) result-types field-names)
377 (let ((id (next-prepared-id)))
378 (database-execute-command
379 (format nil "PREPARE ~A (~{~A~^,~}) AS ~A"
381 (mapcar #'clsql-type->postgresql-type types)
382 (prepared-sql-to-postgresql-sql sql-stmt))
384 (make-instance 'postgresql-stmt
387 :result-types result-types
388 :field-names field-names
389 :bindings (make-list (length types)))))
391 (defmethod database-bind-parameter ((stmt postgresql-stmt) position value)
392 (setf (nth (1- position) (bindings stmt)) value))
394 (defun binding-to-param (binding)
397 (concatenate 'string "'" (sql-escape-quotes binding) "'"))
401 (defmethod database-run-prepared ((stmt postgresql-stmt))
402 (with-slots (database id bindings field-names result-types) stmt
403 (let ((query (format nil "EXECUTE ~A (~{~A~^,~})"
404 id (mapcar #'binding-to-param bindings))))
406 ((and field-names (not (consp field-names)))
407 (multiple-value-bind (res names)
408 (database-query query database result-types field-names)
409 (setf field-names names)
412 (values (nth-value 0 (database-query query database result-types nil))
415 (database-query query database result-types field-names))))))
419 (defmethod db-type-has-fancy-math? ((db-type (eql :postgresql)))
422 (defmethod db-type-default-case ((db-type (eql :postgresql)))
425 (defmethod db-type-has-prepared-stmt? ((db-type (eql :postgresql)))
428 (defmethod db-type-has-prepared-stmt? ((db-type (eql :postgresql-socket)))
431 (defmethod db-type-has-auto-increment? ((db-type (eql :postgresql)))