1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: oracle-sql.lisp
9 ;;;; This file is part of CLSQL.
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 #:clsql-oracle)
18 (defmethod database-initialize-database-type ((database-type (eql :oracle)))
21 ;;;; arbitrary parameters, tunable for performance or other reasons
23 (eval-when (:compile-toplevel :load-toplevel :execute)
24 (defconstant +errbuf-len+ 512
25 "the number of characters that we allocate for an error message buffer")
26 (defconstant +n-buf-rows+ 200
27 "the number of table rows that we buffer at once when reading a table.
28 CMUCL has a compiled-in limit on how much C data can be allocated
29 (through malloc() and friends) at any given time, typically 8 Mb.
30 Setting this constant to a moderate value should make it less
31 likely that we'll have to worry about the CMUCL limit."))
34 (uffi:def-type vp-type :pointer-void)
35 (uffi:def-type vpp-type (* :pointer-void))
37 (defmacro deref-vp (foreign-object)
38 `(the vp-type (uffi:deref-pointer (the vpp-type ,foreign-object) :pointer-void)))
40 (defvar +unsigned-char-null-pointer+
41 (uffi:make-null-pointer :unsigned-char))
42 (defvar +unsigned-short-null-pointer+
43 (uffi:make-null-pointer :unsigned-short))
44 (defvar +unsigned-int-null-pointer+
45 (uffi:make-null-pointer :unsigned-int))
47 ;; constants - from OCI?
49 (defconstant +var-not-in-list+ 1007)
50 (defconstant +no-data-found+ 1403)
51 (defconstant +null-value-returned+ 1405)
52 (defconstant +field-truncated+ 1406)
54 (eval-when (:compile-toplevel :load-toplevel :execute)
55 (defconstant SQLT-NUMBER 2)
56 (defconstant SQLT-INT 3)
57 (defconstant SQLT-FLT 4)
58 (defconstant SQLT-STR 5)
59 (defconstant SQLT-DATE 12))
61 ;;; Note that despite the suggestive class name (and the way that the
62 ;;; *DEFAULT-DATABASE* variable holds an object of this class), a DB
63 ;;; object is not actually a database but is instead a connection to a
64 ;;; database. Thus, there's no obstacle to having any number of DB
65 ;;; objects referring to the same database.
67 (uffi:def-type pointer-pointer-void '(* :pointer-void))
69 (defclass oracle-database (database) ; was struct db
73 :type pointer-pointer-void
75 "OCI environment handle")
79 :type pointer-pointer-void
85 :type pointer-pointer-void
87 "OCI service context handle")
92 "optional data source name (used only for debugging/printing)")
98 "the \"user\" value given when data source connection was made")
100 :initarg :date-format
102 :initform "YYYY-MM-DD HH24:MI:SS\"+00\"")
106 "Each database connection can be configured with its own date
107 output format. In order to extract date strings from output buffers
108 holding multiple date strings in fixed-width fields, we need to know
109 the length of that format.")
111 :type (or null string)
112 :initarg :server-version
113 :reader server-version
115 "Version string of Oracle server.")
116 (major-server-version
117 :type (or null fixnum)
118 :initarg :major-server-version
119 :reader major-server-version
121 "The major version number of the Oracle server, should be 8, 9, or 10")))
124 ;;; Handle the messy case of return code=+oci-error+, querying the
125 ;;; system for subcodes and reporting them as appropriate. ERRHP and
126 ;;; NULLS-OK are as in the OERR function.
128 (defun handle-oci-error (&key database nulls-ok)
130 (with-slots (errhp) database
131 (uffi:with-foreign-objects ((errbuf '(:array :unsigned-char
134 ;; ensure errbuf empty string
135 (setf (uffi:deref-array errbuf '(:array :unsigned-char) 0)
136 (uffi:ensure-char-storable (code-char 0)))
137 (setf (uffi:deref-pointer errcode :long) 0)
139 (uffi:with-cstring (sqlstate nil)
140 (oci-error-get (deref-vp errhp) 1
143 (uffi:char-array-to-pointer errbuf)
144 +errbuf-len+ +oci-htype-error+))
145 (let ((subcode (uffi:deref-pointer errcode :long)))
146 (unless (and nulls-ok (= subcode +null-value-returned+))
147 (error 'sql-database-error
150 :message (uffi:convert-from-foreign-string errbuf)))))))
152 (error 'sql-database-error
154 :message "can't handle NULLS-OK without ERRHP"))
156 (error 'sql-database-error
158 :message "OCI Error (and no ERRHP available to find subcode)"))))
160 ;;; Require an OCI success code.
162 ;;; (The ordinary OCI error reporting mechanisms uses a fair amount of
163 ;;; machinery (environments and other handles). In order to get to
164 ;;; where we can use these mechanisms, we have to be able to allocate
165 ;;; the machinery. The functions for allocating the machinery can
166 ;;; return errors (e.g. out of memory) but shouldn't. Wrapping this function
167 ;;; around function calls to such have-to-succeed functions enforces
171 (declare (type fixnum code))
172 (unless (= code +oci-success+)
173 (error 'sql-database-error
174 :message (format nil "unexpected OCI failure, code=~S" code))))
177 ;;; Enabling this can be handy for low-level debugging.
180 (trace #-oci7 oci-env-create oci-initialize oci-handle-alloc oci-logon
181 oci-error-get oci-stmt-prepare oci-stmt-execute
182 oci-param-get oci-logon oci-attr-get oci-define-by-pos oci-stmt-fetch)
183 (setf debug::*debug-print-length* nil))
186 ;; Return the INDEXth string of the OCI array, represented as Lisp
187 ;; SIMPLE-STRING. SIZE is the size of the fixed-width fields used by
188 ;; Oracle to store strings within the array.
190 (uffi:def-type string-pointer (* :unsigned-char))
192 (defun deref-oci-string (arrayptr string-index size)
193 (declare (type string-pointer arrayptr))
194 (declare (type (mod #.+n-buf-rows+) string-index))
195 (declare (type (and unsigned-byte fixnum) size))
196 (let ((str (uffi:convert-from-foreign-string
198 (+ (uffi:pointer-address arrayptr) (* string-index size))
200 (if (string-equal str "NULL") nil str)))
202 ;; the OCI library, part Z: no-longer used logic to convert from
203 ;; Oracle's binary date representation to Common Lisp's native date
207 (defvar +oci-date-bytes+ 7)
209 ;;; Return the INDEXth date in the OCI array, represented as
210 ;;; a Common Lisp "universal time" (i.e. seconds since 1900).
213 (defun deref-oci-date (arrayptr index)
214 (oci-date->universal-time (uffi:pointer-address
215 (uffi:deref-array arrayptr
216 '(:array :unsigned-char)
217 (* index +oci-date-bytes+)))))
219 (defun oci-date->universal-time (oci-date)
220 (declare (type (alien (* :unsigned-char)) oci-date))
221 (flet (;; a character from OCI-DATE, interpreted as an unsigned byte
223 (declare (type (mod #.+oci-date-bytes+) i))
224 (mod (uffi:deref-array oci-date string-array i) 256)))
225 (let* ((century (* (- (ub 0) 100) 100))
226 (year (+ century (- (ub 1) 100)))
231 (second (1- (ub 6))))
232 (encode-universal-time second minute hour day month year))))
235 (defmethod database-list-tables ((database oracle-database) &key owner)
239 "select user_tables.table_name from user_tables,all_tables where user_tables.table_name=all_tables.table_name and all_tables.owner='~:@(~A~)'"
241 "select table_name from user_tables")))
242 (mapcar #'car (database-query query database nil nil))))
245 (defmethod database-list-views ((database oracle-database) &key owner)
249 "select user_views.view_name from user_views,all_views where user_views.view_name=all_views.view_name and all_views.owner='~:@(~A~)'"
251 "select view_name from user_views")))
253 (database-query query database nil nil))))
255 (defmethod database-list-indexes ((database oracle-database)
260 "select user_indexes.index_name from user_indexes,all_indexes where user_indexes.index_name=all_indexes.index_name and all_indexes.owner='~:@(~A~)'"
262 "select index_name from user_indexes")))
263 (mapcar #'car (database-query query database nil nil))))
265 (defmethod database-list-table-indexes (table (database oracle-database)
270 "select user_indexes.index_name from user_indexes,all_indexes where user_indexes.table_name='~A' and user_indexes.index_name=all_indexes.index_name and all_indexes.owner='~:@(~A~)'"
272 (format nil "select index_name from user_indexes where table_name='~A'"
274 (mapcar #'car (database-query query database nil nil))))
277 (defmethod database-list-attributes (table (database oracle-database) &key owner)
281 "select user_tab_columns.column_name from user_tab_columns,all_tables where user_tab_columns.table_name='~A' and all_tables.table_name=user_tab_columns.table_name and all_tables.owner='~:@(~A~)'"
284 "select column_name from user_tab_columns where table_name='~A'"
286 (mapcar #'car (database-query query database nil nil))))
288 (defmethod database-attribute-type (attribute (table string)
289 (database oracle-database)
294 "select data_type,data_length,data_scale,nullable from user_tab_columns,all_tables where user_tab_columns.table_name='~A' and column_name='~A' and all_tables.table_name=user_tab_columns.table_name and all_tables.owner='~:@(~A~)'"
295 table attribute owner)
297 "select data_type,data_length,data_scale,nullable from user_tab_columns where table_name='~A' and column_name='~A'"
299 (destructuring-bind (type length scale nullable) (car (database-query query database :auto nil))
300 (values (ensure-keyword type) length scale
301 (if (char-equal #\Y (schar nullable 0)) 1 0)))))
303 ;; Return one row of the table referred to by QC, represented as a
304 ;; list; or if there are no more rows, signal an error if EOF-ERRORP,
305 ;; or return EOF-VALUE otherwise.
307 ;; KLUDGE: This CASE statement is a strong sign that the code would be
308 ;; cleaner if CD were made into an abstract class, we made variant
309 ;; classes for CD-for-column-of-strings, CD-for-column-of-floats,
310 ;; etc., and defined virtual functions to handle operations like
311 ;; get-an-element-from-column. (For a small special purpose module
312 ;; like this, would arguably be overkill, so I'm not going to do it
313 ;; now, but if this code ends up getting more complicated in
314 ;; maintenance, it would become a really good idea.)
316 ;; Arguably this would be a good place to signal END-OF-FILE, but
317 ;; since the ANSI spec specifically says that END-OF-FILE means a
318 ;; STREAM which has no more data, and QC is not a STREAM, we signal
319 ;; DBI-ERROR instead.
321 (uffi:def-type short-array '(:array :short))
322 (uffi:def-type int-pointer '(* :int))
323 (uffi:def-type double-pointer '(* :double))
325 ;;; the result of a database query: a cursor through a table
326 (defstruct (oracle-result-set (:print-function print-query-cursor)
328 (:constructor %make-query-cursor))
329 (db (error "missing DB") ; db conn. this table is associated with
330 :type oracle-database
332 (stmthp (error "missing STMTHP") ; the statement handle used to create
333 ;; :type alien ; this table. owned by the QUERY-CURSOR
334 :read-only t) ; object, deallocated on CLOSE-QUERY
335 (cds) ; (error "missing CDS") ; column descriptors
336 ; :type (simple-array cd 1)
339 0 ; buffered rows: number of rows recv'd
340 :type (integer 0 #.+n-buf-rows+)) ; from the database on the last read
342 0 ; number of buffered rows returned, i.e.
343 :type (integer 0 #.+n-buf-rows+)) ; the index, within the buffered rows,
344 ; of the next row which hasn't already
347 0 ; total number of bytes recv'd from OCI
348 :type unsigned-byte) ; in all reads
349 (oci-end-seen-p nil)) ; Have we seen the end of OCI
350 ; data, i.e. OCI returning
351 ; less data than we requested?
352 ; OCI doesn't seem to like us
353 ; to try to read more data
354 ; from it after that..
357 (defun fetch-row (qc &optional (eof-errorp t) eof-value)
358 ;;(declare (optimize (speed 3)))
359 (cond ((zerop (qc-n-from-oci qc))
361 (error 'sql-database-error :message
362 (format nil "no more rows available in ~S" qc))
364 ((>= (qc-n-to-dbi qc)
366 (refill-qc-buffers qc)
367 (fetch-row qc nil eof-value))
369 (let ((cds (qc-cds qc))
370 (reversed-result nil)
371 (irow (qc-n-to-dbi qc)))
372 (dotimes (icd (length cds))
373 (let* ((cd (aref cds icd))
374 (b (foreign-resource-buffer (cd-buffer cd)))
376 (let* ((arb (foreign-resource-buffer (cd-indicators cd)))
377 (indicator (uffi:deref-array arb '(:array :short) irow)))
378 ;;(declare (type short-array arb))
379 (unless (= indicator -1)
380 (ecase (cd-oci-data-type cd)
382 (deref-oci-string b irow (cd-sizeof cd)))
384 (uffi:deref-array b '(:array :double) irow))
386 (ecase (cd-sizeof cd)
388 (uffi:deref-array b '(:array :int) irow))))
390 (deref-oci-string b irow (cd-sizeof cd))))))))
391 (when (and (eq :string (cd-result-type cd))
393 (not (stringp value)))
394 (setq value (write-to-string value)))
395 (push value reversed-result)))
396 (incf (qc-n-to-dbi qc))
397 (nreverse reversed-result)))))
399 (defun refill-qc-buffers (qc)
400 (with-slots (errhp) (qc-db qc)
401 (setf (qc-n-to-dbi qc) 0)
402 (cond ((qc-oci-end-seen-p qc)
403 (setf (qc-n-from-oci qc) 0))
405 (let ((oci-code (%oci-stmt-fetch
406 (deref-vp (qc-stmthp qc))
409 +oci-fetch-next+ +oci-default+)))
411 (#.+oci-success+ (values))
412 (#.+oci-no-data+ (setf (qc-oci-end-seen-p qc) t)
414 (#.+oci-error+ (handle-oci-error :database (qc-db qc)
416 (uffi:with-foreign-object (rowcount :long)
417 (oci-attr-get (deref-vp (qc-stmthp qc))
420 +unsigned-int-null-pointer+
423 (setf (qc-n-from-oci qc)
424 (- (uffi:deref-pointer rowcount :long)
425 (qc-total-n-from-oci qc)))
426 (when (< (qc-n-from-oci qc) +n-buf-rows+)
427 (setf (qc-oci-end-seen-p qc) t))
428 (setf (qc-total-n-from-oci qc)
429 (uffi:deref-pointer rowcount :long)))))
432 ;; the guts of the SQL function
434 ;; (like the SQL function, but with the QUERY argument hardwired to T, so
435 ;; that the return value is always a cursor instead of a list)
437 ;; Is this a SELECT statement? SELECT statements are handled
438 ;; specially by OCIStmtExecute(). (Non-SELECT statements absolutely
439 ;; require a nonzero iteration count, while the ordinary choice for a
440 ;; SELECT statement is a zero iteration count.
442 ;; SELECT statements are the only statements which return tables. We
443 ;; don't free STMTHP in this case, but instead give it to the new
444 ;; QUERY-CURSOR, and the new QUERY-CURSOR becomes responsible for
445 ;; freeing the STMTHP when it is no longer needed.
447 (defun sql-stmt-exec (sql-stmt-string db result-types field-names)
448 (with-slots (envhp svchp errhp)
450 (let ((stmthp (uffi:allocate-foreign-object :pointer-void)))
451 (uffi:with-foreign-object (stmttype :unsigned-short)
453 (oci-handle-alloc (deref-vp envhp)
455 +oci-htype-stmt+ 0 +null-void-pointer-pointer+)
456 (oci-stmt-prepare (deref-vp stmthp)
458 (uffi:convert-to-cstring sql-stmt-string)
459 (length sql-stmt-string)
460 +oci-ntv-syntax+ +oci-default+ :database db)
461 (oci-attr-get (deref-vp stmthp)
464 +unsigned-int-null-pointer+
468 (let* ((select-p (= (uffi:deref-pointer stmttype :unsigned-short) 1))
469 (iters (if select-p 0 1)))
471 (oci-stmt-execute (deref-vp svchp)
474 iters 0 +null-void-pointer+ +null-void-pointer+ +oci-default+
477 (make-query-cursor db stmthp result-types field-names))
479 (oci-handle-free (deref-vp stmthp) +oci-htype-stmt+)
483 ;; Return a QUERY-CURSOR representing the table returned from the OCI
484 ;; operation done through STMTHP. TYPES is the argument of the same
485 ;; name from the external SQL function, controlling type conversion
486 ;; of the returned arguments.
488 (defun make-query-cursor (db stmthp result-types field-names)
489 (let ((qc (%make-query-cursor :db db
491 :cds (make-query-cursor-cds db stmthp
494 (refill-qc-buffers qc)
498 ;; the hairy part of MAKE-QUERY-CURSOR: Ask OCI for information
499 ;; about table columns, translate the information into a Lisp
500 ;; vector of column descriptors, and return it.
502 ;; Allegro defines several flavors of type conversion, but this
503 ;; implementation only supports the :AUTO flavor.
505 ;; A note of explanation: OCI's internal number format uses 21
506 ;; bytes (42 decimal digits). 2 separate (?) one-byte fields,
507 ;; scale and precision, are used to deduce the nature of these
508 ;; 21 bytes. See pp. 3-10, 3-26, and 6-13 of OCI documentation
511 ;; Mac OS X Note: According to table 6-8 in the Oracle 9i OCI
512 ;; documentation, PRECISION may actually be an sb2 instead of a
513 ;; single byte if performing an "implicit describe". Using a
514 ;; signed short instead of an unsigned byte fixes a Mac OS X bug
515 ;; where PRECISION is always zero. -- JJB 20040713
517 ;; When calling OCI C code to handle the conversion, we have
518 ;; only two numeric types available to pass the return value:
519 ;; double-float and signed-long. It would be possible to
520 ;; bypass the OCI conversion functions and write Lisp code
521 ;; which reads the 21-byte field directly and decodes
522 ;; it. However this is left as an exercise for the reader. :-)
524 ;; The following table describes the mapping, based on the implicit
525 ;; assumption that C's "signed long" type is a 32-bit integer.
527 ;; Internal Values SQL Type C Return Type
528 ;; =============== ======== =============
529 ;; Precision > 0 SCALE = -127 FLOAT --> double-float
530 ;; Precision > 0 && <=9 SCALE = 0 INTEGER --> signed-long
531 ;; Precision = 0 || > 9 SCALE = 0 BIG INTEGER --> double-float
532 ;; Precision > 0 SCALE > 0 DECIMAL --> double-float
534 ;; (OCI uses 1-based indexing here.)
536 ;; KLUDGE: This should work for all other data types except those
537 ;; which don't actually fit in their fixed-width field (BLOBs and the
538 ;; like). As Winton says, we (Cadabra) don't need to worry much about
539 ;; those, since we can't reason with them, so we don't use them. But
540 ;; for a more general application it'd be good to have a more
541 ;; selective and rigorously correct test here for whether we can
542 ;; actually handle the given DEREF-DTYPE value. -- WHN 20000106
544 ;; Note: The OCI documentation doesn't seem to say whether the COLNAME
545 ;; value returned here is a newly-allocated copy which we're
546 ;; responsible for freeing, or a pointer into some system copy which
547 ;; will be freed when the system itself is shut down. But judging
548 ;; from the way that the result is used in the cdemodsa.c example
549 ;; program, it looks like the latter: we should make our own copy of
550 ;; the value, but not try to free it.
552 ;; WORKAROUND: OCI seems to return ub2 values for the
553 ;; +oci-attr-data-size+ attribute even though its documentation claims
554 ;; that it returns a ub4, and even though the associated "sizep" value
555 ;; is 4, not 2. In order to make the code here work reliably, without
556 ;; having to patch it later if OCI is ever fixed to match its
557 ;; documentation, we pre-zero COLSIZE before making the call into OCI.
559 ;; To exercise the weird OCI behavior (thereby blowing up the code
560 ;; below, beware!) try setting this value into COLSIZE, calling OCI,
561 ;; then looking at the value in COLSIZE. (setf colsize #x12345678)
564 ;; Mac OS X Note: This workaround fails on a bigendian platform so
565 ;; I've changed the data type of COLNAME to :unsigned-short as per
566 ;; the Oracle 9i OCI documentation. -- JJB 20040713
568 (uffi:def-type byte-pointer (* :byte))
569 (uffi:def-type ulong-pointer (* :unsigned-long))
570 (uffi:def-type void-pointer-pointer (* :void-pointer))
572 (defun make-query-cursor-cds (database stmthp result-types field-names)
573 (declare (optimize (safety 3) #+nil (speed 3))
574 (type oracle-database database)
575 (type pointer-pointer-void stmthp))
576 (with-slots (errhp) database
577 (uffi:with-foreign-objects ((dtype-foreign :unsigned-short)
578 (parmdp :pointer-void)
581 (colname '(* :unsigned-char))
582 (colnamelen :unsigned-long)
583 (colsize :unsigned-short)
584 (colsizesize :unsigned-long)
585 (defnp ':pointer-void))
588 (do ((icolumn 0 (1+ icolumn))
589 (cds-as-reversed-list nil))
590 ((not (eql (oci-param-get (deref-vp stmthp)
594 (1+ icolumn) :database database)
596 (coerce (reverse cds-as-reversed-list) 'simple-vector))
597 ;; Decode type of ICOLUMNth column into a type we're prepared to
599 (oci-attr-get (deref-vp parmdp)
602 +unsigned-int-null-pointer+
605 (let ((dtype (uffi:deref-pointer dtype-foreign :unsigned-short)))
606 (declare (fixnum dtype))
609 (setf buffer (acquire-foreign-resource :unsigned-char
610 (* 32 +n-buf-rows+)))
611 (setf sizeof 32 dtype #.SQLT-STR))
613 (oci-attr-get (deref-vp parmdp)
616 +unsigned-int-null-pointer+
619 (oci-attr-get (deref-vp parmdp)
622 +unsigned-int-null-pointer+
625 (let ((*scale (uffi:deref-pointer scale :byte))
626 (*precision (uffi:deref-pointer precision :short)))
628 ;;(format t "scale=~d, precision=~d~%" *scale *precision)
630 ((or (and (minusp *scale) (zerop *precision))
631 (and (zerop *scale) (plusp *precision)))
632 (setf buffer (acquire-foreign-resource :int +n-buf-rows+)
633 sizeof 4 ;; sizeof(int)
636 (setf buffer (acquire-foreign-resource :double +n-buf-rows+)
637 sizeof 8 ;; sizeof(double)
638 dtype #.SQLT-FLT)))))
639 ;; Default to SQL-STR
641 (setf (uffi:deref-pointer colsize :unsigned-short) 0)
642 (setf dtype #.SQLT-STR)
643 (oci-attr-get (deref-vp parmdp)
646 +unsigned-int-null-pointer+
649 (let ((colsize-including-null (1+ (uffi:deref-pointer colsize :unsigned-short))))
650 (setf buffer (acquire-foreign-resource
651 :unsigned-char (* +n-buf-rows+ colsize-including-null)))
652 (setf sizeof colsize-including-null))))
653 (let ((retcodes (acquire-foreign-resource :unsigned-short +n-buf-rows+))
654 (indicators (acquire-foreign-resource :short +n-buf-rows+))
657 (oci-attr-get (deref-vp parmdp)
663 (setq colname-string (uffi:convert-from-foreign-string
664 (uffi:deref-pointer colname '(* :unsigned-char))
665 :length (uffi:deref-pointer colnamelen :unsigned-long))))
666 (push (make-cd :name colname-string
671 :indicators indicators
673 ((consp result-types)
674 (nth icolumn result-types))
679 cds-as-reversed-list)
680 (oci-define-by-pos (deref-vp stmthp)
683 (1+ icolumn) ; OCI 1-based indexing again
684 (foreign-resource-buffer buffer)
687 (foreign-resource-buffer indicators)
688 +unsigned-short-null-pointer+
689 (foreign-resource-buffer retcodes)
690 +oci-default+))))))))
692 ;; Release the resources associated with a QUERY-CURSOR.
694 (defun close-query (qc)
695 (oci-handle-free (deref-vp (qc-stmthp qc)) +oci-htype-stmt+)
696 (let ((cds (qc-cds qc)))
697 (dotimes (i (length cds))
698 (release-cd-resources (aref cds i))))
702 ;; Release the resources associated with a column description.
704 (defun release-cd-resources (cd)
705 (free-foreign-resource (cd-buffer cd))
706 (free-foreign-resource (cd-retcodes cd))
707 (free-foreign-resource (cd-indicators cd))
711 (defmethod database-name-from-spec (connection-spec (database-type (eql :oracle)))
712 (check-connection-spec connection-spec database-type (dsn user password))
713 (destructuring-bind (dsn user password) connection-spec
714 (declare (ignore password))
715 (concatenate 'string dsn "/" user)))
718 (defmethod database-connect (connection-spec (database-type (eql :oracle)))
719 (check-connection-spec connection-spec database-type (dsn user password))
720 (destructuring-bind (data-source-name user password)
722 (let ((envhp (uffi:allocate-foreign-object :pointer-void))
723 (errhp (uffi:allocate-foreign-object :pointer-void))
724 (svchp (uffi:allocate-foreign-object :pointer-void))
725 (srvhp (uffi:allocate-foreign-object :pointer-void)))
726 ;; Requests to allocate environments and handles should never
727 ;; fail in normal operation, and they're done too early to
728 ;; handle errors very gracefully (since they're part of the
729 ;; error-handling mechanism themselves) so we just assert they
732 (setf (deref-vp envhp) +null-void-pointer+)
735 (oci-env-create envhp +oci-default+ +null-void-pointer+
736 +null-void-pointer+ +null-void-pointer+
737 +null-void-pointer+ 0 +null-void-pointer-pointer+)
740 (oci-initialize +oci-object+ +null-void-pointer+ +null-void-pointer+
741 +null-void-pointer+ +null-void-pointer-pointer+)
742 (ignore-errors (oci-handle-alloc +null-void-pointer+ envhp
744 +null-void-pointer-pointer+)) ;no testing return
745 (oci-env-init envhp +oci-default+ 0 +null-void-pointer-pointer+))
746 (oci-handle-alloc (deref-vp envhp) errhp
747 +oci-htype-error+ 0 +null-void-pointer-pointer+)
748 (oci-handle-alloc (deref-vp envhp) srvhp
749 +oci-htype-server+ 0 +null-void-pointer-pointer+)
751 #+ignore ;; not used since CLSQL uses the OCILogon function instead
752 (uffi:with-cstring (dblink nil)
753 (oci-server-attach (deref-vp srvhp)
758 (oci-handle-alloc (deref-vp envhp) svchp
759 +oci-htype-svcctx+ 0 +null-void-pointer-pointer+)
760 (oci-attr-set (deref-vp svchp)
762 (deref-vp srvhp) 0 +oci-attr-server+
764 ;; oci-handle-alloc((dvoid *)encvhp, (dvoid **)&stmthp, OCI_HTYPE_STMT, 0, 0);
767 (let ((db (make-instance 'oracle-database
768 :name (database-name-from-spec connection-spec
770 :connection-spec connection-spec
773 :database-type :oracle
775 :dsn data-source-name
777 (oci-logon (deref-vp envhp)
780 (uffi:convert-to-cstring user) (length user)
781 (uffi:convert-to-cstring password) (length password)
782 (uffi:convert-to-cstring data-source-name) (length data-source-name)
784 ;; :date-format-length (1+ (length date-format)))))
785 (setf (slot-value db 'clsql-sys::state) :open)
786 (database-execute-command
787 (format nil "ALTER SESSION SET NLS_DATE_FORMAT='~A'" (date-format db)) db)
788 (let ((server-version
789 (caar (database-query
790 "SELECT BANNER FROM V$VERSION WHERE BANNER LIKE '%Oracle%'" db nil nil))))
791 (setf (slot-value db 'server-version) server-version
792 (slot-value db 'major-server-version) (major-client-version-from-string
797 (defun major-client-version-from-string (str)
799 ((search " 10g " str)
801 ((search "Oracle9i " str)
803 ((search "Oracle8" str)
806 (defun major-server-version-from-string (str)
807 (when (> (length str) 2)
809 ((string= "10." (subseq str 0 3))
811 ((string= "9." (subseq str 0 2))
813 ((string= "8." (subseq str 0 2))
817 ;; Close a database connection.
819 (defmethod database-disconnect ((database oracle-database))
820 (osucc (oci-logoff (deref-vp (svchp database))
821 (deref-vp (errhp database))))
822 (osucc (oci-handle-free (deref-vp (envhp database)) +oci-htype-env+))
823 ;; Note: It's neither required nor allowed to explicitly deallocate the
824 ;; ERRHP handle here, since it's owned by the ENVHP deallocated above,
825 ;; and was therefore automatically deallocated at the same time.
828 ;;; Do the database operation described in SQL-STMT-STRING on database
829 ;;; DB and, if the command is a SELECT, return a representation of the
830 ;;; resulting table. The representation of the table is controlled by the
832 ;;; * If QUERY is NIL, the table is returned as a list of rows, with
833 ;;; each row represented by a list.
834 ;;; * If QUERY is non-NIL, the result is returned as a QUERY-CURSOR
835 ;;; suitable for FETCH-ROW and CLOSE-QUERY
836 ;;; The TYPES argument controls the type conversion method used
837 ;;; to construct the table. The Allegro version supports several possible
838 ;;; values for this argument, but we only support :AUTO.
840 (defmethod database-query (query-expression (database oracle-database) result-types field-names)
841 (let ((cursor (sql-stmt-exec query-expression database result-types field-names)))
842 ;; (declare (type (or query-cursor null) cursor))
843 (if (null cursor) ; No table was returned.
845 (do ((reversed-result nil))
847 (let* ((eof-value :eof)
848 (row (fetch-row cursor nil eof-value)))
849 (when (eq row eof-value)
852 (return (values (nreverse reversed-result)
853 (loop for cd across (qc-cds cursor)
854 collect (cd-name cd))))
855 (return (nreverse reversed-result))))
856 (push row reversed-result))))))
859 (defmethod database-create-sequence (sequence-name (database oracle-database))
861 (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
864 (defmethod database-drop-sequence (sequence-name (database oracle-database))
866 (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name))
869 (defmethod database-sequence-next (sequence-name (database oracle-database))
872 (concatenate 'string "SELECT "
873 (sql-escape sequence-name)
876 database :auto nil)))
878 (defmethod database-set-sequence-position (name position (database oracle-database))
880 (let* ((next (database-sequence-next name database))
881 (incr (- position next)))
882 (database-execute-command
883 (format nil "ALTER SEQUENCE ~A INCREMENT BY ~D" name incr)
885 (database-sequence-next name database)
886 (database-execute-command
887 (format nil "ALTER SEQUENCE ~A INCREMENT BY 1" name)
890 (defmethod database-list-sequences ((database oracle-database) &key owner)
894 "select user_sequences.sequence_name from user_sequences,all_sequences where user_sequences.sequence_name=all_sequences.sequence_name and all_sequences.sequence_owner='~:@(~A~)'"
896 "select sequence_name from user_sequences")))
897 (mapcar #'car (database-query query database nil nil))))
899 (defmethod database-execute-command (sql-expression (database oracle-database))
900 (database-query sql-expression database nil nil)
901 (when (database-autocommit database)
902 (oracle-commit database))
906 (defstruct (cd (:constructor make-cd)
907 (:print-function print-cd))
908 "a column descriptor: metadata about the data in a table"
910 ;; name of this column
911 (name (error "missing NAME") :type simple-string :read-only t)
912 ;; the size in bytes of a single element
913 (sizeof (error "missing SIZE") :type fixnum :read-only t)
914 ;; an array of +N-BUF-ROWS+ elements in C representation
915 (buffer (error "Missing BUFFER")
916 :type foreign-resource
918 ;; an array of +N-BUF-ROWS+ OCI return codes in C representation.
919 ;; (There must be one return code for every element of every
920 ;; row in order to be able to represent nullness.)
921 (retcodes (error "Missing RETCODES")
922 :type foreign-resource
924 (indicators (error "Missing INDICATORS")
925 :type foreign-resource
927 ;; the OCI code for the data type of a single element
928 (oci-data-type (error "missing OCI-DATA-TYPE")
931 (result-type (error "missing RESULT-TYPE")
935 (defun print-cd (cd stream depth)
936 (declare (ignore depth))
937 (print-unreadable-object (cd stream :type t)
939 ":NAME ~S :OCI-DATA-TYPE ~S :OCI-DATA-SIZE ~S"
941 (cd-oci-data-type cd)
944 (defun print-query-cursor (qc stream depth)
945 (declare (ignore depth))
946 (print-unreadable-object (qc stream :type t :identity t)
947 (prin1 (qc-db qc) stream)))
950 (defmethod database-query-result-set ((query-expression string)
951 (database oracle-database)
952 &key full-set result-types)
953 (let ((cursor (sql-stmt-exec query-expression database result-types nil)))
955 (values cursor (length (qc-cds cursor)) nil)
956 (values cursor (length (qc-cds cursor))))))
959 (defmethod database-dump-result-set (result-set (database oracle-database))
960 (close-query result-set))
962 (defmethod database-store-next-row (result-set (database oracle-database) list)
963 (let* ((eof-value :eof)
964 (row (fetch-row result-set nil eof-value)))
965 (unless (eq eof-value row)
966 (loop for i from 0 below (length row)
967 do (setf (nth i list) (nth i row)))
970 (defmethod database-start-transaction ((database oracle-database))
972 ;; Not needed with simple transaction
974 (with-slots (svchp errhp) database
975 (oci-trans-start (deref-vp svchp)
982 (defun oracle-commit (database)
983 (with-slots (svchp errhp) database
984 (osucc (oci-trans-commit (deref-vp svchp)
988 (defmethod database-commit-transaction ((database oracle-database))
990 (oracle-commit database)
993 (defmethod database-abort-transaction ((database oracle-database))
995 (osucc (oci-trans-rollback (deref-vp (svchp database))
996 (deref-vp (errhp database))
1002 (defmethod db-type-has-bigint? ((type (eql :oracle)))
1005 (defmethod db-type-has-fancy-math? ((db-type (eql :oracle)))
1008 (defmethod db-type-has-boolean-where? ((db-type (eql :oracle)))
1011 (when (clsql-sys:database-type-library-loaded :oracle)
1012 (clsql-sys:initialize-database-type :database-type :oracle))