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")))
123 ;;; Handle a non-successful result from an OCI function.
124 (defun handle-oci-result (result database nulls-ok)
129 (handle-oci-error :database database :nulls-ok nulls-ok))
131 (error 'sql-database-error :message "OCI No Data Found"))
132 (#.+oci-success-with-info+
133 (error 'sql-database-error :message "internal error: unexpected +oci-success-with-info"))
134 (#.+oci-invalid-handle+
135 (error 'sql-database-error :message "OCI Invalid Handle"))
137 (error 'sql-database-error :message "OCI Need Data"))
138 (#.+oci-still-executing+
139 (error 'sql-temporary-error :message "OCI Still Executing"))
141 (error 'sql-database-error :message "OCI Continue"))
143 (error 'sql-database-error :message "Check ORACLE_HOME and NLS settings."))
145 (error 'sql-database-error
147 (format nil "OCI unknown error, code=~A" result)))))
149 ;;; Handle the messy case of return code=+oci-error+, querying the
150 ;;; system for subcodes and reporting them as appropriate. ERRHP and
151 ;;; NULLS-OK are as in the OERR function.
153 (defun handle-oci-error (&key database nulls-ok)
156 (with-slots (errhp) database
157 (uffi:with-foreign-objects ((errcode 'sb4)
158 (errbuf '(:array :unsigned-char #.+errbuf-len+)))
159 ;; ensure errbuf empty string
160 (setf (uffi:deref-array errbuf '(:array :unsigned-char) 0)
161 (uffi:ensure-char-storable (code-char 0)))
162 (setf (uffi:deref-pointer errcode 'sb4) 0)
164 (uffi:with-cstring (sqlstate nil)
165 (oci-error-get (deref-vp errhp) 1
168 (uffi:char-array-to-pointer errbuf)
169 +errbuf-len+ +oci-htype-error+))
170 (let ((subcode (uffi:deref-pointer errcode 'sb4))
171 (errstr (uffi:convert-from-foreign-string errbuf)))
172 (unless (and nulls-ok (= subcode +null-value-returned+))
173 (error 'sql-database-error
176 :message errstr))))))
178 (error 'sql-database-error
180 :message "can't handle NULLS-OK without ERRHP"))
182 (error 'sql-database-error
184 :message "OCI Error (and no ERRHP available to find subcode)"))))
186 ;;; Require an OCI success code.
188 ;;; (The ordinary OCI error reporting mechanisms uses a fair amount of
189 ;;; machinery (environments and other handles). In order to get to
190 ;;; where we can use these mechanisms, we have to be able to allocate
191 ;;; the machinery. The functions for allocating the machinery can
192 ;;; return errors (e.g. out of memory) but shouldn't. Wrapping this function
193 ;;; around function calls to such have-to-succeed functions enforces
197 (declare (type fixnum code))
198 (unless (= code +oci-success+)
199 (error 'sql-database-error
200 :message (format nil "unexpected OCI failure, code=~S" code))))
203 ;;; Enabling this can be handy for low-level debugging.
206 (trace #-oci7 oci-env-create oci-initialize oci-handle-alloc oci-logon
207 oci-error-get oci-stmt-prepare oci-stmt-execute
208 oci-param-get oci-logon oci-attr-get oci-define-by-pos oci-stmt-fetch)
209 (setf debug::*debug-print-length* nil))
212 ;; Return the INDEXth string of the OCI array, represented as Lisp
213 ;; SIMPLE-STRING. SIZE is the size of the fixed-width fields used by
214 ;; Oracle to store strings within the array.
216 (uffi:def-type string-pointer (* :unsigned-char))
218 (defun deref-oci-string (arrayptr string-index size)
219 (declare (type string-pointer arrayptr))
220 (declare (type (mod #.+n-buf-rows+) string-index))
221 (declare (type (and unsigned-byte fixnum) size))
222 (let ((str (uffi:convert-from-foreign-string
224 (+ (uffi:pointer-address arrayptr) (* string-index size))
226 (if (string-equal str "NULL") nil str)))
228 ;; the OCI library, part Z: no-longer used logic to convert from
229 ;; Oracle's binary date representation to Common Lisp's native date
233 (defvar +oci-date-bytes+ 7)
235 ;;; Return the INDEXth date in the OCI array, represented as
236 ;;; a Common Lisp "universal time" (i.e. seconds since 1900).
239 (defun deref-oci-date (arrayptr index)
240 (oci-date->universal-time (uffi:pointer-address
241 (uffi:deref-array arrayptr
242 '(:array :unsigned-char)
243 (* index +oci-date-bytes+)))))
245 (defun oci-date->universal-time (oci-date)
246 (declare (type (alien (* :unsigned-char)) oci-date))
247 (flet (;; a character from OCI-DATE, interpreted as an unsigned byte
249 (declare (type (mod #.+oci-date-bytes+) i))
250 (mod (uffi:deref-array oci-date string-array i) 256)))
251 (let* ((century (* (- (ub 0) 100) 100))
252 (year (+ century (- (ub 1) 100)))
257 (second (1- (ub 6))))
258 (encode-universal-time second minute hour day month year))))
261 (defmethod database-list-tables ((database oracle-database) &key owner)
264 "select table_name from user_tables")
266 "select table_name from all_tables")
269 "select user_tables.table_name from user_tables,all_tables where user_tables.table_name=all_tables.table_name and all_tables.owner='~:@(~A~)'"
271 (mapcar #'car (database-query query database nil nil))))
274 (defmethod database-list-views ((database oracle-database) &key owner)
277 "select view_name from user_views")
279 "select view_name from all_views")
282 "select user_views.view_name from user_views,all_views where user_views.view_name=all_views.view_name and all_views.owner='~:@(~A~)'"
285 (database-query query database nil nil))))
287 (defmethod database-list-indexes ((database oracle-database)
291 "select index_name from user_indexes")
293 "select index_name from all_indexes")
295 "select user_indexes.index_name from user_indexes,all_indexes where user_indexes.index_name=all_indexes.index_name and all_indexes.owner='~:@(~A~)'"
297 (mapcar #'car (database-query query database nil nil))))
299 (defmethod database-list-table-indexes (table (database oracle-database)
303 (format nil "select index_name from user_indexes where table_name='~A'"
306 (format nil "select index_name from all_indexes where table_name='~A'"
310 "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~)'"
312 (mapcar #'car (database-query query database nil nil))))
315 (defmethod database-list-attributes (table (database oracle-database) &key owner)
318 (format nil "select column_name from user_tab_columns where table_name='~A'"
321 (format nil "select column_name from all_tab_columns where table_name='~A'"
325 "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~)'"
327 (mapcar #'car (database-query query database nil nil))))
329 (defmethod database-attribute-type (attribute (table string)
330 (database oracle-database)
335 "select data_type,data_length,data_scale,nullable from user_tab_columns where table_name='~A' and column_name='~A'"
339 "select data_type,data_length,data_scale,nullable from all_tab_columns where table_name='~A' and column_name='~A'"
343 "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~)'"
344 table attribute owner)))))
345 (destructuring-bind (type length scale nullable) (car (database-query query database :auto nil))
346 (values (ensure-keyword type) length scale
347 (if (char-equal #\Y (schar nullable 0)) 1 0)))))
349 ;; Return one row of the table referred to by QC, represented as a
350 ;; list; or if there are no more rows, signal an error if EOF-ERRORP,
351 ;; or return EOF-VALUE otherwise.
353 ;; KLUDGE: This CASE statement is a strong sign that the code would be
354 ;; cleaner if CD were made into an abstract class, we made variant
355 ;; classes for CD-for-column-of-strings, CD-for-column-of-floats,
356 ;; etc., and defined virtual functions to handle operations like
357 ;; get-an-element-from-column. (For a small special purpose module
358 ;; like this, would arguably be overkill, so I'm not going to do it
359 ;; now, but if this code ends up getting more complicated in
360 ;; maintenance, it would become a really good idea.)
362 ;; Arguably this would be a good place to signal END-OF-FILE, but
363 ;; since the ANSI spec specifically says that END-OF-FILE means a
364 ;; STREAM which has no more data, and QC is not a STREAM, we signal
365 ;; DBI-ERROR instead.
367 (uffi:def-type short-array (:array :short nil))
368 (uffi:def-type int-array (:array :int nil))
369 (uffi:def-type double-array (:array :double nil))
370 (uffi:def-type int-pointer (* :int))
371 (uffi:def-type double-pointer (* :double))
373 ;;; the result of a database query: a cursor through a table
374 (defstruct (oracle-result-set (:print-function print-query-cursor)
376 (:constructor %make-query-cursor))
377 (db (error "missing DB") ; db conn. this table is associated with
378 :type oracle-database
380 (stmthp (error "missing STMTHP") ; the statement handle used to create
381 ;; :type alien ; this table. owned by the QUERY-CURSOR
382 :read-only t) ; object, deallocated on CLOSE-QUERY
383 (cds) ; (error "missing CDS") ; column descriptors
384 ; :type (simple-array cd 1)
387 0 ; buffered rows: number of rows recv'd
388 :type (integer 0 #.+n-buf-rows+)) ; from the database on the last read
390 0 ; number of buffered rows returned, i.e.
391 :type (integer 0 #.+n-buf-rows+)) ; the index, within the buffered rows,
392 ; of the next row which hasn't already
395 0 ; total number of bytes recv'd from OCI
396 :type unsigned-byte) ; in all reads
397 (oci-end-seen-p nil)) ; Have we seen the end of OCI
398 ; data, i.e. OCI returning
399 ; less data than we requested?
400 ; OCI doesn't seem to like us
401 ; to try to read more data
402 ; from it after that..
405 (defun fetch-row (qc &optional (eof-errorp t) eof-value)
406 (declare (optimize (speed 3)))
407 (cond ((zerop (qc-n-from-oci qc))
409 (error 'sql-database-error :message
410 (format nil "no more rows available in ~S" qc))
412 ((>= (qc-n-to-dbi qc)
414 (refill-qc-buffers qc)
415 (fetch-row qc nil eof-value))
417 (let ((cds (qc-cds qc))
418 (reversed-result nil)
419 (irow (qc-n-to-dbi qc)))
420 (dotimes (icd (length cds))
421 (let* ((cd (aref cds icd))
422 (b (foreign-resource-buffer (cd-buffer cd)))
424 (let* ((arb (foreign-resource-buffer (cd-indicators cd)))
425 (indicator (uffi:deref-array arb '(:array :short) irow)))
426 (declare (type short-array arb))
427 (unless (= indicator -1)
428 (ecase (cd-oci-data-type cd)
430 (deref-oci-string b irow (cd-sizeof cd)))
433 (declare (type double-array b))
434 (uffi:deref-array b '(:array :double) irow)))
436 (ecase (cd-sizeof cd)
439 (declare (type int-array b))
440 (uffi:deref-array b '(:array :int) irow)))))
442 (deref-oci-string b irow (cd-sizeof cd))))))))
443 (when (and (eq :string (cd-result-type cd))
445 (not (stringp value)))
446 (setq value (write-to-string value)))
447 (push value reversed-result)))
448 (incf (qc-n-to-dbi qc))
449 (nreverse reversed-result)))))
451 (defun refill-qc-buffers (qc)
452 (with-slots (errhp) (qc-db qc)
453 (setf (qc-n-to-dbi qc) 0)
454 (cond ((qc-oci-end-seen-p qc)
455 (setf (qc-n-from-oci qc) 0))
457 (let ((oci-code (%oci-stmt-fetch
458 (deref-vp (qc-stmthp qc))
461 +oci-fetch-next+ +oci-default+)))
463 (#.+oci-success+ (values))
464 (#.+oci-no-data+ (setf (qc-oci-end-seen-p qc) t)
466 (#.+oci-error+ (handle-oci-error :database (qc-db qc)
468 (uffi:with-foreign-object (rowcount 'ub4)
469 (oci-attr-get (deref-vp (qc-stmthp qc))
472 +unsigned-int-null-pointer+
475 (setf (qc-n-from-oci qc)
476 (- (uffi:deref-pointer rowcount 'ub4)
477 (qc-total-n-from-oci qc)))
478 (when (< (qc-n-from-oci qc) +n-buf-rows+)
479 (setf (qc-oci-end-seen-p qc) t))
480 (setf (qc-total-n-from-oci qc)
481 (uffi:deref-pointer rowcount 'ub4)))))
484 ;; the guts of the SQL function
486 ;; (like the SQL function, but with the QUERY argument hardwired to T, so
487 ;; that the return value is always a cursor instead of a list)
489 ;; Is this a SELECT statement? SELECT statements are handled
490 ;; specially by OCIStmtExecute(). (Non-SELECT statements absolutely
491 ;; require a nonzero iteration count, while the ordinary choice for a
492 ;; SELECT statement is a zero iteration count.
494 ;; SELECT statements are the only statements which return tables. We
495 ;; don't free STMTHP in this case, but instead give it to the new
496 ;; QUERY-CURSOR, and the new QUERY-CURSOR becomes responsible for
497 ;; freeing the STMTHP when it is no longer needed.
499 (defun sql-stmt-exec (sql-stmt-string db result-types field-names)
500 (with-slots (envhp svchp errhp) db
501 (let ((stmthp (uffi:allocate-foreign-object :pointer-void))
504 (uffi:with-foreign-object (stmttype :unsigned-short)
507 (oci-handle-alloc (deref-vp envhp)
509 +oci-htype-stmt+ 0 +null-void-pointer-pointer+)
510 (oci-stmt-prepare (deref-vp stmthp)
512 (uffi:convert-to-cstring sql-stmt-string)
513 (length sql-stmt-string)
514 +oci-ntv-syntax+ +oci-default+ :database db)
515 (oci-attr-get (deref-vp stmthp)
518 +unsigned-int-null-pointer+
523 (setq select-p (= (uffi:deref-pointer stmttype :unsigned-short) 1))
524 (let ((iters (if select-p 0 1)))
526 (oci-stmt-execute (deref-vp svchp)
529 iters 0 +null-void-pointer+ +null-void-pointer+ +oci-default+
531 ;; free resources unless a query
533 (oci-handle-free (deref-vp stmthp) +oci-htype-stmt+)
534 (uffi:free-foreign-object stmthp))))
538 (make-query-cursor db stmthp result-types field-names))
543 ;; Return a QUERY-CURSOR representing the table returned from the OCI
544 ;; operation done through STMTHP. TYPES is the argument of the same
545 ;; name from the external SQL function, controlling type conversion
546 ;; of the returned arguments.
548 (defun make-query-cursor (db stmthp result-types field-names)
549 (let ((qc (%make-query-cursor :db db
551 :cds (make-query-cursor-cds db stmthp
554 (refill-qc-buffers qc)
558 ;; the hairy part of MAKE-QUERY-CURSOR: Ask OCI for information
559 ;; about table columns, translate the information into a Lisp
560 ;; vector of column descriptors, and return it.
562 ;; Allegro defines several flavors of type conversion, but this
563 ;; implementation only supports the :AUTO flavor.
565 ;; A note of explanation: OCI's internal number format uses 21
566 ;; bytes (42 decimal digits). 2 separate (?) one-byte fields,
567 ;; scale and precision, are used to deduce the nature of these
568 ;; 21 bytes. See pp. 3-10, 3-26, and 6-13 of OCI documentation
571 ;; Mac OS X Note: According to table 6-8 in the Oracle 9i OCI
572 ;; documentation, PRECISION may actually be an sb2 instead of a
573 ;; single byte if performing an "implicit describe". Using a
574 ;; signed short instead of an unsigned byte fixes a Mac OS X bug
575 ;; where PRECISION is always zero. -- JJB 20040713
577 ;; When calling OCI C code to handle the conversion, we have
578 ;; only two numeric types available to pass the return value:
579 ;; double-float and signed-long. It would be possible to
580 ;; bypass the OCI conversion functions and write Lisp code
581 ;; which reads the 21-byte field directly and decodes
582 ;; it. However this is left as an exercise for the reader. :-)
584 ;; The following table describes the mapping, based on the implicit
585 ;; assumption that C's "signed long" type is a 32-bit integer.
587 ;; Internal Values SQL Type C Return Type
588 ;; =============== ======== =============
589 ;; Precision > 0 SCALE = -127 FLOAT --> double-float
590 ;; Precision > 0 && <=9 SCALE = 0 INTEGER --> signed-long
591 ;; Precision = 0 || > 9 SCALE = 0 BIG INTEGER --> double-float
592 ;; Precision > 0 SCALE > 0 DECIMAL --> double-float
594 ;; (OCI uses 1-based indexing here.)
596 ;; KLUDGE: This should work for all other data types except those
597 ;; which don't actually fit in their fixed-width field (BLOBs and the
598 ;; like). As Winton says, we (Cadabra) don't need to worry much about
599 ;; those, since we can't reason with them, so we don't use them. But
600 ;; for a more general application it'd be good to have a more
601 ;; selective and rigorously correct test here for whether we can
602 ;; actually handle the given DEREF-DTYPE value. -- WHN 20000106
604 ;; Note: The OCI documentation doesn't seem to say whether the COLNAME
605 ;; value returned here is a newly-allocated copy which we're
606 ;; responsible for freeing, or a pointer into some system copy which
607 ;; will be freed when the system itself is shut down. But judging
608 ;; from the way that the result is used in the cdemodsa.c example
609 ;; program, it looks like the latter: we should make our own copy of
610 ;; the value, but not try to free it.
612 ;; WORKAROUND: OCI seems to return ub2 values for the
613 ;; +oci-attr-data-size+ attribute even though its documentation claims
614 ;; that it returns a ub4, and even though the associated "sizep" value
615 ;; is 4, not 2. In order to make the code here work reliably, without
616 ;; having to patch it later if OCI is ever fixed to match its
617 ;; documentation, we pre-zero COLSIZE before making the call into OCI.
619 ;; To exercise the weird OCI behavior (thereby blowing up the code
620 ;; below, beware!) try setting this value into COLSIZE, calling OCI,
621 ;; then looking at the value in COLSIZE. (setf colsize #x12345678)
624 ;; Mac OS X Note: This workaround fails on a bigendian platform so
625 ;; I've changed the data type of COLNAME to :unsigned-short as per
626 ;; the Oracle 9i OCI documentation. -- JJB 20040713
628 (uffi:def-type byte-pointer (* :byte))
629 (uffi:def-type void-pointer-pointer (* :void-pointer))
631 (defun make-query-cursor-cds (database stmthp result-types field-names)
632 (declare (optimize (safety 3) #+nil (speed 3))
633 (type oracle-database database)
634 (type pointer-pointer-void stmthp))
635 (with-slots (errhp) database
636 (uffi:with-foreign-objects ((dtype-foreign :unsigned-short)
637 (parmdp :pointer-void)
640 (colname '(* :unsigned-char))
644 (defnp ':pointer-void))
647 (do ((icolumn 0 (1+ icolumn))
648 (cds-as-reversed-list nil))
649 ((not (eql (oci-param-get (deref-vp stmthp)
653 (1+ icolumn) :database database)
655 (coerce (reverse cds-as-reversed-list) 'simple-vector))
656 ;; Decode type of ICOLUMNth column into a type we're prepared to
658 (oci-attr-get (deref-vp parmdp)
661 +unsigned-int-null-pointer+
664 (let ((dtype (uffi:deref-pointer dtype-foreign :unsigned-short)))
665 (declare (fixnum dtype))
668 (setf buffer (acquire-foreign-resource :unsigned-char
669 (* 32 +n-buf-rows+)))
670 (setf sizeof 32 dtype #.SQLT-STR))
672 (oci-attr-get (deref-vp parmdp)
675 +unsigned-int-null-pointer+
678 (oci-attr-get (deref-vp parmdp)
681 +unsigned-int-null-pointer+
684 (let ((*scale (uffi:deref-pointer scale :byte))
685 (*precision (uffi:deref-pointer precision :short)))
687 ;;(format t "scale=~d, precision=~d~%" *scale *precision)
689 ((or (and (minusp *scale) (zerop *precision))
690 (and (zerop *scale) (plusp *precision)))
691 (setf buffer (acquire-foreign-resource :int +n-buf-rows+)
692 sizeof 4 ;; sizeof(int)
695 (setf buffer (acquire-foreign-resource :double +n-buf-rows+)
696 sizeof 8 ;; sizeof(double)
697 dtype #.SQLT-FLT)))))
698 ;; Default to SQL-STR
700 (setf (uffi:deref-pointer colsize :unsigned-short) 0)
701 (setf dtype #.SQLT-STR)
702 (oci-attr-get (deref-vp parmdp)
705 +unsigned-int-null-pointer+
708 (let ((colsize-including-null (1+ (uffi:deref-pointer colsize :unsigned-short))))
709 (setf buffer (acquire-foreign-resource
710 :unsigned-char (* +n-buf-rows+ colsize-including-null)))
711 (setf sizeof colsize-including-null))))
712 (let ((retcodes (acquire-foreign-resource :unsigned-short +n-buf-rows+))
713 (indicators (acquire-foreign-resource :short +n-buf-rows+))
716 (oci-attr-get (deref-vp parmdp)
722 (setq colname-string (uffi:convert-from-foreign-string
723 (uffi:deref-pointer colname '(* :unsigned-char))
724 :length (uffi:deref-pointer colnamelen 'ub4))))
725 (push (make-cd :name colname-string
730 :indicators indicators
732 ((consp result-types)
733 (nth icolumn result-types))
738 cds-as-reversed-list)
739 (oci-define-by-pos (deref-vp stmthp)
742 (1+ icolumn) ; OCI 1-based indexing again
743 (foreign-resource-buffer buffer)
746 (foreign-resource-buffer indicators)
747 +unsigned-short-null-pointer+
748 (foreign-resource-buffer retcodes)
749 +oci-default+))))))))
751 ;; Release the resources associated with a QUERY-CURSOR.
753 (defun close-query (qc)
754 (oci-handle-free (deref-vp (qc-stmthp qc)) +oci-htype-stmt+)
755 (uffi:free-foreign-object (qc-stmthp qc))
756 (let ((cds (qc-cds qc)))
757 (dotimes (i (length cds))
758 (release-cd-resources (aref cds i))))
762 ;; Release the resources associated with a column description.
764 (defun release-cd-resources (cd)
765 (free-foreign-resource (cd-buffer cd))
766 (free-foreign-resource (cd-retcodes cd))
767 (free-foreign-resource (cd-indicators cd))
771 (defmethod database-name-from-spec (connection-spec (database-type (eql :oracle)))
772 (check-connection-spec connection-spec database-type (dsn user password))
773 (destructuring-bind (dsn user password) connection-spec
774 (declare (ignore password))
775 (concatenate 'string dsn "/" user)))
778 (defmethod database-connect (connection-spec (database-type (eql :oracle)))
779 (check-connection-spec connection-spec database-type (dsn user password))
780 (destructuring-bind (data-source-name user password)
782 (let ((envhp (uffi:allocate-foreign-object :pointer-void))
783 (errhp (uffi:allocate-foreign-object :pointer-void))
784 (svchp (uffi:allocate-foreign-object :pointer-void))
785 (srvhp (uffi:allocate-foreign-object :pointer-void)))
786 ;; Requests to allocate environments and handles should never
787 ;; fail in normal operation, and they're done too early to
788 ;; handle errors very gracefully (since they're part of the
789 ;; error-handling mechanism themselves) so we just assert they
792 (setf (deref-vp envhp) +null-void-pointer+)
795 (oci-env-create envhp +oci-default+ +null-void-pointer+
796 +null-void-pointer+ +null-void-pointer+
797 +null-void-pointer+ 0 +null-void-pointer-pointer+)
800 (oci-initialize +oci-object+ +null-void-pointer+ +null-void-pointer+
801 +null-void-pointer+ +null-void-pointer-pointer+)
802 (ignore-errors (oci-handle-alloc +null-void-pointer+ envhp
804 +null-void-pointer-pointer+)) ;no testing return
805 (oci-env-init envhp +oci-default+ 0 +null-void-pointer-pointer+))
806 (oci-handle-alloc (deref-vp envhp) errhp
807 +oci-htype-error+ 0 +null-void-pointer-pointer+)
808 (oci-handle-alloc (deref-vp envhp) srvhp
809 +oci-htype-server+ 0 +null-void-pointer-pointer+)
811 #+ignore ;; not used since CLSQL uses the OCILogon function instead
812 (uffi:with-cstring (dblink nil)
813 (oci-server-attach (deref-vp srvhp)
818 (oci-handle-alloc (deref-vp envhp) svchp
819 +oci-htype-svcctx+ 0 +null-void-pointer-pointer+)
820 (oci-attr-set (deref-vp svchp)
822 (deref-vp srvhp) 0 +oci-attr-server+
824 ;; oci-handle-alloc((dvoid *)encvhp, (dvoid **)&stmthp, OCI_HTYPE_STMT, 0, 0);
827 (let ((db (make-instance 'oracle-database
828 :name (database-name-from-spec connection-spec
830 :connection-spec connection-spec
833 :database-type :oracle
835 :dsn data-source-name
837 (oci-logon (deref-vp envhp)
840 (uffi:convert-to-cstring user) (length user)
841 (uffi:convert-to-cstring password) (length password)
842 (uffi:convert-to-cstring data-source-name) (length data-source-name)
844 ;; :date-format-length (1+ (length date-format)))))
845 (setf (slot-value db 'clsql-sys::state) :open)
846 (database-execute-command
847 (format nil "ALTER SESSION SET NLS_DATE_FORMAT='~A'" (date-format db)) db)
848 (let ((server-version
849 (caar (database-query
850 "SELECT BANNER FROM V$VERSION WHERE BANNER LIKE '%Oracle%'" db nil nil))))
851 (setf (slot-value db 'server-version) server-version
852 (slot-value db 'major-server-version) (major-client-version-from-string
857 (defun major-client-version-from-string (str)
859 ((search " 10g " str)
861 ((search "Oracle9i " str)
863 ((search "Oracle8" str)
866 (defun major-server-version-from-string (str)
867 (when (> (length str) 2)
869 ((string= "10." (subseq str 0 3))
871 ((string= "9." (subseq str 0 2))
873 ((string= "8." (subseq str 0 2))
877 ;; Close a database connection.
879 (defmethod database-disconnect ((database oracle-database))
880 (osucc (oci-logoff (deref-vp (svchp database))
881 (deref-vp (errhp database))))
882 (osucc (oci-handle-free (deref-vp (envhp database)) +oci-htype-env+))
883 ;; Note: It's neither required nor allowed to explicitly deallocate the
884 ;; ERRHP handle here, since it's owned by the ENVHP deallocated above,
885 ;; and was therefore automatically deallocated at the same time.
888 ;;; Do the database operation described in SQL-STMT-STRING on database
889 ;;; DB and, if the command is a SELECT, return a representation of the
890 ;;; resulting table. The representation of the table is controlled by the
892 ;;; * If QUERY is NIL, the table is returned as a list of rows, with
893 ;;; each row represented by a list.
894 ;;; * If QUERY is non-NIL, the result is returned as a QUERY-CURSOR
895 ;;; suitable for FETCH-ROW and CLOSE-QUERY
896 ;;; The TYPES argument controls the type conversion method used
897 ;;; to construct the table. The Allegro version supports several possible
898 ;;; values for this argument, but we only support :AUTO.
900 (defmethod database-query (query-expression (database oracle-database) result-types field-names)
901 (let ((cursor (sql-stmt-exec query-expression database result-types field-names)))
902 ;; (declare (type (or query-cursor null) cursor))
903 (if (null cursor) ; No table was returned.
905 (do ((reversed-result nil))
907 (let* ((eof-value :eof)
908 (row (fetch-row cursor nil eof-value)))
909 (when (eq row eof-value)
912 (return (values (nreverse reversed-result)
913 (loop for cd across (qc-cds cursor)
914 collect (cd-name cd))))
915 (return (nreverse reversed-result))))
916 (push row reversed-result))))))
919 (defmethod database-create-sequence (sequence-name (database oracle-database))
921 (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
924 (defmethod database-drop-sequence (sequence-name (database oracle-database))
926 (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name))
929 (defmethod database-sequence-next (sequence-name (database oracle-database))
930 (caar (database-query
931 (concatenate 'string "SELECT "
932 (sql-escape sequence-name)
933 ".NEXTVAL FROM dual")
934 database :auto nil)))
936 (defmethod database-sequence-last (sequence-name (database oracle-database))
937 (caar (database-query
938 (concatenate 'string "SELECT "
939 (sql-escape sequence-name)
940 ".CURRVAL FROM dual")
941 database :auto nil)))
943 (defmethod database-set-sequence-position (name position (database oracle-database))
945 (let* ((next (database-sequence-next name database))
946 (incr (- position next)))
948 (database-execute-command
949 (format nil "ALTER SEQUENCE ~A INCREMENT BY ~D" name incr)
951 (database-sequence-next name database)
952 (database-execute-command
953 (format nil "ALTER SEQUENCE ~A INCREMENT BY 1" name)
956 (defmethod database-list-sequences ((database oracle-database) &key owner)
959 "select sequence_name from user_sequences")
961 "select sequence_name from all_sequences")
964 "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~)'"
966 (mapcar #'car (database-query query database nil nil))))
968 (defmethod database-execute-command (sql-expression (database oracle-database))
969 (database-query sql-expression database nil nil)
970 (when (database-autocommit database)
971 (oracle-commit database))
975 (defstruct (cd (:constructor make-cd)
976 (:print-function print-cd))
977 "a column descriptor: metadata about the data in a table"
979 ;; name of this column
980 (name (error "missing NAME") :type simple-string :read-only t)
981 ;; the size in bytes of a single element
982 (sizeof (error "missing SIZE") :type fixnum :read-only t)
983 ;; an array of +N-BUF-ROWS+ elements in C representation
984 (buffer (error "Missing BUFFER")
985 :type foreign-resource
987 ;; an array of +N-BUF-ROWS+ OCI return codes in C representation.
988 ;; (There must be one return code for every element of every
989 ;; row in order to be able to represent nullness.)
990 (retcodes (error "Missing RETCODES")
991 :type foreign-resource
993 (indicators (error "Missing INDICATORS")
994 :type foreign-resource
996 ;; the OCI code for the data type of a single element
997 (oci-data-type (error "missing OCI-DATA-TYPE")
1000 (result-type (error "missing RESULT-TYPE")
1004 (defun print-cd (cd stream depth)
1005 (declare (ignore depth))
1006 (print-unreadable-object (cd stream :type t)
1008 ":NAME ~S :OCI-DATA-TYPE ~S :OCI-DATA-SIZE ~S"
1010 (cd-oci-data-type cd)
1013 (defun print-query-cursor (qc stream depth)
1014 (declare (ignore depth))
1015 (print-unreadable-object (qc stream :type t :identity t)
1016 (prin1 (qc-db qc) stream)))
1019 (defmethod database-query-result-set ((query-expression string)
1020 (database oracle-database)
1021 &key full-set result-types)
1022 (let ((cursor (sql-stmt-exec query-expression database result-types nil)))
1024 (values cursor (length (qc-cds cursor)) nil)
1025 (values cursor (length (qc-cds cursor))))))
1028 (defmethod database-dump-result-set (result-set (database oracle-database))
1029 (close-query result-set))
1031 (defmethod database-store-next-row (result-set (database oracle-database) list)
1032 (let* ((eof-value :eof)
1033 (row (fetch-row result-set nil eof-value)))
1034 (unless (eq eof-value row)
1035 (loop for i from 0 below (length row)
1036 do (setf (nth i list) (nth i row)))
1039 (defmethod database-start-transaction ((database oracle-database))
1041 ;; Not needed with simple transaction
1043 (with-slots (svchp errhp) database
1044 (oci-trans-start (deref-vp svchp)
1051 (defun oracle-commit (database)
1052 (with-slots (svchp errhp) database
1053 (osucc (oci-trans-commit (deref-vp svchp)
1057 (defmethod database-commit-transaction ((database oracle-database))
1059 (oracle-commit database)
1062 (defmethod database-abort-transaction ((database oracle-database))
1064 (osucc (oci-trans-rollback (deref-vp (svchp database))
1065 (deref-vp (errhp database))
1071 (defmethod db-type-has-bigint? ((type (eql :oracle)))
1074 (defmethod db-type-has-fancy-math? ((db-type (eql :oracle)))
1077 (defmethod db-type-has-boolean-where? ((db-type (eql :oracle)))
1080 (when (clsql-sys:database-type-library-loaded :oracle)
1081 (clsql-sys:initialize-database-type :database-type :oracle))